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 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 extern struct udev_device *device_new(struct udev *udev);
  43 extern const char *udev_get_rules_path(struct udev *udev);
  44 extern int udev_get_run(struct udev *udev);
  45 extern struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
  46 extern struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
  47
  48 /* libudev-device */
  49 extern int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  50 extern int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
  51 extern int udev_device_set_devtype(struct udev_device *udev_device, const char *devtype);
  52 extern int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  53 extern int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  54 extern void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  55 extern struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  56 extern struct udev_list_entry *udev_device_add_property_from_string(struct udev_device *udev_device, const char *property);
  57 extern char **udev_device_get_properties_envp(struct udev_device *udev_device);
  58 extern ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  59 extern int udev_device_read_db(struct udev_device *udev_device);
  60 extern int udev_device_read_uevent_file(struct udev_device *udev_device);
  61 extern int udev_device_set_action(struct udev_device *udev_device, const char *action);
  62 extern int udev_device_set_driver(struct udev_device *udev_device, const char *driver);
  63 extern const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  64 extern int udev_device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old);
  65 extern const char *udev_device_get_physdevpath(struct udev_device *udev_device);
  66 extern int udev_device_set_physdevpath(struct udev_device *udev_device, const char *physdevpath);
  67 extern int udev_device_get_timeout(struct udev_device *udev_device);
  68 extern int udev_device_set_timeout(struct udev_device *udev_device, int timeout);
  69 extern int udev_device_get_event_timeout(struct udev_device *udev_device);
  70 extern int udev_device_set_event_timeout(struct udev_device *udev_device, int event_timeout);
  71 extern int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
  72 extern int udev_device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum);
  73 extern int udev_device_get_num_fake_partitions(struct udev_device *udev_device);
  74 extern int udev_device_set_num_fake_partitions(struct udev_device *udev_device, int num);
  75 extern int udev_device_get_devlink_priority(struct udev_device *udev_device);
  76 extern int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  77 extern int udev_device_get_ignore_remove(struct udev_device *udev_device);
  78 extern int udev_device_set_ignore_remove(struct udev_device *udev_device, int ignore);
  79 extern int udev_device_get_watch_handle(struct udev_device *udev_device);
  80 extern int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  81 extern void udev_device_set_info_loaded(struct udev_device *device);
  82
  83 /* libudev-device-db-write.c */
  84 extern int udev_device_update_db(struct udev_device *udev_device);
  85 extern int udev_device_delete_db(struct udev_device *udev_device);
  86 extern int udev_device_rename_db(struct udev_device *udev_device, const char *devpath);
  87
  88 /* libudev-monitor - netlink/unix socket communication  */
  89 extern int udev_monitor_send_device(struct udev_monitor *udev_monitor, struct udev_device *udev_device);
  90 extern int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size);
  91
  92 /* libudev-ctrl - daemon runtime setup */
  93 struct udev_ctrl;
  94 extern struct udev_ctrl *udev_ctrl_new_from_socket(struct udev *udev, const char *socket_path);
  95 extern int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
  96 extern struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
  97 extern void udev_ctrl_unref(struct udev_ctrl *uctrl);
  98 extern struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
  99 extern int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
 100 extern int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority);
 101 extern int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl);
 102 extern int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl);
 103 extern int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl);
 104 extern int udev_ctrl_send_settle(struct udev_ctrl *uctrl);
 105 extern int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key);
 106 extern int udev_ctrl_send_set_max_childs(struct udev_ctrl *uctrl, int count);
 107 struct udev_ctrl_msg;
 108 extern struct udev_ctrl_msg *udev_ctrl_msg(struct udev_ctrl *uctrl);
 109 extern struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl *uctrl);
 110 extern struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
 111 extern void udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
 112 extern int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
 113 extern int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 114 extern int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
 115 extern int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
 116 extern pid_t udev_ctrl_get_settle(struct udev_ctrl_msg *ctrl_msg);
 117 extern const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
 118 extern int udev_ctrl_get_set_max_childs(struct udev_ctrl_msg *ctrl_msg);
 119
 120 /* libudev-list */
 121 struct udev_list_node {
 122         struct udev_list_node *next, *prev;
 123 };
 124 extern void udev_list_init(struct udev_list_node *list);
 125 extern int udev_list_is_empty(struct udev_list_node *list);
 126 extern void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
 127 extern void udev_list_node_remove(struct udev_list_node *entry);
 128 #define udev_list_node_foreach(node, list) \
 129         for (node = (list)->next; \
 130              node != list; \
 131              node = (node)->next)
 132 #define udev_list_node_foreach_safe(node, tmp, list) \
 133         for (node = (list)->next, tmp = (node)->next; \
 134              node != list; \
 135              node = tmp, tmp = (tmp)->next)
 136 extern struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
 137                                                    const char *name, const char *value,
 138                                                    int unique, int sort);
 139 extern void udev_list_entry_delete(struct udev_list_entry *entry);
 140 extern void udev_list_entry_remove(struct udev_list_entry *entry);
 141 extern void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
 142 extern void udev_list_entry_append(struct udev_list_entry *new, struct udev_list_node *list);
 143 extern void udev_list_cleanup_entries(struct udev *udev, struct udev_list_node *name_list);
 144 extern struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list);
 145 extern int udev_list_entry_get_flag(struct udev_list_entry *list_entry);
 146 extern void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag);
 147 #define udev_list_entry_foreach_safe(entry, tmp, first) \
 148         for (entry = first, tmp = udev_list_entry_get_next(entry); \
 149              entry != NULL; \
 150              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 151
 152 /* libudev-queue */
 153 extern int udev_queue_export_udev_seqnum(struct udev_queue *udev_queue, unsigned long long int seqnum);
 154 extern int udev_queue_export_device_queued(struct udev_queue *udev_queue, struct udev_device *udev_device);
 155 extern int udev_queue_export_device_finished(struct udev_queue *udev_queue, struct udev_device *udev_device);
 156 extern int udev_queue_export_device_failed(struct udev_queue *udev_queue, struct udev_device *udev_device);
 157
 158 /* libudev-utils */
 159 #define UTIL_PATH_SIZE                          1024
 160 #define UTIL_LINE_SIZE                          2048
 161 #define UTIL_NAME_SIZE                          512
 162 #define UDEV_ALLOWED_CHARS_INPUT                "/ $%?,"
 163 extern ssize_t util_get_sys_subsystem(struct udev *udev, const char *syspath, char *subsystem, size_t size);
 164 extern ssize_t util_get_sys_driver(struct udev *udev, const char *syspath, char *driver, size_t size);
 165 extern int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 166 extern int util_log_priority(const char *priority);
 167 extern size_t util_path_encode(char *s, size_t len);
 168 extern size_t util_path_decode(char *s);
 169 extern void util_remove_trailing_chars(char *path, char c);
 170 extern size_t util_strlcpy(char *dst, const char *src, size_t size);
 171 extern size_t util_strlcat(char *dst, const char *src, size_t size);
 172 extern int udev_util_replace_whitespace(const char *str, char *to, size_t len);
 173 extern int udev_util_replace_chars(char *str, const char *white);
 174 extern int udev_util_encode_string(const char *str, char *str_enc, size_t len);
 175 extern void util_set_fd_cloexec(int fd);
 176 #endif