src/udev/libudev-private.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008-2010 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 <signal.h>
  17 #include <stdint.h>
  18 #include <stdbool.h>
  19 #include "macro.h"
  20 #include "libudev.h"
  21
  22 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  23 #define READ_END                                0
  24 #define WRITE_END                                1
  25
  26 static inline void __attribute__((always_inline, format(printf, 2, 3)))
  27 udev_log_null(struct udev *udev, const char *format, ...) {}
  28
  29 #define udev_log_cond(udev, prio, arg...) \
  30   do { \
  31     if (udev_get_log_priority(udev) >= prio) \
  32       udev_log(udev, prio, __FILE__, __LINE__, __FUNCTION__, ## arg); \
  33   } while (0)
  34
  35 #ifdef ENABLE_DEBUG
  36 #  define dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
  37 #else
  38 #  define dbg(udev, arg...) udev_log_null(udev, ## arg)
  39 #endif
  40 #define info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
  41 #define err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
  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 int udev_get_rules_path(struct udev *udev, char **path[], unsigned long long *ts_usec[]);
  59 struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
  60 struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
  61
  62 /* libudev-device.c */
  63 struct udev_device *udev_device_new(struct udev *udev);
  64 struct udev_device *udev_device_new_from_id_filename(struct udev *udev, char *id);
  65 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
  66 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  67 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  68 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink, int unique);
  69 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  70 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  71 void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
  72 int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
  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, const char *dbfile);
  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 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  79 const char *udev_device_get_id_filename(struct udev_device *udev_device);
  80 void udev_device_set_is_initialized(struct udev_device *udev_device);
  81 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
  82 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
  83 unsigned long long udev_device_get_usec_initialized(struct udev_device *udev_device);
  84 void udev_device_set_usec_initialized(struct udev_device *udev_device, unsigned long long usec_initialized);
  85 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  86 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  87 int udev_device_get_watch_handle(struct udev_device *udev_device);
  88 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  89 int udev_device_get_ifindex(struct udev_device *udev_device);
  90 void udev_device_set_info_loaded(struct udev_device *device);
  91 bool udev_device_get_db_persist(struct udev_device *udev_device);
  92 void udev_device_set_db_persist(struct udev_device *udev_device);
  93
  94 /* libudev-device-private.c */
  95 int udev_device_update_db(struct udev_device *udev_device);
  96 int udev_device_delete_db(struct udev_device *udev_device);
  97 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
  98
  99 /* libudev-monitor.c - netlink/unix socket communication  */
 100 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
 101 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
 102 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
 103                              struct udev_monitor *destination, struct udev_device *udev_device);
 104 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
 105
 106 /* libudev-list.c */
 107 struct udev_list_node {
 108         struct udev_list_node *next, *prev;
 109 };
 110 struct udev_list {
 111         struct udev *udev;
 112         struct udev_list_node node;
 113         struct udev_list_entry **entries;
 114         unsigned int entries_cur;
 115         unsigned int entries_max;
 116         bool unique;
 117 };
 118 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
 119 void udev_list_node_init(struct udev_list_node *list);
 120 int udev_list_node_is_empty(struct udev_list_node *list);
 121 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
 122 void udev_list_node_remove(struct udev_list_node *entry);
 123 #define udev_list_node_foreach(node, list) \
 124         for (node = (list)->next; \
 125              node != list; \
 126              node = (node)->next)
 127 #define udev_list_node_foreach_safe(node, tmp, list) \
 128         for (node = (list)->next, tmp = (node)->next; \
 129              node != list; \
 130              node = tmp, tmp = (tmp)->next)
 131 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
 132 void udev_list_cleanup(struct udev_list *list);
 133 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
 134 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
 135 void udev_list_entry_delete(struct udev_list_entry *entry);
 136 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
 137 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list *list);
 138 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
 139 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
 140 #define udev_list_entry_foreach_safe(entry, tmp, first) \
 141         for (entry = first, tmp = udev_list_entry_get_next(entry); \
 142              entry != NULL; \
 143              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 144
 145 /* libudev-queue.c */
 146 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
 147 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
 148 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
 149 ssize_t udev_queue_skip_devpath(FILE *queue_file);
 150
 151 /* libudev-queue-private.c */
 152 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
 153 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
 154 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
 155 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 156 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 157
 158 /* libudev-util.c */
 159 #define UTIL_PATH_SIZE                                1024
 160 #define UTIL_NAME_SIZE                                512
 161 #define UTIL_LINE_SIZE                                16384
 162 #define UDEV_ALLOWED_CHARS_INPUT                "/ $%?,"
 163 ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
 164 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 165 int util_log_priority(const char *priority);
 166 size_t util_path_encode(const char *src, char *dest, size_t size);
 167 size_t util_path_decode(char *s);
 168 void util_remove_trailing_chars(char *path, char c);
 169 size_t util_strpcpy(char **dest, size_t size, const char *src);
 170 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
 171 size_t util_strscpy(char *dest, size_t size, const char *src);
 172 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
 173 int util_replace_whitespace(const char *str, char *to, size_t len);
 174 int util_replace_chars(char *str, const char *white);
 175 unsigned int util_string_hash32(const char *key);
 176 uint64_t util_string_bloom64(const char *str);
 177
 178 /* libudev-util-private.c */
 179 int util_create_path(struct udev *udev, const char *path);
 180 int util_create_path_selinux(struct udev *udev, const char *path);
 181 int util_delete_path(struct udev *udev, const char *path);
 182 uid_t util_lookup_user(struct udev *udev, const char *user);
 183 gid_t util_lookup_group(struct udev *udev, const char *group);
 184 int util_resolve_subsys_kernel(struct udev *udev, const char *string,
 185                                       char *result, size_t maxsize, int read_value);
 186 unsigned long long ts_usec(const struct timespec *ts);
 187 unsigned long long now_usec(void);
 188
 189 /* libudev-selinux-private.c */
 190 #ifndef HAVE_SELINUX
 191 static inline void udev_selinux_init(struct udev *udev) {}
 192 static inline void udev_selinux_exit(struct udev *udev) {}
 193 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
 194 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
 195 static inline void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode) {}
 196 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
 197 #else
 198 void udev_selinux_init(struct udev *udev);
 199 void udev_selinux_exit(struct udev *udev);
 200 void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
 201 void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
 202 void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode);
 203 void udev_selinux_resetfscreatecon(struct udev *udev);
 204 #endif
 205
 206 #endif