src/udev/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 #include "util.h"
  29 #include "label.h"
  30 #include "strv.h"
  31
  32 struct udev_event {
  33         struct udev *udev;
  34         struct udev_device *dev;
  35         struct udev_device *dev_parent;
  36         struct udev_device *dev_db;
  37         char *name;
  38         char *program_result;
  39         mode_t mode;
  40         uid_t uid;
  41         gid_t gid;
  42         struct udev_list run_list;
  43         int exec_delay;
  44         unsigned long long birth_usec;
  45         unsigned long long timeout_usec;
  46         int fd_signal;
  47         unsigned int builtin_run;
  48         unsigned int builtin_ret;
  49         bool sigterm;
  50         bool inotify_watch;
  51         bool inotify_watch_final;
  52         bool group_final;
  53         bool owner_final;
  54         bool mode_set;
  55         bool mode_final;
  56         bool name_final;
  57         bool devlink_final;
  58         bool run_final;
  59 };
  60
  61 struct udev_watch {
  62         struct udev_list_node node;
  63         int handle;
  64         char *name;
  65 };
  66
  67 /* udev-rules.c */
  68 struct udev_rules;
  69 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names);
  70 struct udev_rules *udev_rules_unref(struct udev_rules *rules);
  71 bool udev_rules_check_timestamp(struct udev_rules *rules);
  72 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event, const sigset_t *sigmask);
  73 void udev_rules_apply_static_dev_perms(struct udev_rules *rules);
  74
  75 /* udev-event.c */
  76 struct udev_event *udev_event_new(struct udev_device *dev);
  77 void udev_event_unref(struct udev_event *event);
  78 size_t udev_event_apply_format(struct udev_event *event, const char *src, char *dest, size_t size);
  79 int udev_event_apply_subsys_kernel(struct udev_event *event, const char *string,
  80                                    char *result, size_t maxsize, int read_value);
  81 int udev_event_spawn(struct udev_event *event,
  82                      const char *cmd, char **envp, const sigset_t *sigmask,
  83                      char *result, size_t ressize);
  84 int udev_event_execute_rules(struct udev_event *event, struct udev_rules *rules, const sigset_t *sigset);
  85 void udev_event_execute_run(struct udev_event *event, const sigset_t *sigset);
  86 int udev_build_argv(struct udev *udev, char *cmd, int *argc, char *argv[]);
  87
  88 /* udev-watch.c */
  89 int udev_watch_init(struct udev *udev);
  90 void udev_watch_restore(struct udev *udev);
  91 void udev_watch_begin(struct udev *udev, struct udev_device *dev);
  92 void udev_watch_end(struct udev *udev, struct udev_device *dev);
  93 struct udev_device *udev_watch_lookup(struct udev *udev, int wd);
  94
  95 /* udev-node.c */
  96 void udev_node_add(struct udev_device *dev, mode_t mode, uid_t uid, gid_t gid);
  97 void udev_node_remove(struct udev_device *dev);
  98 void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old);
  99
 100 /* udev-ctrl.c */
 101 struct udev_ctrl;
 102 struct udev_ctrl *udev_ctrl_new(struct udev *udev);
 103 struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd);
 104 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
 105 struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
 106 struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl);
 107 int udev_ctrl_cleanup(struct udev_ctrl *uctrl);
 108 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
 109 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
 110 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout);
 111 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout);
 112 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout);
 113 int udev_ctrl_send_reload(struct udev_ctrl *uctrl, int timeout);
 114 int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout);
 115 int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout);
 116 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout);
 117 int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout);
 118 struct udev_ctrl_connection;
 119 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl);
 120 struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn);
 121 struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn);
 122 struct udev_ctrl_msg;
 123 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn);
 124 struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 125 struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 126 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 127 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 128 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 129 int udev_ctrl_get_reload(struct udev_ctrl_msg *ctrl_msg);
 130 int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg);
 131 int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg);
 132 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 133 int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg);
 134
 135 /* built-in commands */
 136 enum udev_builtin_cmd {
 137         UDEV_BUILTIN_BLKID,
 138         UDEV_BUILTIN_BTRFS,
 139         UDEV_BUILTIN_FIRMWARE,
 140         UDEV_BUILTIN_HWDB,
 141         UDEV_BUILTIN_INPUT_ID,
 142         UDEV_BUILTIN_KMOD,
 143         UDEV_BUILTIN_NET_ID,
 144         UDEV_BUILTIN_PATH_ID,
 145         UDEV_BUILTIN_USB_ID,
 146 #ifdef HAVE_ACL
 147         UDEV_BUILTIN_UACCESS,
 148 #endif
 149         UDEV_BUILTIN_MAX
 150 };
 151 struct udev_builtin {
 152         const char *name;
 153         int (*cmd)(struct udev_device *dev, int argc, char *argv[], bool test);
 154         const char *help;
 155         int (*init)(struct udev *udev);
 156         void (*exit)(struct udev *udev);
 157         bool (*validate)(struct udev *udev);
 158         bool run_once;
 159 };
 160 extern const struct udev_builtin udev_builtin_blkid;
 161 extern const struct udev_builtin udev_builtin_btrfs;
 162 extern const struct udev_builtin udev_builtin_firmware;
 163 extern const struct udev_builtin udev_builtin_hwdb;
 164 extern const struct udev_builtin udev_builtin_input_id;
 165 extern const struct udev_builtin udev_builtin_kmod;
 166 extern const struct udev_builtin udev_builtin_net_id;
 167 extern const struct udev_builtin udev_builtin_path_id;
 168 extern const struct udev_builtin udev_builtin_usb_id;
 169 extern const struct udev_builtin udev_builtin_uaccess;
 170 void udev_builtin_init(struct udev *udev);
 171 void udev_builtin_exit(struct udev *udev);
 172 enum udev_builtin_cmd udev_builtin_lookup(const char *command);
 173 const char *udev_builtin_name(enum udev_builtin_cmd cmd);
 174 bool udev_builtin_run_once(enum udev_builtin_cmd cmd);
 175 int udev_builtin_run(struct udev_device *dev, enum udev_builtin_cmd cmd, const char *command, bool test);
 176 void udev_builtin_list(struct udev *udev);
 177 bool udev_builtin_validate(struct udev *udev);
 178 int udev_builtin_add_property(struct udev_device *dev, bool test, const char *key, const char *val);
 179 int udev_builtin_hwdb_lookup(struct udev_device *dev, const char *modalias, bool test);
 180
 181 /* udev logging */
 182 void udev_main_log(struct udev *udev, int priority,
 183                    const char *file, int line, const char *fn,
 184                    const char *format, va_list args);
 185
 186 /* udevadm commands */
 187 struct udevadm_cmd {
 188         const char *name;
 189         int (*cmd)(struct udev *udev, int argc, char *argv[]);
 190         const char *help;
 191         int debug;
 192 };
 193 extern const struct udevadm_cmd udevadm_info;
 194 extern const struct udevadm_cmd udevadm_trigger;
 195 extern const struct udevadm_cmd udevadm_settle;
 196 extern const struct udevadm_cmd udevadm_control;
 197 extern const struct udevadm_cmd udevadm_monitor;
 198 extern const struct udevadm_cmd udevadm_hwdb;
 199 extern const struct udevadm_cmd udevadm_test;
 200 extern const struct udevadm_cmd udevadm_test_builtin;
 201 #endif