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 #include "sd-device.h"
  10
  11 #include "macro.h"
  12 #include "mkdir.h"
  13 #include "strxcpyx.h"
  14 #include "util.h"
  15
  16 #define READ_END  0
  17 #define WRITE_END 1
  18
  19 /* libudev-device.c */
  20 struct udev_device *udev_device_new_from_nulstr(struct udev *udev, char *nulstr, ssize_t buflen);
  21 struct udev_device *udev_device_new_from_synthetic_event(struct udev *udev, const char *syspath, const char *action);
  22 struct udev_device *udev_device_shallow_clone(struct udev_device *old_device);
  23 struct udev_device *udev_device_clone_with_db(struct udev_device *old_device);
  24 int udev_device_copy_properties(struct udev_device *dst, struct udev_device *src);
  25 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
  26 uid_t udev_device_get_devnode_uid(struct udev_device *udev_device);
  27 gid_t udev_device_get_devnode_gid(struct udev_device *udev_device);
  28 int udev_device_rename(struct udev_device *udev_device, const char *new_name);
  29 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
  30 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
  31 int udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
  32 char **udev_device_get_properties_envp(struct udev_device *udev_device);
  33 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
  34 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
  35 const char *udev_device_get_id_filename(struct udev_device *udev_device);
  36 void udev_device_set_is_initialized(struct udev_device *udev_device);
  37 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
  38 void udev_device_remove_tag(struct udev_device *udev_device, const char *tag);
  39 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
  40 void udev_device_ensure_usec_initialized(struct udev_device *udev_device, struct udev_device *old_device);
  41 int udev_device_get_devlink_priority(struct udev_device *udev_device);
  42 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
  43 int udev_device_get_watch_handle(struct udev_device *udev_device);
  44 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
  45 int udev_device_get_ifindex(struct udev_device *udev_device);
  46 void udev_device_set_info_loaded(struct udev_device *device);
  47 void udev_device_set_db_persist(struct udev_device *udev_device);
  48 void udev_device_read_db(struct udev_device *udev_device);
  49 int udev_device_update_db(struct udev_device *udev_device);
  50 int udev_device_delete_db(struct udev_device *udev_device);
  51 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
  52
  53 /* libudev-monitor.c - netlink/unix socket communication  */
  54 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
  55 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
  56 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
  57                              struct udev_monitor *destination, struct udev_device *udev_device);
  58 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
  59 int udev_monitor_receive_sd_device(struct udev_monitor *udev_monitor, sd_device **ret);
  60
  61 /* libudev-list.c */
  62 struct udev_list_node {
  63         struct udev_list_node *next, *prev;
  64 };
  65 struct udev_list {
  66         struct udev *udev;
  67         struct udev_list_node node;
  68         struct udev_list_entry **entries;
  69         unsigned entries_cur;
  70         unsigned entries_max;
  71         bool unique;
  72 };
  73 void udev_list_node_init(struct udev_list_node *list);
  74 int udev_list_node_is_empty(struct udev_list_node *list);
  75 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
  76 void udev_list_node_remove(struct udev_list_node *entry);
  77 #define udev_list_node_foreach(node, list) \
  78         for (node = (list)->next; \
  79              node != list; \
  80              node = (node)->next)
  81 #define udev_list_node_foreach_safe(node, tmp, list) \
  82         for (node = (list)->next, tmp = (node)->next; \
  83              node != list; \
  84              node = tmp, tmp = (tmp)->next)
  85 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
  86 void udev_list_cleanup(struct udev_list *list);
  87 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
  88 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
  89 void udev_list_entry_delete(struct udev_list_entry *entry);
  90 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
  91 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
  92 #define udev_list_entry_foreach_safe(entry, tmp, first) \
  93         for (entry = first, tmp = udev_list_entry_get_next(entry); \
  94              entry != NULL; \
  95              entry = tmp, tmp = udev_list_entry_get_next(tmp))
  96
  97 /* libudev-util.c */
  98 #define UTIL_PATH_SIZE                      1024
  99 #define UTIL_NAME_SIZE                       512
 100 #define UTIL_LINE_SIZE                     16384
 101 #define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
 102 size_t util_path_encode(const char *src, char *dest, size_t size);
 103 int util_replace_whitespace(const char *str, char *to, size_t len);
 104 int util_replace_chars(char *str, const char *white);
 105 uint32_t util_string_hash32(const char *key);
 106 uint64_t util_string_bloom64(const char *str);
 107 int util_resolve_subsys_kernel(const char *string, char *result, size_t maxsize, int read_value);
 108
 109 /* Cleanup functions */
 110 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev*, udev_unref);
 111 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_device*, udev_device_unref);
 112 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_enumerate*, udev_enumerate_unref);
 113 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_monitor*, udev_monitor_unref);
 114 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_hwdb*, udev_hwdb_unref);
 115 DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_queue*, udev_queue_unref);