1 /* 2 * Copyright (c) 2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #pragma once 17 18 #include <stdarg.h> 19 #include <sys/sysmacros.h> 20 #include <sys/types.h> 21 #include <sys/stat.h> 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /** 28 * udev - library context 29 * 30 * reads the udev config and system environment 31 * allows custom logging 32 */ 33 struct udev; 34 struct udev *udev_ref(struct udev *udev); 35 struct udev *udev_unref(struct udev *udev); 36 struct udev *udev_new(void); 37 void udev_set_log_fn(struct udev *udev, void (*log_fn)(struct udev *udev, int priority, const char *file, int line, 38 const char *fn, const char *format, va_list args)) 39 __attribute__((deprecated)); 40 int udev_get_log_priority(struct udev *udev) __attribute__((deprecated)); 41 void udev_set_log_priority(struct udev *udev, int priority) __attribute__((deprecated)); 42 void *udev_get_userdata(struct udev *udev); 43 void udev_set_userdata(struct udev *udev, void *userdata); 44 45 /** 46 * udev_list access to libudev generated lists 47 */ 48 struct udev_list_entry; 49 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry); 50 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name); 51 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry); 52 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry); 53 54 /** 55 * udev_list_entry_foreach: 56 * @list_entry: entry to store the current position 57 * @first_entry: first entry to start with 58 * 59 * Helper to iterate over all entries of a list. 60 */ 61 #define udev_list_entry_foreach(list_entry, first_entry) \ 62 for ((list_entry) = first_entry; (list_entry) != NULL; (list_entry) = udev_list_entry_get_next(list_entry)) 63 64 /** 65 * udev_device access to sysfs/kernel devices 66 */ 67 struct udev_device; 68 struct udev_device *udev_device_ref(struct udev_device *udev_device); 69 struct udev_device *udev_device_unref(struct udev_device *udev_device); 70 struct udev *udev_device_get_udev(struct udev_device *udev_device); 71 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath); 72 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum); 73 struct udev_device *udev_device_new_from_subsystem_sysname( 74 struct udev *udev, const char *subsystem, const char *sysname); 75 struct udev_device *udev_device_new_from_device_id(struct udev *udev, const char *id); 76 struct udev_device *udev_device_new_from_environment(struct udev *udev); 77 78 /** 79 * udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the 80 * parent 81 */ 82 struct udev_device *udev_device_get_parent(struct udev_device *udev_device); 83 struct udev_device *udev_device_get_parent_with_subsystem_devtype( 84 struct udev_device *udev_device, const char *subsystem, const char *devtype); 85 86 /* retrieve device properties */ 87 int udev_device_read_db(struct udev_device *udev_device); 88 const char *udev_device_get_devpath(struct udev_device *udev_device); 89 const char *udev_device_get_subsystem(struct udev_device *udev_device); 90 const char *udev_device_get_devtype(struct udev_device *udev_device); 91 const char *udev_device_get_syspath(struct udev_device *udev_device); 92 const char *udev_device_get_sysname(struct udev_device *udev_device); 93 const char *udev_device_get_sysnum(struct udev_device *udev_device); 94 const char *udev_device_get_devnode(struct udev_device *udev_device); 95 int udev_device_get_is_initialized(struct udev_device *udev_device); 96 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device); 97 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device); 98 struct udev_list_entry *udev_device_get_tags_list_entry(struct udev_device *udev_device); 99 struct udev_list_entry *udev_device_get_sysattr_list_entry(struct udev_device *udev_device); 100 const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key); 101 const char *udev_device_get_driver(struct udev_device *udev_device); 102 dev_t udev_device_get_devnum(struct udev_device *udev_device); 103 const char *udev_device_get_action(struct udev_device *udev_device); 104 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device); 105 unsigned long long int udev_device_get_usec_since_initialized(struct udev_device *udev_device); 106 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr); 107 int udev_device_set_sysattr_value(struct udev_device *udev_device, const char *sysattr, char *value); 108 int udev_device_has_tag(struct udev_device *udev_device, const char *tag); 109 110 /** 111 * udev_monitor access to kernel uevents and udev events 112 */ 113 struct udev_monitor; 114 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor); 115 struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor); 116 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor); 117 /* kernel and udev generated events over netlink */ 118 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name); 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( 126 struct udev_monitor *udev_monitor, 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 search sysfs for specific devices and provide a sorted list 133 */ 134 struct udev_enumerate; 135 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate); 136 struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerate); 137 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate); 138 struct udev_enumerate *udev_enumerate_new(struct udev *udev); 139 /* device properties filter */ 140 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); 141 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); 142 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); 143 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); 144 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value); 145 int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname); 146 int udev_enumerate_add_match_tag(struct udev_enumerate *udev_enumerate, const char *tag); 147 int udev_enumerate_add_match_parent(struct udev_enumerate *udev_enumerate, struct udev_device *parent); 148 int udev_enumerate_add_match_is_initialized(struct udev_enumerate *udev_enumerate); 149 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath); 150 /* run enumeration with active filters */ 151 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate); 152 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate); 153 /* return device list */ 154 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate); 155 156 /** 157 * udev_queue access to the currently running udev events 158 */ 159 struct udev_queue; 160 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue); 161 struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue); 162 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue); 163 struct udev_queue *udev_queue_new(struct udev *udev); 164 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue) __attribute__((deprecated)); 165 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue) __attribute__((deprecated)); 166 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue); 167 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue); 168 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum) 169 __attribute__((deprecated)); 170 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue, unsigned long long int start, 171 unsigned long long int end) __attribute__((deprecated)); 172 int udev_queue_get_fd(struct udev_queue *udev_queue); 173 int udev_queue_flush(struct udev_queue *udev_queue); 174 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue) __attribute__((deprecated)); 175 176 /** 177 * udev_hwdb access to the static hardware properties database 178 */ 179 struct udev_hwdb; 180 struct udev_hwdb *udev_hwdb_new(struct udev *udev); 181 struct udev_hwdb *udev_hwdb_ref(struct udev_hwdb *hwdb); 182 struct udev_hwdb *udev_hwdb_unref(struct udev_hwdb *hwdb); 183 struct udev_list_entry *udev_hwdb_get_properties_list_entry( 184 struct udev_hwdb *hwdb, const char *modalias, unsigned int flags); 185 186 /** 187 * udev_util udev specific utilities 188 */ 189 int udev_util_encode_string(const char *str, char *str_enc, size_t len); 190 191 #ifdef __cplusplus 192 } /* extern "C" */ 193 #endif