chiark / gitweb /
add builtin load/unload initializers
[elogind.git] / udev / udev.h
index 700c8c09d8fe1d153df2f865eed2fb34d156f8b9..a07c525a89431ec7f12a57273e8023218014b462 100644 (file)
 /*
  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
- * Copyright (C) 2003-2008 Kay Sievers <kay.sievers@vrfy.org>
+ * Copyright (C) 2003-2010 Kay Sievers <kay.sievers@vrfy.org>
  *
- *     This program is free software; you can redistribute it and/or modify it
- *     under the terms of the GNU General Public License as published by the
- *     Free Software Foundation version 2 of the License.
- * 
- *     This program is distributed in the hope that it will be useful, but
- *     WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- *     General Public License for more details.
- * 
- *     You should have received a copy of the GNU General Public License along
- *     with this program; if not, write to the Free Software Foundation, Inc.,
- *     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
  *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef _UDEV_H_
 #define _UDEV_H_
 
-#include "config.h"
-
 #include <sys/types.h>
 #include <sys/param.h>
+#include <signal.h>
 
-#include "list.h"
-#include "udev_sysdeps.h"
-#define LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE 1
-#include "lib/libudev.h"
-#include "lib/libudev-private.h"
-
-#define COMMENT_CHARACTER                      '#'
-#define LINE_SIZE                              512
-#define PATH_SIZE                              512
-#define NAME_SIZE                              256
-#define VALUE_SIZE                             128
-
-#define ALLOWED_CHARS                          "#+-.:=@_"
-#define ALLOWED_CHARS_FILE                     ALLOWED_CHARS "/"
-#define ALLOWED_CHARS_INPUT                    ALLOWED_CHARS_FILE " $%?,"
-
-#define DEFAULT_PARTITIONS_COUNT               15
-#define UDEV_EVENT_TIMEOUT                     180
-
-/* linux/include/linux/kobject.h */
-#define UEVENT_BUFFER_SIZE                     2048
-#define UEVENT_NUM_ENVP                                32
-
-#define UDEV_CTRL_SOCK_PATH                    "@" UDEV_PREFIX "/org/kernel/udev/udevd"
-
-#define UDEV_MAX(a,b) ((a) > (b) ? (a) : (b))
+#include "libudev.h"
+#include "libudev-private.h"
 
