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
  20 static inline void __attribute__((always_inline, format(printf, 2, 3)))
  21 udev_log_null(struct udev *udev, const char *format, ...) {}
  22
  23 #define udev_log_cond(udev, prio, arg...) \
  24   do { \
  25     if (udev_get_log_priority(udev) >= prio) \
  26       udev_log(udev, LOG_ERR, __FILE__, __LINE__, __FUNCTION__, ## arg); \
  27   } while (0)
  28
  29 #ifdef USE_LOG
  30 #  ifdef DEBUG
  31 #    define dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
  32 #  else
  33 #    define dbg(udev, arg...) udev_log_null(udev, ## arg)
  34 #  endif
  35 #  define info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
  36 #  define err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
  37 #else
  38 #  define dbg(udev, arg...) udev_log_null(udev, ## arg)
  39 #  define info(udev, arg...) udev_log_null(udev, ## arg)
  40 #  define err(udev, arg...) udev_log_null(udev, ## arg)
  41 #endif
  42
  43 static inline void udev_log_init(const char *program_name)
  44 {
  45         openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
  46 }
  47
  48 static inline void udev_log_close(void)
  49 {
  50         closelog();
  51 }
  52
  53 /* libudev.c */
  54 void udev_log(struct udev *udev,
  55               int priority, const char *file, int line, const char *fn,
  56               const char *format, ...)
  57               __attribute__((format(printf, 6, 7)));
  58 const char *udev_get_rules_path(struct udev *udev);
  59 int udev_get_run(struct udev *udev);
  60 struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
  61 struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
  62
  63 /* libudev-device.c */
  64 struct udev_device *udev_device_new(struct udev *udev);
  65 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  66 int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
  67 int udev_device_set_devtype(struct udev_device *udev_device, const char *devtype);
  68 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  69 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  70 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  71 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  72 struct udev_list_entry *udev_device_add_property_from_string(struct udev_device *udev_device, const char *property);
  73 char **udev_device_get_properties_envp(struct udev_device *udev_device);
  74 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  75 int udev_device_read_db(struct udev_device *udev_device);
  76 int udev_device_read_uevent_file(struct udev_device *udev_device);
  77 int udev_device_set_action(struct udev_device *udev_device, const char *action);
  78 int udev_device_set_driver(struct udev_device *udev_device, const char *driver);
  79 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  80 int udev_device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old);
  81 const char *udev_device_get_knodename(struct udev_device *udev_device);
  82 int udev_device_set_knodename(struct udev_device *udev_device, const char *knodename);
  83 int udev_device_get_timeout(struct udev_device *udev_device);
  84 int udev_device_set_timeout(struct udev_device *udev_device, int timeout);
  85 int udev_device_get_event_timeout(struct udev_device *udev_device);
  86 int udev_device_set_event_timeout(struct udev_device *udev_device, int event_timeout);
  87 int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
  88 int udev_device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum);
  89 int udev_device_get_num_fake_partitions(struct udev_device *udev_device);
  90 int udev_device_set_num_fake_partitions(struct udev_device *udev_device, int num);
  91 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  92 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  93 int udev_device_get_ignore_remove(struct udev_device *udev_device);
  94 int udev_device_set_ignore_remove(struct udev_device *udev_device, int ignore);
  95 int udev_device_get_watch_handle(struct udev_device *udev_device);
  96 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  97 void udev_device_set_info_loaded(struct udev_device *device);
  98
  99 /* libudev-device-db-write.c */
 100 int udev_device_update_db(struct udev_device *udev_device);
 101 int udev_device_delete_db(struct udev_device *udev_device);
 102 int udev_device_rename_db(struct udev_device *udev_device, const char *devpath);
 103
 104 /* libudev-monitor.c - netlink/unix socket communication  */
 105 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
 106 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
 107 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
 108                              struct udev_monitor *destination, struct udev_device *udev_device);
 109 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size);
 110
 111 /* libudev-ctrl.c - daemon runtime setup */
 112 struct udev_ctrl;
 113 struct udev_ctrl *udev_ctrl_new_from_socket(struct udev *udev, const char *socket_path);
 114 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
 115 struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
 116 void udev_ctrl_unref(struct udev_ctrl *uctrl);
 117 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
 118 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
 119 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority);
 120 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl);
 121 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl);
 122 int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl);
 123 int udev_ctrl_send_settle(struct udev_ctrl *uctrl);
 124 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key);
 125 int udev_ctrl_send_set_max_childs(struct udev_ctrl *uctrl, int count);
 126 struct udev_ctrl_msg;
 127 struct udev_ctrl_msg *udev_ctrl_msg(struct udev_ctrl *uctrl);
 128 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl *uctrl);
 129 struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 130 void udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 131 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 132 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 133 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 134 int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
 135 pid_t udev_ctrl_get_settle(struct udev_ctrl_msg *ctrl_msg);
 136 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 137 int udev_ctrl_get_set_max_childs(struct udev_ctrl_msg *ctrl_msg);
 138
 139 /* libudev-list.c */
 140 struct udev_list_node {
 141         struct udev_list_node *next, *prev;
 142 };
 143 void udev_list_init(struct udev_list_node *list);
 144 int udev_list_is_empty(struct udev_list_node *list);
 145 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
 146 void udev_list_node_remove(struct udev_list_node *entry);
 147 #define udev_list_node_foreach(node, list) \
 148         for (node = (list)->next; \
 149              node != list; \
 150              node = (node)->next)
 151 #define udev_list_node_foreach_safe(node, tmp, list) \
 152         for (node = (list)->next, tmp = (node)->next; \
 153              node != list; \
 154              node = tmp, tmp = (tmp)->next)
 155 struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
 156                                                    const char *name, const char *value,
 157                                                    int unique, int sort);
 158 void udev_list_entry_delete(struct udev_list_entry *entry);
 159 void udev_list_entry_remove(struct udev_list_entry *entry);
 160 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
 161 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list_node *list);
 162 void udev_list_cleanup_entries(struct udev *udev, struct udev_list_node *name_list);
 163 struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list);
 164 int udev_list_entry_get_flag(struct udev_list_entry *list_entry);
 165 void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag);
 166 #define udev_list_entry_foreach_safe(entry, tmp, first) \
 167         for (entry = first, tmp = udev_list_entry_get_next(entry); \
 168              entry != NULL; \
 169              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 170
 171 /* libudev-queue.c */
 172 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
 173 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
 174 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
 175 ssize_t udev_queue_skip_devpath(FILE *queue_file);
 176
 177 /* libudev-queue-export.c */
 178 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
 179 void udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
 180 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
 181 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 182 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 183 int udev_queue_export_device_failed(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 184
 185 /* libudev-utils.c */
 186 #define UTIL_PATH_SIZE                          1024
 187 #define UTIL_LINE_SIZE                          2048
 188 #define UTIL_NAME_SIZE                          512
 189 #define UDEV_ALLOWED_CHARS_INPUT                "/ $%?,"
 190 ssize_t util_get_sys_subsystem(struct udev *udev, const char *syspath, char *subsystem, size_t size);
 191 ssize_t util_get_sys_driver(struct udev *udev, const char *syspath, char *driver, size_t size);
 192 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 193 int util_log_priority(const char *priority);
 194 size_t util_path_encode(const char *src, char *dest, size_t size);
 195 size_t util_path_decode(char *s);
 196 void util_remove_trailing_chars(char *path, char c);
 197 size_t util_strpcpy(char **dest, size_t size, const char *src);
 198 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
 199 size_t util_strscpy(char *dest, size_t size, const char *src);
 200 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
 201 int udev_util_replace_whitespace(const char *str, char *to, size_t len);
 202 int udev_util_replace_chars(char *str, const char *white);
 203 int udev_util_encode_string(const char *str, char *str_enc, size_t len);
 204 void util_set_fd_cloexec(int fd);
 205 unsigned int util_string_hash32(const char *str);
 206 #endif