src/udev.h

   1 /*
   2  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
   3  * Copyright (C) 2003-2010 Kay Sievers <kay.sievers@vrfy.org>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef _UDEV_H_
  20 #define _UDEV_H_
  21
  22 #include <sys/types.h>
  23 #include <sys/param.h>
  24 #include <signal.h>
  25
  26 #include "libudev.h"
  27 #include "libudev-private.h"
  28
  29 struct udev_event {
  30         struct udev *udev;
  31         struct udev_device *dev;
  32         struct udev_device *dev_parent;
  33         struct udev_device *dev_db;
  34         char *name;
  35         char *program_result;
  36         mode_t mode;
  37         uid_t uid;
  38         gid_t gid;
  39         struct udev_list run_list;
  40         int exec_delay;
  41         unsigned long long birth_usec;
  42         unsigned long long timeout_usec;
  43         int fd_signal;
  44         unsigned int builtin_run;
  45         unsigned int builtin_ret;
  46         bool sigterm;
  47         bool inotify_watch;
  48         bool inotify_watch_final;
  49         bool group_final;
  50         bool owner_final;
  51         bool mode_set;
  52         bool mode_final;
  53         bool name_final;
  54         bool devlink_final;
  55         bool run_final;
  56 };
  57
  58 struct udev_watch {
  59         struct udev_list_node node;
  60         int handle;
  61         char *name;
  62 };
  63
  64 /* udev-rules.c */
  65 struct udev_rules;
  66 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names);
  67 struct udev_rules *udev_rules_unref(struct udev_rules *rules);
  68 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event, const sigset_t *sigmask);
  69 void udev_rules_apply_static_dev_perms(struct udev_rules *rules);
  70
  71 /* udev-event.c */
  72 struct udev_event *udev_event_new(struct udev_device *dev);
  73 void udev_event_unref(struct udev_event *event);
  74 size_t udev_event_apply_format(struct udev_event *event, const char *src, char *dest, size_t size);
  75 int udev_event_apply_subsys_kernel(struct udev_event *event, const char *string,
  76                                    char *result, size_t maxsize, int read_value);
  77 int udev_event_spawn(struct udev_event *event,
  78                      const char *cmd, char **envp, const sigset_t *sigmask,
  79                      char *result, size_t ressize);
  80 int udev_event_execute_rules(struct udev_event *event, struct udev_rules *rules, const sigset_t *sigset);
  81 int udev_event_execute_run(struct udev_event *event, const sigset_t *sigset);
  82 int udev_build_argv(struct udev *udev, char *cmd, int *argc, char *argv[]);
  83
  84 /* udev-watch.c */
  85 int udev_watch_init(struct udev *udev);
  86 void udev_watch_restore(struct udev *udev);
  87 void udev_watch_begin(struct udev *udev, struct udev_device *dev);
  88 void udev_watch_end(struct udev *udev, struct udev_device *dev);
  89 struct udev_device *udev_watch_lookup(struct udev *udev, int wd);
  90
  91 /* udev-node.c */
  92 int udev_node_add(struct udev_device *dev, mode_t mode, uid_t uid, gid_t gid);
  93 int udev_node_remove(struct udev_device *dev);
  94 void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old);
  95
  96 /* udev-ctrl.c */
  97 struct udev_ctrl;
  98 struct udev_ctrl *udev_ctrl_new(struct udev *udev);
  99 struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd);
 100 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
 101 struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
 102 struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl);
 103 int udev_ctrl_cleanup(struct udev_ctrl *uctrl);
 104 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
 105 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
 106 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout);
 107 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout);
 108 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout);
 109 int udev_ctrl_send_reload(struct udev_ctrl *uctrl, int timeout);
 110 int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout);
 111 int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout);
 112 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout);
 113 int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout);
 114 struct udev_ctrl_connection;
 115 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl);
 116 struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn);
 117 struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn);
 118 struct udev_ctrl_msg;
 119 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn);
 120 struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 121 struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 122 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 123 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 124 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 125 int udev_ctrl_get_reload(struct udev_ctrl_msg *ctrl_msg);
 126 int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg);
 127 int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg);
 128 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 129 int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg);
 130
 131 /* built-in commands */
 132 enum udev_builtin_cmd {
 133         UDEV_BUILTIN_BLKID,
 134         UDEV_BUILTIN_FIRMWARE,
 135         UDEV_BUILTIN_INPUT_ID,
 136         UDEV_BUILTIN_KMOD,
 137         UDEV_BUILTIN_PATH_ID,
 138         UDEV_BUILTIN_PCI_DB,
 139         UDEV_BUILTIN_USB_DB,
 140         UDEV_BUILTIN_USB_ID,
 141         UDEV_BUILTIN_MAX
 142 };
 143 struct udev_builtin {
 144         const char *name;
 145         int (*cmd)(struct udev_device *dev, int argc, char *argv[], bool test);
 146         const char *help;
 147         int (*init)(struct udev *udev);
 148         void (*exit)(struct udev *udev);
 149         bool (*validate)(struct udev *udev);
 150         bool run_once;
 151 };
 152 extern const struct udev_builtin udev_builtin_blkid;
 153 extern const struct udev_builtin udev_builtin_firmware;
 154 extern const struct udev_builtin udev_builtin_input_id;
 155 extern const struct udev_builtin udev_builtin_kmod;
 156 extern const struct udev_builtin udev_builtin_path_id;
 157 extern const struct udev_builtin udev_builtin_pci_db;
 158 extern const struct udev_builtin udev_builtin_usb_db;
 159 extern const struct udev_builtin udev_builtin_usb_id;
 160 int udev_builtin_init(struct udev *udev);
 161 void udev_builtin_exit(struct udev *udev);
 162 enum udev_builtin_cmd udev_builtin_lookup(const char *command);
 163 const char *udev_builtin_name(enum udev_builtin_cmd cmd);
 164 bool udev_builtin_run_once(enum udev_builtin_cmd cmd);
 165 int udev_builtin_run(struct udev_device *dev, enum udev_builtin_cmd cmd, const char *command, bool test);
 166 void udev_builtin_list(struct udev *udev);
 167 int udev_builtin_add_property(struct udev_device *dev, bool test, const char *key, const char *val);
 168
 169 /* udev logging */
 170 void udev_main_log(struct udev *udev, int priority,
 171                    const char *file, int line, const char *fn,
 172                    const char *format, va_list args);
 173
 174 /* udevadm commands */
 175 struct udevadm_cmd {
 176         const char *name;
 177         int (*cmd)(struct udev *udev, int argc, char *argv[]);
 178         const char *help;
 179         int debug;
 180 };
 181 extern const struct udevadm_cmd udevadm_info;
 182 extern const struct udevadm_cmd udevadm_trigger;
 183 extern const struct udevadm_cmd udevadm_settle;
 184 extern const struct udevadm_cmd udevadm_control;
 185 extern const struct udevadm_cmd udevadm_monitor;
 186 extern const struct udevadm_cmd udevadm_test;
 187 extern const struct udevadm_cmd udevadm_test_builtin;
 188 #endif