src/libudev/libudev-private.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008-2012 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
  20 #include "libudev.h"
  21 #include "macro.h"
  22 #include "util.h"
  23 #include "mkdir.h"
  24
  25 #define READ_END  0
  26 #define WRITE_END 1
  27
  28 /* avoid (sometimes expensive) calculations of parameters for debug output */
  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 #define udev_dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
  36 #define udev_info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
  37 #define udev_err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
  38
  39 /* libudev.c */
  40 void udev_log(struct udev *udev,
  41               int priority, const char *file, int line, const char *fn,
  42               const char *format, ...)
  43               __attribute__((format(printf, 6, 7)));
  44 int udev_get_rules_path(struct udev *udev, char **path[], usec_t *ts_usec[]);
  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.c */
  49 struct udev_device *udev_device_new(struct udev *udev);
  50 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
  51 int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
  52 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
  53 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
  54 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  55 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  56 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  57 void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
  58 int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
  59 char **udev_device_get_properties_envp(struct udev_device *udev_device);
  60 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  61 int udev_device_read_db(struct udev_device *udev_device, const char *dbfile);
  62 int udev_device_read_uevent_file(struct udev_device *udev_device);
  63 int udev_device_set_action(struct udev_device *udev_device, const char *action);
  64 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  65 const char *udev_device_get_id_filename(struct udev_device *udev_device);
  66 void udev_device_set_is_initialized(struct udev_device *udev_device);
  67 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
  68 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
  69 usec_t udev_device_get_usec_initialized(struct udev_device *udev_device);
  70 void udev_device_set_usec_initialized(struct udev_device *udev_device, usec_t usec_initialized);
  71 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  72 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  73 int udev_device_get_watch_handle(struct udev_device *udev_device);
  74 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  75 int udev_device_get_ifindex(struct udev_device *udev_device);
  76 void udev_device_set_info_loaded(struct udev_device *device);
  77 bool udev_device_get_db_persist(struct udev_device *udev_device);
  78 void udev_device_set_db_persist(struct udev_device *udev_device);
  79
  80 /* libudev-device-private.c */
  81 int udev_device_update_db(struct udev_device *udev_device);
  82 int udev_device_delete_db(struct udev_device *udev_device);
  83 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
  84
  85 /* libudev-monitor.c - netlink/unix socket communication  */
  86 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
  87 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
  88 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
  89                              struct udev_monitor *destination, struct udev_device *udev_device);
  90 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
  91
  92 /* libudev-list.c */
  93 struct udev_list_node {
  94         struct udev_list_node *next, *prev;
  95 };
  96 struct udev_list {
  97         struct udev *udev;
  98         struct udev_list_node node;
  99         struct udev_list_entry **entries;
 100         unsigned int entries_cur;
 101         unsigned int entries_max;
 102         bool unique;
 103 };
 104 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
 105 void udev_list_node_init(struct udev_list_node *list);
 106 int udev_list_node_is_empty(struct udev_list_node *list);
 107 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
 108 void udev_list_node_remove(struct udev_list_node *entry);
 109 #define udev_list_node_foreach(node, list) \
 110         for (node = (list)->next; \
 111              node != list; \
 112              node = (node)->next)
 113 #define udev_list_node_foreach_safe(node, tmp, list) \
 114         for (node = (list)->next, tmp = (node)->next; \
 115              node != list; \
 116              node = tmp, tmp = (tmp)->next)
 117 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
 118 void udev_list_cleanup(struct udev_list *list);
 119 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
 120 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
 121 void udev_list_entry_delete(struct udev_list_entry *entry);
 122 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
 123 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list *list);
 124 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
 125 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
 126 #define udev_list_entry_foreach_safe(entry, tmp, first) \
 127         for (entry = first, tmp = udev_list_entry_get_next(entry); \
 128              entry != NULL; \
 129              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 130
 131 /* libudev-queue.c */
 132 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
 133 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
 134 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
 135 ssize_t udev_queue_skip_devpath(FILE *queue_file);
 136
 137 /* libudev-queue-private.c */
 138 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
 139 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
 140 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
 141 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 142 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 143
 144 /* libudev-hwdb.c */
 145 bool udev_hwdb_validate(struct udev_hwdb *hwdb);
 146
 147 /* libudev-util.c */
 148 #define UTIL_PATH_SIZE                      1024
 149 #define UTIL_NAME_SIZE                       512
 150 #define UTIL_LINE_SIZE                     16384
 151 #define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
 152 ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
 153 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
 154 int util_log_priority(const char *priority);
 155 size_t util_path_encode(const char *src, char *dest, size_t size);
 156 void util_remove_trailing_chars(char *path, char c);
 157 size_t util_strpcpy(char **dest, size_t size, const char *src);
 158 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
 159 size_t util_strscpy(char *dest, size_t size, const char *src);
 160 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
 161 int util_replace_whitespace(const char *str, char *to, size_t len);
 162 int util_replace_chars(char *str, const char *white);
 163 unsigned int util_string_hash32(const char *key);
 164 uint64_t util_string_bloom64(const char *str);
 165
 166 /* libudev-util-private.c */
 167 int util_delete_path(struct udev *udev, const char *path);
 168 uid_t util_lookup_user(struct udev *udev, const char *user);
 169 gid_t util_lookup_group(struct udev *udev, const char *group);
 170 int util_resolve_subsys_kernel(struct udev *udev, const char *string, char *result, size_t maxsize, int read_value);
 171 ssize_t print_kmsg(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
 172 #endif