[thirdparty/systemd.git] / src / libudev / libudev-private.h

/*
 * libudev - interface to udev device information
 *
 * Copyright (C) 2008-2012 Kay Sievers <kay.sievers@vrfy.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 */

#ifndef _LIBUDEV_PRIVATE_H_
#define _LIBUDEV_PRIVATE_H_

#include <syslog.h>
#include <signal.h>
#include <stdint.h>
#include <stdbool.h>

#include "libudev.h"
#include "macro.h"
#include "util.h"
#include "mkdir.h"

#define READ_END  0
#define WRITE_END 1

/* avoid (sometimes expensive) calculations of parameters for debug output */
#define udev_log_cond(udev, prio, arg...) \
  do { \
    if (udev_get_log_priority(udev) >= prio) \
      udev_log(udev, prio, __FILE__, __LINE__, __FUNCTION__, ## arg); \
  } while (0)

#define udev_dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
#define udev_info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
#define udev_err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)

/* libudev.c */
void udev_log(struct udev *udev,
              int priority, const char *file, int line, const char *fn,
              const char *format, ...)
              __attribute__((format(printf, 6, 7)));
int udev_get_rules_path(struct udev *udev, char **path[], unsigned long long *ts_usec[]);
struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);

/* libudev-device.c */
struct udev_device *udev_device_new(struct udev *udev);
mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
char **udev_device_get_properties_envp(struct udev_device *udev_device);
ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
int udev_device_read_db(struct udev_device *udev_device, const char *dbfile);
int udev_device_read_uevent_file(struct udev_device *udev_device);
int udev_device_set_action(struct udev_device *udev_device, const char *action);
const char *udev_device_get_devpath_old(struct udev_device *udev_device);
const char *udev_device_get_id_filename(struct udev_device *udev_device);
void udev_device_set_is_initialized(struct udev_device *udev_device);
int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
void udev_device_cleanup_tags_list(struct udev_device *udev_device);
unsigned long long udev_device_get_usec_initialized(struct udev_device *udev_device);
void udev_device_set_usec_initialized(struct udev_device *udev_device, unsigned long long usec_initialized);
int udev_device_get_devlink_priority(struct udev_device *udev_device);
int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
int udev_device_get_watch_handle(struct udev_device *udev_device);
int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
int udev_device_get_ifindex(struct udev_device *udev_device);
void udev_device_set_info_loaded(struct udev_device *device);
bool udev_device_get_db_persist(struct udev_device *udev_device);
void udev_device_set_db_persist(struct udev_device *udev_device);

/* libudev-device-private.c */
int udev_device_update_db(struct udev_device *udev_device);
int udev_device_delete_db(struct udev_device *udev_device);
int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);

/* libudev-monitor.c - netlink/unix socket communication  */
int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
int udev_monitor_send_device(struct udev_monitor *udev_monitor,
                             struct udev_monitor *destination, struct udev_device *udev_device);
struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);

/* libudev-list.c */
struct udev_list_node {
        struct udev_list_node *next, *prev;
};
struct udev_list {
        struct udev *udev;
        struct udev_list_node node;
        struct udev_list_entry **entries;
        unsigned int entries_cur;
        unsigned int entries_max;
        bool unique;
};
#define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
void udev_list_node_init(struct udev_list_node *list);
int udev_list_node_is_empty(struct udev_list_node *list);
void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
void udev_list_node_remove(struct udev_list_node *entry);
#define udev_list_node_foreach(node, list) \
        for (node = (list)->next; \
             node != list; \
             node = (node)->next)
#define udev_list_node_foreach_safe(node, tmp, list) \
        for (node = (list)->next, tmp = (node)->next; \
             node != list; \
             node = tmp, tmp = (tmp)->next)
void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
void udev_list_cleanup(struct udev_list *list);
struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
void udev_list_entry_delete(struct udev_list_entry *entry);
void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
void udev_list_entry_append(struct udev_list_entry *new, struct udev_list *list);
int udev_list_entry_get_num(struct udev_list_entry *list_entry);
void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
#define udev_list_entry_foreach_safe(entry, tmp, first) \
        for (entry = first, tmp = udev_list_entry_get_next(entry); \
             entry != NULL; \
             entry = tmp, tmp = udev_list_entry_get_next(tmp))

/* libudev-queue.c */
unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
ssize_t udev_queue_skip_devpath(FILE *queue_file);

/* libudev-queue-private.c */
struct udev_queue_export *udev_queue_export_new(struct udev *udev);
struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);

/* libudev-hwdb.c */
bool udev_hwdb_validate(struct udev_hwdb *hwdb);

