libudev/libudev-private.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008-2009 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  */
  11
  12 #ifndef _LIBUDEV_PRIVATE_H_
  13 #define _LIBUDEV_PRIVATE_H_
  14
  15 #include <syslog.h>
  16 #include "libudev.h"
  17
  18 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  19 #define UDEV_MAX(a,b) ((a) > (b) ? (a) : (b))
  20 #define READ_END                                0
  21 #define WRITE_END                               1
  22
  23 static inline void __attribute__((always_inline, format(printf, 2, 3)))
  24 udev_log_null(struct udev *udev, const char *format, ...) {}
  25
  26 #define udev_log_cond(udev, prio, arg...) \
  27   do { \
  28     if (udev_get_log_priority(udev) >= prio) \
  29       udev_log(udev, LOG_ERR, __FILE__, __LINE__, __FUNCTION__, ## arg); \
  30   } while (0)
  31
  32 #ifdef ENABLE_LOGGING
  33 #  ifdef ENABLE_DEBUG
  34 #    define dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
  35 #  else
  36 #    define dbg(udev, arg...) udev_log_null(udev, ## arg)
  37 #  endif
  38 #  define info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
  39 #  define err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
  40 #else
  41 #  define dbg(udev, arg...) udev_log_null(udev, ## arg)
  42 #  define info(udev, arg...) udev_log_null(udev, ## arg)
  43 #  define err(udev, arg...) udev_log_null(udev, ## arg)
  44 #endif
  45
  46 static inline void udev_log_init(const char *program_name)
  47 {
  48         openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
  49 }
  50
  51 static inline void udev_log_close(void)
  52 {
  53         closelog();
  54 }
  55
  56 /* libudev.c */
  57 void udev_log(struct udev *udev,
  58               int priority, const char *file, int line, const char *fn,
  59               const char *format, ...)
  60               __attribute__((format(printf, 6, 7)));
  61 const char *udev_get_rules_path(struct udev *udev);
  62 int udev_get_run(struct udev *udev);
  63 struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
  64 struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
  65
  66 /* libudev-device.c */
  67 struct udev_device *udev_device_new(struct udev *udev);
  68 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  69 int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
  70 int udev_device_set_devtype(struct udev_device *udev_device, const char *devtype);
  71 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  72 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  73 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  74 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  75 struct udev_list_entry *udev_device_add_property_from_string(struct udev_device *udev_device, const char *property);
  76 char **udev_device_get_properties_envp(struct udev_device *udev_device);
  77 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  78 int udev_device_read_db(struct udev_device *udev_device);
  79 int udev_device_read_uevent_file(struct udev_device *udev_device);
  80 int udev_device_set_action(struct udev_device *udev_device, const char *action);
  81 int udev_device_set_driver(struct udev_device *udev_device, const char *driver);
  82 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  83 int udev_device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old);
  84 const char *udev_device_get_knodename(struct udev_device *udev_device);
  85 int udev_device_set_knodename(struct udev_device *udev_device, const char *knodename);
  86 int udev_device_get_timeout(struct udev_device *udev_device);
  87 int udev_device_set_timeout(struct udev_device *udev_device, int timeout);
  88 int udev_device_get_event_timeout(struct udev_device *udev_device);
  89 int udev_device_set_event_timeout(struct udev_device *udev_device, int event_timeout);
  90 int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
  91 int udev_device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum);
  92 int udev_device_get_num_fake_partitions(struct udev_device *udev_device);
  93 int udev_device_set_num_fake_partitions(struct udev_device *udev_device, int num);
  94 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  95 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  96 int udev_device_get_ignore_remove(struct udev_device *udev_device);
  97 int udev_device_set_ignore_remove(struct udev_device *udev_device, int ignore);
  98 int udev_device_get_watch_handle(struct udev_device *udev_device);
  99 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
 100 void udev_device_set_info_loaded(struct udev_device *device);
 101
 102 /* libudev-device-private.c */
 103 int udev_device_update_db(struct udev_device *udev_device);
 104 int udev_device_delete_db(struct udev_device *udev_device);
 105 int udev_device_rename_db(struct udev_device *udev_device, const char *devpath);
 106
 107 /* libudev-monitor.c - netlink/unix socket communication  */
 108 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
 109 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
 110 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
 111                              struct udev_monitor *destination, struct udev_device *udev_device);
 112 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size);
 113
 114 /* libudev-ctrl.c - daemon runtime setup */
 115 struct udev_ctrl;
 116 struct udev_ctrl *udev_ctrl_new_from_socket(struct udev *udev, const char *socket_path);
 117 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
 118 struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
 119 void udev_ctrl_unref(struct udev_ctrl *uctrl);
 120 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
 121 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
 122 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority);
 123 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl);
 124 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl);
 125 int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl);
 126 int udev_ctrl_send_settle(struct udev_ctrl *uctrl);
 127 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key);
 128 int udev_ctrl_send_set_max_childs(struct udev_ctrl *uctrl, int count);
 129 struct udev_ctrl_msg;
 130 struct udev_ctrl_msg *udev_ctrl_msg(struct udev_ctrl *uctrl);
 131 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl *uctrl);
 132 struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 133 void udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 134 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 135 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 136 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 137 int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
 138 pid_t udev_ctrl_get_settle(struct udev_ctrl_msg *ctrl_msg);
 139 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 140 int udev_ctrl_get_set_max_childs(struct udev_ctrl_msg *ctrl_msg);
 141
 142 /* libudev-list.c */
 143 struct udev_list_node {
 144         struct udev_list_node *next, *prev;
 145 };
 146 void udev_list_init(struct udev_list_node *list);
 147 int udev_list_is_empty(struct udev_list_node *list);
 148 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
 149 void udev_list_node_remove(struct udev_list_node *entry);
 150 #define udev_list_node_foreach(node, list) \
 151         for (node = (list)->next; \
 152              node != list; \
 153              node = (node)->next)
 154 #define udev_list_node_foreach_safe(node, tmp, list) \
 155         for (node = (list)->next, tmp = (node)->next; \
 156              node != list; \
 157              node = tmp, tmp = (tmp)->next)
 158 struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
 159                                                    const char *name, const char *value,
 160                                                    int unique, int sort);
 161 void udev_list_entry_delete(struct udev_list_entry *entry);
 162 void udev_list_entry_remove(struct udev_list_entry *entry);
 163 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
 164 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list_node *list);
 165 void udev_list_cleanup_entries(struct udev *udev, struct udev_list_node *name_list);
 166 struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list);
 167 int udev_list_entry_get_flag(struct udev_list_entry *list_entry);
 168 void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag);
 169 #define udev_list_entry_foreach_safe(entry, tmp, first) \
 170         for (entry = first, tmp = udev_list_entry_get_next(entry); \
 171              entry != NULL; \
 172              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 173
 174 /* libudev-queue.c */
 175 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
 176 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
 177 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
 178 ssize_t udev_queue_skip_devpath(FILE *queue_file);
 179
 180 /* libudev-queue-private.c */
 181 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
 182 void udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
 183 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
 184 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 185 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 186 int udev_queue_export_device_failed(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 187
 188 /* libudev-util.c */
 189 #define UTIL_PATH_SIZE                          1024
 190 #define UTIL_LINE_SIZE                          2048
 191 #define UTIL_NAME_SIZE                          512
 192 #define UDEV_ALLOWED_CHARS_INPUT                "/ $%?,"
 193 ssize_t util_get_sys_subsystem(struct udev *udev, const char *syspath, char *subsystem, size_t size);
 194 ssize_t util_get_sys_driver(struct udev *udev, const char *syspath, char *driver, size_t size);
 195 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 196 int util_log_priority(const char *priority);
 197 size_t util_path_encode(const char *src, char *dest, size_t size);
 198 size_t util_path_decode(char *s);
 199 void util_remove_trailing_chars(char *path, char c);
 200 size_t util_strpcpy(char **dest, size_t size, const char *src);
 201 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
 202 size_t util_strscpy(char *dest, size_t size, const char *src);
 203 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
 204 int udev_util_replace_whitespace(const char *str, char *to, size_t len);
 205 int udev_util_replace_chars(char *str, const char *white);
 206 int udev_util_encode_string(const char *str, char *str_enc, size_t len);
 207 void util_set_fd_cloexec(int fd);
 208 unsigned int util_string_hash32(const char *str);
 209
 210 /* libudev-util-private.c */
 211 int util_create_path(struct udev *udev, const char *path);
 212 int util_delete_path(struct udev *udev, const char *path);
 213 int util_unlink_secure(struct udev *udev, const char *filename);
 214 uid_t util_lookup_user(struct udev *udev, const char *user);
 215 gid_t util_lookup_group(struct udev *udev, const char *group);
 216 int util_run_program(struct udev *udev, const char *command, char **envp,
 217                      char *result, size_t ressize, size_t *reslen);
 218 int util_resolve_subsys_kernel(struct udev *udev, const char *string,
 219                                       char *result, size_t maxsize, int read_value);
 220
 221 /* libudev-selinux-private.c */
 222 #ifndef WITH_SELINUX
 223 static inline void udev_selinux_init(struct udev *udev) {}
 224 static inline void udev_selinux_exit(struct udev *udev) {}
 225 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
 226 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
 227 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
 228 #else
 229 void udev_selinux_init(struct udev *udev);
 230 void udev_selinux_exit(struct udev *udev);
 231 void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
 232 void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
 233 void udev_selinux_resetfscreatecon(struct udev *udev);
 234 #endif
 235 #endif