src/libudev/libudev-private.h

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