src/libudev/libudev-private.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <signal.h>
   5 #include <stdbool.h>
   6 #include <stdint.h>
   7
   8 #include "libudev.h"
   9
  10 #include "macro.h"
  11 #include "mkdir.h"
  12 #include "strxcpyx.h"
  13 #include "util.h"
  14
  15 #define READ_END  0
  16 #define WRITE_END 1
  17
  18 /* libudev.c */
  19 int udev_get_rules_path(struct udev *udev, char **path[], usec_t *ts_usec[]);
  20
  21 /* libudev-device.c */
  22 struct udev_device *udev_device_new_from_nulstr(struct udev *udev, char *nulstr, ssize_t buflen);
  23 struct udev_device *udev_device_new_from_synthetic_event(struct udev *udev, const char *syspath, const char *action);
  24 struct udev_device *udev_device_shallow_clone(struct udev_device *old_device);
  25 struct udev_device *udev_device_clone_with_db(struct udev_device *old_device);
  26 int udev_device_copy_properties(struct udev_device *dst, struct udev_device *src);
  27 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
  28 uid_t udev_device_get_devnode_uid(struct udev_device *udev_device);
  29 gid_t udev_device_get_devnode_gid(struct udev_device *udev_device);
  30 int udev_device_rename(struct udev_device *udev_device, const char *new_name);
  31 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  32 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  33 int udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  34 char **udev_device_get_properties_envp(struct udev_device *udev_device);
  35 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  36 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  37 const char *udev_device_get_id_filename(struct udev_device *udev_device);
  38 void udev_device_set_is_initialized(struct udev_device *udev_device);
  39 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
  40 void udev_device_remove_tag(struct udev_device *udev_device, const char *tag);
  41 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
  42 usec_t udev_device_get_usec_initialized(struct udev_device *udev_device);
  43 void udev_device_ensure_usec_initialized(struct udev_device *udev_device, struct udev_device *old_device);
  44 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  45 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  46 int udev_device_get_watch_handle(struct udev_device *udev_device);
  47 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  48 int udev_device_get_ifindex(struct udev_device *udev_device);
  49 void udev_device_set_info_loaded(struct udev_device *device);
  50 bool udev_device_get_db_persist(struct udev_device *udev_device);
  51 void udev_device_set_db_persist(struct udev_device *udev_device);
  52 void udev_device_read_db(struct udev_device *udev_device);
  53
  54 /* libudev-device-private.c */
  55 int udev_device_update_db(struct udev_device *udev_device);
  56 int udev_device_delete_db(struct udev_device *udev_device);
  57 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
  58
  59 /* libudev-monitor.c - netlink/unix socket communication  */
  60 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
  61 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
  62 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
  63                              struct udev_monitor *destination, struct udev_device *udev_device);
  64 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
  65
  66 /* libudev-list.c */
  67 struct udev_list_node {
  68         struct udev_list_node *next, *prev;
  69 };
  70 struct udev_list {
  71         struct udev *udev;
  72         struct udev_list_node node;
  73         struct udev_list_entry **entries;
  74         unsigned int entries_cur;
  75         unsigned int entries_max;
  76         bool unique;
  77 };
  78 void udev_list_node_init(struct udev_list_node *list);
  79 int udev_list_node_is_empty(struct udev_list_node *list);
  80 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
  81 void udev_list_node_remove(struct udev_list_node *entry);
  82 #define udev_list_node_foreach(node, list) \
  83         for (node = (list)->next; \
  84              node != list; \
  85              node = (node)->next)
  86 #define udev_list_node_foreach_safe(node, tmp, list) \
  87         for (node = (list)->next, tmp = (node)->next; \
  88              node != list; \
  89              node = tmp, tmp = (tmp)->next)
  90 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
  91 void udev_list_cleanup(struct udev_list *list);
  92 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
  93 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
  94 void udev_list_entry_delete(struct udev_list_entry *entry);
  95 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
  96 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
  97 #define udev_list_entry_foreach_safe(entry, tmp, first) \
  98         for (entry = first, tmp = udev_list_entry_get_next(entry); \
  99              entry != NULL; \
 100              entry = tmp, tmp = udev_list_entry_get_next(tmp))
 101
 102 /* libudev-queue.c */
 103 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
 104 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
 105 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
 106 ssize_t udev_queue_skip_devpath(FILE *queue_file);
 107
 108 /* libudev-queue-private.c */
 109 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
 110 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
 111 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
 112 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 113 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
 114
 115 /* libudev-util.c */
 116 #define UTIL_PATH_SIZE                      1024
 117 #define UTIL_NAME_SIZE                       512
 118 #define UTIL_LINE_SIZE                     16384
 119 #define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
 120 int util_log_priority(const char *priority);
 121 size_t util_path_encode(const char *src, char *dest, size_t size);
 122 int util_replace_whitespace(const char *str, char *to, size_t len);
 123 int util_replace_chars(char *str, const char *white);
 124 unsigned int util_string_hash32(const char *key);
 125 uint64_t util_string_bloom64(const char *str);
 126
 127 /* libudev-util-private.c */
 128 int util_resolve_subsys_kernel(struct udev *udev, const char *string, char *result, size_t maxsize, int read_value);
 129
 130 /* Cleanup functions */
 131 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev*, udev_unref);
 132 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_device*, udev_device_unref);
 133 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_enumerate*, udev_enumerate_unref);
 134 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_monitor*, udev_monitor_unref);
 135 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_hwdb*, udev_hwdb_unref);
 136 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_queue*, udev_queue_unref);