-/* pipes */
-#define READ_END                               0
-#define WRITE_END                              1
-
-struct udev_rules;
-
-struct sysfs_device {
-       struct list_head node;                  /* for device cache */
-       struct sysfs_device *parent;            /* already cached parent*/
-       char devpath[PATH_SIZE];
-       char subsystem[NAME_SIZE];              /* $class, $bus, drivers, module */
-       char kernel[NAME_SIZE];                 /* device instance name */
-       char kernel_number[NAME_SIZE];
-       char driver[NAME_SIZE];                 /* device driver name */
-};
-
-struct udevice {
+struct udev_event {
        struct udev *udev;
-
-       /* device event */
-       struct sysfs_device *dev;               /* points to dev_local by default */
-       struct sysfs_device dev_local;
-       struct sysfs_device *dev_parent;        /* current parent device used for matching */
-       char action[NAME_SIZE];
-       char *devpath_old;
-
-       /* node */
-       char name[PATH_SIZE];
-       struct list_head symlink_list;
-       int symlink_final;
-       char owner[NAME_SIZE];
-       int owner_final;
-       char group[NAME_SIZE];
-       int group_final;
+       struct udev_device *dev;
+       struct udev_device *dev_parent;
+       struct udev_device *dev_db;
+       char *name;
+       char *tmp_node;
+       char *program_result;
        mode_t mode;
-       int mode_final;
-       dev_t devt;
-
-       /* event processing */
-       struct list_head run_list;
-       int run_final;
-       struct list_head env_list;
-       char tmp_node[PATH_SIZE];
-       int partitions;
-       int ignore_device;
-       int ignore_remove;
-       char program_result[PATH_SIZE];
-       int link_priority;
-       int event_timeout;
-       int test_run;
+       uid_t uid;
+       gid_t gid;
+       struct udev_list run_list;
+       int exec_delay;
+       unsigned long long birth_usec;
+       unsigned long long timeout_usec;
+       int fd_signal;
+       unsigned int builtin_run;
+       unsigned int builtin_ret;
+       bool sigterm;
+       bool inotify_watch;
+       bool inotify_watch_final;
+       bool group_final;
+       bool owner_final;
+       bool mode_set;
+       bool mode_final;
+       bool static_node;
+       bool name_final;
+       bool devlink_final;
+       bool run_final;
 };
 
-static inline void logging_init(const char *program_name)
-{
-       openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
-}
-
-static inline void logging_msg(struct udev *udev, int priority,
-                         const char *file, int line, const char *fn,
-                         const char *format, va_list args)
-{
-       vsyslog(priority, format, args);
-}
-
-static inline void logging_close(void)
-{
-       closelog();
-}
-
-/* udev_device.c */
-extern struct udevice *udev_device_init(struct udev *udev);
-extern void udev_device_cleanup(struct udevice *udevice);
-extern dev_t udev_device_get_devt(struct udevice *udevice);
-
-/* udev_device_event.c */
-extern int udev_device_event(struct udev_rules *rules, struct udevice *udevice);
-
-/* udev_sysfs.c */
-extern int sysfs_init(void);
-extern void sysfs_cleanup(void);
-extern void sysfs_device_set_values(struct udev *udev,
-                                   struct sysfs_device *dev, const char *devpath,
-                                   const char *subsystem, const char *driver);
-extern struct sysfs_device *sysfs_device_get(struct udev *udev, const char *devpath);
-extern struct sysfs_device *sysfs_device_get_parent(struct udev *udev, struct sysfs_device *dev);
-extern struct sysfs_device *sysfs_device_get_parent_with_subsystem(struct udev *udev, struct sysfs_device *dev, const char *subsystem);
-extern char *sysfs_attr_get_value(struct udev *udev, const char *devpath, const char *attr_name);
-extern int sysfs_resolve_link(struct udev *udev, char *path, size_t size);
-extern int sysfs_lookup_devpath_by_subsys_id(struct udev *udev, char *devpath, size_t len, const char *subsystem, const char *id);
-
-/* udev_node.c */
-extern int udev_node_mknod(struct udevice *udevice, const char *file, dev_t devt, mode_t mode, uid_t uid, gid_t gid);
-extern void udev_node_update_symlinks(struct udevice *udevice, struct udevice *udev_old);
-extern int udev_node_add(struct udevice *udevice);
-extern int udev_node_remove(struct udevice *udevice);
-
-/* udev_db.c */
-extern int udev_db_add_device(struct udevice *udevice);
-extern int udev_db_delete_device(struct udevice *udevice);
-extern int udev_db_rename(struct udev *udev, const char *devpath_old, const char *devpath);
-extern int udev_db_get_device(struct udevice *udevice, const char *devpath);
-extern int udev_db_get_devices_by_name(struct udev *udev, const char *name, struct list_head *name_list);
-extern int udev_db_get_all_entries(struct udev *udevconst, struct list_head *name_list);
-
-/* udev_utils.c */
-struct name_entry {
-       struct list_head node;
-       char name[PATH_SIZE];
-       unsigned int ignore_error:1;
+struct udev_watch {
+       struct udev_list_node node;
+       int handle;
+       char *name;
 };
 
-extern int log_priority(const char *priority);
-extern struct name_entry *name_list_add(struct udev *udev, struct list_head *name_list, const char *name, int sort);
-extern struct name_entry *name_list_key_add(struct udev *udev, struct list_head *name_list, const char *key, const char *value);
-extern int name_list_key_remove(struct udev *udev, struct list_head *name_list, const char *key);
-extern void name_list_cleanup(struct udev *udev, struct list_head *name_list);
-extern int add_matching_files(struct udev *udev, struct list_head *name_list, const char *dirname, const char *suffix);
-extern uid_t lookup_user(struct udev *udev, const char *user);
-extern gid_t lookup_group(struct udev *udev, const char *group);
-
-/* udev_utils_string.c */
-extern int string_is_true(const char *str);
-extern void remove_trailing_chars(char *path, char c);
-extern size_t path_encode(char *s, size_t len);
-extern size_t path_decode(char *s);
-extern int utf8_encoded_valid_unichar(const char *str);
-extern int replace_chars(char *str, const char *white);
-
-/* udev_utils_file.c */
-extern int create_path(struct udev *udev, const char *path);
-extern int delete_path(struct udev *udev, const char *path);
-extern int unlink_secure(struct udev *udev, const char *filename);
-extern int file_map(const char *filename, char **buf, size_t *bufsize);
-extern void file_unmap(void *buf, size_t bufsize);
-extern size_t buf_get_line(const char *buf, size_t buflen, size_t cur);
+/* udev-rules.c */
+struct udev_rules;
+struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names);
+void udev_rules_unref(struct udev_rules *rules);
+int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event, const sigset_t *sigmask);
+void udev_rules_apply_static_dev_perms(struct udev_rules *rules);
+
+/* udev-event.c */
+struct udev_event *udev_event_new(struct udev_device *dev);
+void udev_event_unref(struct udev_event *event);
+size_t udev_event_apply_format(struct udev_event *event, const char *src, char *dest, size_t size);
+int udev_event_apply_subsys_kernel(struct udev_event *event, const char *string,
+                                  char *result, size_t maxsize, int read_value);
+int udev_event_spawn(struct udev_event *event,
+                    const char *cmd, char **envp, const sigset_t *sigmask,
+                    char *result, size_t ressize);
+int udev_event_execute_rules(struct udev_event *event, struct udev_rules *rules, const sigset_t *sigset);
+int udev_event_execute_run(struct udev_event *event, const sigset_t *sigset);
+
+/* udev-watch.c */
+int udev_watch_init(struct udev *udev);
+void udev_watch_restore(struct udev *udev);
+void udev_watch_begin(struct udev *udev, struct udev_device *dev);
+void udev_watch_end(struct udev *udev, struct udev_device *dev);
+struct udev_device *udev_watch_lookup(struct udev *udev, int wd);
+
+/* udev-node.c */
+int udev_node_mknod(struct udev_device *dev, const char *file, mode_t mode, uid_t uid, gid_t gid);
+int udev_node_add(struct udev_device *dev, mode_t mode, uid_t uid, gid_t gid);
+int udev_node_remove(struct udev_device *dev);
+void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old);
+
+/* udev-ctrl.c */
+struct udev_ctrl;
+struct udev_ctrl *udev_ctrl_new(struct udev *udev);
+struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd);
+int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
+struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
+struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl);
+int udev_ctrl_cleanup(struct udev_ctrl *uctrl);
+struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
+int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
+int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout);
+int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout);
+int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout);
+int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl, int timeout);
+int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout);
+int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout);
+int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout);
+int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout);
+struct udev_ctrl_connection;
+struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl);
+struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn);
+struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn);
+struct udev_ctrl_msg;
+struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn);
+struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
+struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg);
+const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
+int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg);
 
 /* udevadm commands */
