src/libudev/libudev.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2008-2012 Kay Sievers <kay@vrfy.org>
   6 ***/
   7
   8 #ifndef _LIBUDEV_H_
   9 #define _LIBUDEV_H_
  10
  11 #include <stdarg.h>
  12 #include <sys/sysmacros.h>
  13 #include <sys/types.h>
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /*
  20  * udev - library context
  21  *
  22  * reads the udev config and system environment
  23  * allows custom logging
  24  */
  25 struct udev;
  26 struct udev *udev_ref(struct udev *udev);
  27 struct udev *udev_unref(struct udev *udev);
  28 struct udev *udev_new(void);
  29 void udev_set_log_fn(struct udev *udev,
  30                             void (*log_fn)(struct udev *udev,
  31                                            int priority, const char *file, int line, const char *fn,
  32                                            const char *format, va_list args)) __attribute__ ((deprecated));
  33 int udev_get_log_priority(struct udev *udev) __attribute__ ((deprecated));
  34 void udev_set_log_priority(struct udev *udev, int priority) __attribute__ ((deprecated));
  35 void *udev_get_userdata(struct udev *udev);
  36 void udev_set_userdata(struct udev *udev, void *userdata);
  37
  38 /*
  39  * udev_list
  40  *
  41  * access to libudev generated lists
  42  */
  43 struct udev_list_entry;
  44 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry);
  45 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name);
  46 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry);
  47 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry);
  48 /**
  49  * udev_list_entry_foreach:
  50  * @list_entry: entry to store the current position
  51  * @first_entry: first entry to start with
  52  *
  53  * Helper to iterate over all entries of a list.
  54  */
  55 #define udev_list_entry_foreach(list_entry, first_entry) \
  56         for (list_entry = first_entry; \
  57              list_entry != NULL; \
  58              list_entry = udev_list_entry_get_next(list_entry))
  59
  60 /*
  61  * udev_device
  62  *
  63  * access to sysfs/kernel devices
  64  */
  65 struct udev_device;
  66 struct udev_device *udev_device_ref(struct udev_device *udev_device);
  67 struct udev_device *udev_device_unref(struct udev_device *udev_device);
  68 struct udev *udev_device_get_udev(struct udev_device *udev_device);
  69 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
  70 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
  71 struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname);
  72 struct udev_device *udev_device_new_from_device_id(struct udev *udev, const char *id);
  73 struct udev_device *udev_device_new_from_environment(struct udev *udev);
  74 /* udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the parent */
  75 struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
  76 struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device,
  77                                                                   const char *subsystem, const char *devtype);
  78 /* retrieve device properties */
  79 const char *udev_device_get_devpath(struct udev_device *udev_device);
  80 const char *udev_device_get_subsystem(struct udev_device *udev_device);
  81 const char *udev_device_get_devtype(struct udev_device *udev_device);
  82 const char *udev_device_get_syspath(struct udev_device *udev_device);
  83 const char *udev_device_get_sysname(struct udev_device *udev_device);
  84 const char *udev_device_get_sysnum(struct udev_device *udev_device);
  85 const char *udev_device_get_devnode(struct udev_device *udev_device);
  86 int udev_device_get_is_initialized(struct udev_device *udev_device);
  87 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
  88 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
  89 struct udev_list_entry *udev_device_get_tags_list_entry(struct udev_device *udev_device);
  90 struct udev_list_entry *udev_device_get_sysattr_list_entry(struct udev_device *udev_device);
  91 const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key);
  92 const char *udev_device_get_driver(struct udev_device *udev_device);
  93 dev_t udev_device_get_devnum(struct udev_device *udev_device);
  94 const char *udev_device_get_action(struct udev_device *udev_device);
  95 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
  96 unsigned long long int udev_device_get_usec_since_initialized(struct udev_device *udev_device);
  97 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr);
  98 int udev_device_set_sysattr_value(struct udev_device *udev_device, const char *sysattr, char *value);
  99 int udev_device_has_tag(struct udev_device *udev_device, const char *tag);
 100
 101 /*
 102  * udev_monitor
 103  *
 104  * access to kernel uevents and udev events
 105  */
 106 struct udev_monitor;
 107 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
 108 struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor);
 109 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
 110 /* kernel and udev generated events over netlink */
 111 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name);
 112 /* bind socket */
 113 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
 114 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size);
 115 int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
 116 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
 117 /* in-kernel socket filters to select messages that get delivered to a listener */
 118 int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor,
 119                                                     const char *subsystem, const char *devtype);
 120 int udev_monitor_filter_add_match_tag(struct udev_monitor *udev_monitor, const char *tag);
 121 int udev_monitor_filter_update(struct udev_monitor *udev_monitor);
 122 int udev_monitor_filter_remove(struct udev_monitor *udev_monitor);
 123
 124 /*
 125  * udev_enumerate
 126  *
 127  * search sysfs for specific devices and provide a sorted list
 128  */
 129 struct udev_enumerate;
 130 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
 131 struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
 132 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate);
 133 struct udev_enumerate *udev_enumerate_new(struct udev *udev);
 134 /* device properties filter */
 135 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
 136 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
 137 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 138 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 139 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value);
 140 int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname);
 141 int udev_enumerate_add_match_tag(struct udev_enumerate *udev_enumerate, const char *tag);
 142 int udev_enumerate_add_match_parent(struct udev_enumerate *udev_enumerate, struct udev_device *parent);
 143 int udev_enumerate_add_match_is_initialized(struct udev_enumerate *udev_enumerate);
 144 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
 145 /* run enumeration with active filters */
 146 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
 147 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
 148 /* return device list */
 149 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
 150
 151 /*
 152  * udev_queue
 153  *
 154  * access to the currently running udev events
 155  */
 156 struct udev_queue;
 157 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
 158 struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue);
 159 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
 160 struct udev_queue *udev_queue_new(struct udev *udev);
 161 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue) __attribute__ ((deprecated));
 162 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue) __attribute__ ((deprecated));
 163 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue);
 164 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
 165 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum) __attribute__ ((deprecated));
 166 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
 167                                                unsigned long long int start, unsigned long long int end) __attribute__ ((deprecated));
 168 int udev_queue_get_fd(struct udev_queue *udev_queue);
 169 int udev_queue_flush(struct udev_queue *udev_queue);
 170 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue) __attribute__ ((deprecated));
 171
 172 /*
 173  *  udev_hwdb
 174  *
 175  *  access to the static hardware properties database
 176  */
 177 struct udev_hwdb;
 178 struct udev_hwdb *udev_hwdb_new(struct udev *udev);
 179 struct udev_hwdb *udev_hwdb_ref(struct udev_hwdb *hwdb);
 180 struct udev_hwdb *udev_hwdb_unref(struct udev_hwdb *hwdb);
 181 struct udev_list_entry *udev_hwdb_get_properties_list_entry(struct udev_hwdb *hwdb, const char *modalias, unsigned int flags);
 182
 183 /*
 184  * udev_util
 185  *
 186  * udev specific utilities
 187  */
 188 int udev_util_encode_string(const char *str, char *str_enc, size_t len);
 189
 190
 191 #ifdef __cplusplus
 192 } /* extern "C" */
 193 #endif
 194
 195 #endif