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