src/libudev.h

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