udev/lib/libudev-private.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef _LIBUDEV_PRIVATE_H_
  21 #define _LIBUDEV_PRIVATE_H_
  22
  23 #include <syslog.h>
  24 #include "libudev.h"
  25
  26 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  27
  28 static inline void __attribute__ ((format(printf, 2, 3)))
  29 udev_log_null(struct udev *udev, const char *format, ...) {}
  30
  31 #ifdef USE_LOG
  32 #  ifdef DEBUG
  33 #    define dbg(udev, arg...) udev_log(udev, LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, ## arg)
  34 #  else
  35 #    define dbg(udev, arg...) udev_log_null(udev, ## arg)
  36 #  endif
  37 #  define info(udev, arg...) udev_log(udev, LOG_INFO, __FILE__, __LINE__, __FUNCTION__, ## arg)
  38 #  define err(udev, arg...) udev_log(udev, LOG_ERR, __FILE__, __LINE__, __FUNCTION__, ## arg)
  39 #else
  40 #  define dbg(udev, arg...) udev_log_null(udev, ## arg)
  41 #  define info(udev, arg...) udev_log_null(udev, ## arg)
  42 #  define err(udev, arg...) udev_log_null(udev, ## arg)
  43 #endif
  44
  45 /* libudev */
  46 void udev_log(struct udev *udev,
  47               int priority, const char *file, int line, const char *fn,
  48               const char *format, ...)
  49               __attribute__ ((format(printf, 6, 7)));
  50 extern struct udev_device *device_new(struct udev *udev);
  51 extern const char *udev_get_rules_path(struct udev *udev);
  52 extern int udev_get_run(struct udev *udev);
  53 extern struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
  54 extern struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
  55
  56 /* libudev-device */
  57 extern int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  58 extern int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
  59 extern int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  60 extern int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  61 extern void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  62 extern struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  63 extern struct udev_list_entry *udev_device_add_property_from_string(struct udev_device *udev_device, const char *property);
  64 extern char **udev_device_get_properties_envp(struct udev_device *udev_device);
  65 extern int udev_device_read_db(struct udev_device *udev_device);
  66 extern int udev_device_read_uevent_file(struct udev_device *udev_device);
  67 extern int udev_device_set_action(struct udev_device *udev_device, const char *action);
  68 extern int udev_device_set_driver(struct udev_device *udev_device, const char *driver);
  69 extern const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  70 extern int udev_device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old);
  71 extern const char *udev_device_get_physdevpath(struct udev_device *udev_device);
  72 extern int udev_device_set_physdevpath(struct udev_device *udev_device, const char *physdevpath);
  73 extern int udev_device_get_timeout(struct udev_device *udev_device);
  74 extern int udev_device_set_timeout(struct udev_device *udev_device, int timeout);
  75 extern int udev_device_get_event_timeout(struct udev_device *udev_device);
  76 extern int udev_device_set_event_timeout(struct udev_device *udev_device, int event_timeout);
  77 extern int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
  78 extern int udev_device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum);
  79 extern int udev_device_get_num_fake_partitions(struct udev_device *udev_device);
  80 extern int udev_device_set_num_fake_partitions(struct udev_device *udev_device, int num);
  81 extern int udev_device_get_devlink_priority(struct udev_device *udev_device);
  82 extern int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  83 extern int udev_device_get_ignore_remove(struct udev_device *udev_device);
  84 extern int udev_device_set_ignore_remove(struct udev_device *udev_device, int ignore);
  85 extern void udev_device_set_info_loaded(struct udev_device *device);
  86
  87 /* libudev-monitor - netlink/unix socket communication  */
  88 extern int udev_monitor_send_device(struct udev_monitor *udev_monitor, struct udev_device *udev_device);
  89
  90 /* libudev-ctrl - daemon runtime setup */
  91 struct udev_ctrl;
  92 extern struct udev_ctrl *udev_ctrl_new_from_socket(struct udev *udev, const char *socket_path);
  93 extern int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
  94 extern struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
  95 extern void udev_ctrl_unref(struct udev_ctrl *uctrl);
  96 extern struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
  97 extern int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
  98 extern int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority);
  99 extern int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl);
 100 extern int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl);
 101 extern int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl);
 102 extern int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key);
 103 extern int udev_ctrl_send_set_max_childs(struct udev_ctrl *uctrl, int count);
 104 struct udev_ctrl_msg;
 105 extern struct udev_ctrl_msg *udev_ctrl_msg(struct udev_ctrl *uctrl);
 106 extern struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl *uctrl);
 107 extern struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 108 extern void udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 109 extern int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 110 extern int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 111 extern int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 112 extern int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
 113 extern const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 114 extern int udev_ctrl_get_set_max_childs(struct udev_ctrl_msg *ctrl_msg);
 115
 116 /* libudev-list */
 117 struct udev_list_node {
 118         struct udev_list_node *next, *prev;
 119 };
 120 extern void udev_list_init(struct udev_list_node *list);
 121 extern void udev_list_cleanup(struct udev *udev, struct udev_list_node *name_list);
 122 extern struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
 123                                                    const char *name, const char *value,
 124                                                    int unique, int sort);
 125 extern void udev_list_entry_remove(struct udev_list_entry *entry);
 126 extern struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list);
 127 extern void udev_list_entry_move_to_end(struct udev_list_entry *list_entry);
 128 extern int udev_list_entry_get_flag(struct udev_list_entry *list_entry);
 129 extern void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag);
 130 #define list_entry_foreach_safe(entry, tmp, first) \
 131         for (entry = first, \
 132              tmp = udev_list_entry_get_next(entry); \
 133              entry != NULL; \
 134              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 135
 136 /* libudev-queue */
 137 extern int udev_queue_export_udev_seqnum(struct udev_queue *udev_queue, unsigned long long int seqnum);
 138 extern int udev_queue_export_device_queued(struct udev_queue *udev_queue, struct udev_device *udev_device);
 139 extern int udev_queue_export_device_finished(struct udev_queue *udev_queue, struct udev_device *udev_device);
 140 extern int udev_queue_export_device_failed(struct udev_queue *udev_queue, struct udev_device *udev_device);
 141
 142 /* libudev-utils */
 143 #define UTIL_PATH_SIZE          1024
 144 #define UTIL_LINE_SIZE          2048
 145 #define UTIL_NAME_SIZE          512
 146 extern ssize_t util_get_sys_subsystem(struct udev *udev, const char *syspath, char *subsystem, size_t size);
 147 extern ssize_t util_get_sys_driver(struct udev *udev, const char *syspath, char *driver, size_t size);
 148 extern int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 149 extern int util_log_priority(const char *priority);
 150 extern size_t util_path_encode(char *s, size_t len);
 151 extern size_t util_path_decode(char *s);
 152 extern void util_remove_trailing_chars(char *path, char c);
 153 extern size_t util_strlcpy(char *dst, const char *src, size_t size);
 154 extern size_t util_strlcat(char *dst, const char *src, size_t size);
 155 extern int util_replace_chars(char *str, const char *white);
 156 #endif