-extern int udevadm_monitor(struct udev *udev, int argc, char *argv[]);
-extern int udevadm_info(struct udev *udev, int argc, char *argv[]);
-extern int udevadm_control(struct udev *udev, int argc, char *argv[]);
-extern int udevadm_trigger(struct udev *udev, int argc, char *argv[]);
-extern int udevadm_settle(struct udev *udev, int argc, char *argv[]);
-extern int udevadm_test(struct udev *udev, int argc, char *argv[]);
-
+struct udevadm_cmd {
+       const char *name;
+       int (*cmd)(struct udev *udev, int argc, char *argv[]);
+       const char *help;
+       int debug;
+};
+extern const struct udevadm_cmd udevadm_monitor;
+extern const struct udevadm_cmd udevadm_info;
+extern const struct udevadm_cmd udevadm_control;
+extern const struct udevadm_cmd udevadm_trigger;
+extern const struct udevadm_cmd udevadm_settle;
+extern const struct udevadm_cmd udevadm_test;
+extern const struct udevadm_cmd udevadm_test_builtin;
+
+/* built-in commands */
+enum udev_builtin_cmd {
+       UDEV_BUILTIN_PATH_ID,
+       UDEV_BUILTIN_USB_ID,
+       UDEV_BUILTIN_INPUT_ID,
+       UDEV_BUILTIN_BLKID,
+       UDEV_BUILTIN_KMOD,
+       UDEV_BUILTIN_MAX
+};
+struct udev_builtin {
+       const char *name;
+       int (*cmd)(struct udev_device *dev, const char *command, bool test);
+       const char *help;
+       int (*load)(struct udev *udev);
+       int (*unload)(struct udev *udev);
+       bool run_once;
+};
+extern const struct udev_builtin udev_builtin_path_id;
+extern const struct udev_builtin udev_builtin_usb_id;
+extern const struct udev_builtin udev_builtin_input_id;
+extern const struct udev_builtin udev_builtin_blkid;
+extern const struct udev_builtin udev_builtin_kmod;
+int udev_builtin_load(struct udev *udev);
+int udev_builtin_unload(struct udev *udev);
+enum udev_builtin_cmd udev_builtin_lookup(const char *command);
+const char *udev_builtin_name(enum udev_builtin_cmd cmd);
+bool udev_builtin_run_once(enum udev_builtin_cmd cmd);
+int udev_builtin_run(struct udev_device *dev, enum udev_builtin_cmd cmd, const char *command, bool test);
+int udev_builtin_list(struct udev *udev);
+int udev_builtin_add_property(struct udev_device *dev, bool test, const char *key, const char *val, ...);
 #endif