/* libudev-util.c */
#define UTIL_PATH_SIZE                      1024
#define UTIL_NAME_SIZE                       512
#define UTIL_LINE_SIZE                     16384
#define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
int util_log_priority(const char *priority);
size_t util_path_encode(const char *src, char *dest, size_t size);
void util_remove_trailing_chars(char *path, char c);
size_t util_strpcpy(char **dest, size_t size, const char *src);
size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
size_t util_strscpy(char *dest, size_t size, const char *src);
size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
int util_replace_whitespace(const char *str, char *to, size_t len);
int util_replace_chars(char *str, const char *white);
unsigned int util_string_hash32(const char *key);
uint64_t util_string_bloom64(const char *str);

/* libudev-util-private.c */
int util_delete_path(struct udev *udev, const char *path);
uid_t util_lookup_user(struct udev *udev, const char *user);
gid_t util_lookup_group(struct udev *udev, const char *group);
int util_resolve_subsys_kernel(struct udev *udev, const char *string, char *result, size_t maxsize, int read_value);
unsigned long long ts_usec(const struct timespec *ts);
unsigned long long now_usec(void);
ssize_t print_kmsg(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
#endif
Commit	Line	Data
	1	/*
	2	* libudev - interface to udev device information
	3	*
	4	* Copyright (C) 2008-2012 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_PRIVATE_H_
	13	#define _LIBUDEV_PRIVATE_H_
	14
	15	#include <syslog.h>
	16	#include <signal.h>
	17	#include <stdint.h>
	18	#include <stdbool.h>
	19
	20	#include "libudev.h"
	21	#include "macro.h"
	22	#include "util.h"
	23	#include "mkdir.h"
	24
	25	#define READ_END 0
	26	#define WRITE_END 1
	27
	28	/* avoid (sometimes expensive) calculations of parameters for debug output */
	29	#define udev_log_cond(udev, prio, arg...) \
	30	do { \
	31	if (udev_get_log_priority(udev) >= prio) \
	32	udev_log(udev, prio, __FILE__, __LINE__, __FUNCTION__, ## arg); \
	33	} while (0)
	34
	35	#define udev_dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
	36	#define udev_info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
	37	#define udev_err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
	38
	39	/* libudev.c */
	40	void udev_log(struct udev *udev,
	41	int priority, const char file, int line, const char fn,
	42	const char *format, ...)
	43	__attribute__((format(printf, 6, 7)));
	44	int udev_get_rules_path(struct udev udev, char path[], unsigned long long ts_usec[]);
	45	struct udev_list_entry udev_add_property(struct udev udev, const char key, const char value);
	46	struct udev_list_entry udev_get_properties_list_entry(struct udev udev);
	47
	48	/* libudev-device.c */
	49	struct udev_device udev_device_new(struct udev udev);
	50	mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
	51	int udev_device_set_syspath(struct udev_device udev_device, const char syspath);
	52	int udev_device_set_devnode(struct udev_device udev_device, const char devnode);
	53	int udev_device_add_devlink(struct udev_device udev_device, const char devlink);
	54	void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
	55	struct udev_list_entry udev_device_add_property(struct udev_device udev_device, const char key, const char value);
	56	void udev_device_add_property_from_string_parse(struct udev_device udev_device, const char property);
	57	int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
	58	char *udev_device_get_properties_envp(struct udev_device udev_device);
	59	ssize_t udev_device_get_properties_monitor_buf(struct udev_device udev_device, const char *buf);
	60	int udev_device_read_db(struct udev_device udev_device, const char dbfile);
	61	int udev_device_read_uevent_file(struct udev_device *udev_device);
	62	int udev_device_set_action(struct udev_device udev_device, const char action);
	63	const char udev_device_get_devpath_old(struct udev_device udev_device);
	64	const char udev_device_get_id_filename(struct udev_device udev_device);
	65	void udev_device_set_is_initialized(struct udev_device *udev_device);
	66	int udev_device_add_tag(struct udev_device udev_device, const char tag);
	67	void udev_device_cleanup_tags_list(struct udev_device *udev_device);
	68	unsigned long long udev_device_get_usec_initialized(struct udev_device *udev_device);
	69	void udev_device_set_usec_initialized(struct udev_device *udev_device, unsigned long long usec_initialized);
	70	int udev_device_get_devlink_priority(struct udev_device *udev_device);
	71	int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
	72	int udev_device_get_watch_handle(struct udev_device *udev_device);
	73	int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
	74	int udev_device_get_ifindex(struct udev_device *udev_device);
	75	void udev_device_set_info_loaded(struct udev_device *device);
	76	bool udev_device_get_db_persist(struct udev_device *udev_device);
	77	void udev_device_set_db_persist(struct udev_device *udev_device);
	78
	79	/* libudev-device-private.c */
	80	int udev_device_update_db(struct udev_device *udev_device);
	81	int udev_device_delete_db(struct udev_device *udev_device);
	82	int udev_device_tag_index(struct udev_device dev, struct udev_device dev_old, bool add);
	83
	84	/* libudev-monitor.c - netlink/unix socket communication */
	85	int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
	86	int udev_monitor_allow_unicast_sender(struct udev_monitor udev_monitor, struct udev_monitor sender);
	87	int udev_monitor_send_device(struct udev_monitor *udev_monitor,
	88	struct udev_monitor destination, struct udev_device udev_device);
	89	struct udev_monitor udev_monitor_new_from_netlink_fd(struct udev udev, const char *name, int fd);
	90
	91	/* libudev-list.c */
	92	struct udev_list_node {
	93	struct udev_list_node next, prev;
	94	};
	95	struct udev_list {
	96	struct udev *udev;
	97	struct udev_list_node node;
	98	struct udev_list_entry **entries;
	99	unsigned int entries_cur;
	100	unsigned int entries_max;
	101	bool unique;
	102	};
	103	#define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
	104	void udev_list_node_init(struct udev_list_node *list);
	105	int udev_list_node_is_empty(struct udev_list_node *list);
	106	void udev_list_node_append(struct udev_list_node new, struct udev_list_node list);
	107	void udev_list_node_remove(struct udev_list_node *entry);
	108	#define udev_list_node_foreach(node, list) \
	109	for (node = (list)->next; \
	110	node != list; \
	111	node = (node)->next)
	112	#define udev_list_node_foreach_safe(node, tmp, list) \
	113	for (node = (list)->next, tmp = (node)->next; \
	114	node != list; \
	115	node = tmp, tmp = (tmp)->next)
	116	void udev_list_init(struct udev udev, struct udev_list list, bool unique);
	117	void udev_list_cleanup(struct udev_list *list);
	118	struct udev_list_entry udev_list_get_entry(struct udev_list list);
	119	struct udev_list_entry udev_list_entry_add(struct udev_list list, const char name, const char value);
	120	void udev_list_entry_delete(struct udev_list_entry *entry);
	121	void udev_list_entry_insert_before(struct udev_list_entry new, struct udev_list_entry entry);
	122	void udev_list_entry_append(struct udev_list_entry new, struct udev_list list);
	123	int udev_list_entry_get_num(struct udev_list_entry *list_entry);
	124	void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
	125	#define udev_list_entry_foreach_safe(entry, tmp, first) \
	126	for (entry = first, tmp = udev_list_entry_get_next(entry); \
	127	entry != NULL; \
	128	entry = tmp, tmp = udev_list_entry_get_next(tmp))
	129
	130	/* libudev-queue.c */
	131	unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
	132	int udev_queue_read_seqnum(FILE queue_file, unsigned long long int seqnum);
	133	ssize_t udev_queue_read_devpath(FILE queue_file, char devpath, size_t size);
	134	ssize_t udev_queue_skip_devpath(FILE *queue_file);
	135
	136	/* libudev-queue-private.c */
	137	struct udev_queue_export udev_queue_export_new(struct udev udev);
	138	struct udev_queue_export udev_queue_export_unref(struct udev_queue_export udev_queue_export);
	139	void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
	140	int udev_queue_export_device_queued(struct udev_queue_export udev_queue_export, struct udev_device udev_device);
	141	int udev_queue_export_device_finished(struct udev_queue_export udev_queue_export, struct udev_device udev_device);
	142
	143	/* libudev-hwdb.c */
	144	bool udev_hwdb_validate(struct udev_hwdb *hwdb);
	145
	146	/* libudev-util.c */
	147	#define UTIL_PATH_SIZE 1024
	148	#define UTIL_NAME_SIZE 512
	149	#define UTIL_LINE_SIZE 16384
	150	#define UDEV_ALLOWED_CHARS_INPUT "/ $%?,"
	151	ssize_t util_get_sys_core_link_value(struct udev udev, const char slink, const char syspath, char value, size_t size);
	152	int util_resolve_sys_link(struct udev udev, char syspath, size_t size);
	153	int util_log_priority(const char *priority);
	154	size_t util_path_encode(const char src, char dest, size_t size);
	155	void util_remove_trailing_chars(char *path, char c);
	156	size_t util_strpcpy(char *dest, size_t size, const char src);
	157	size_t util_strpcpyl(char *dest, size_t size, const char src, ...) __attribute__((sentinel));
	158	size_t util_strscpy(char dest, size_t size, const char src);
	159	size_t util_strscpyl(char dest, size_t size, const char src, ...) __attribute__((sentinel));
	160	int util_replace_whitespace(const char str, char to, size_t len);
	161	int util_replace_chars(char str, const char white);
	162	unsigned int util_string_hash32(const char *key);
	163	uint64_t util_string_bloom64(const char *str);
	164
	165	/* libudev-util-private.c */
	166	int util_delete_path(struct udev udev, const char path);
	167	uid_t util_lookup_user(struct udev udev, const char user);
	168	gid_t util_lookup_group(struct udev udev, const char group);
	169	int util_resolve_subsys_kernel(struct udev udev, const char string, char *result, size_t maxsize, int read_value);
	170	unsigned long long ts_usec(const struct timespec *ts);
	171	unsigned long long now_usec(void);
	172	ssize_t print_kmsg(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
	173	#endif