Systemd/src/udev/udev.h

/* SPDX-License-Identifier: GPL-2.0+ */
#pragma once

/*
 * Copyright © 2003 Greg Kroah-Hartman <greg@kroah.com>
 */

#include <sys/param.h>
#include <sys/sysmacros.h>
#include <sys/types.h>

#include "libudev.h"
#include "sd-device.h"
#include "sd-netlink.h"

#include "hashmap.h"
#include "label.h"
#include "libudev-private.h"
#include "macro.h"
#include "strv.h"
#include "util.h"

struct udev_event {
        struct udev_device *dev;
        sd_device *dev_parent;
        sd_device *dev_db_clone;
        char *name;
        char *program_result;
        mode_t mode;
        uid_t uid;
        gid_t gid;
        Hashmap *seclabel_list;
        Hashmap *run_list;
        int exec_delay;
        usec_t birth_usec;
        sd_netlink *rtnl;
        unsigned builtin_run;
        unsigned builtin_ret;
        bool inotify_watch;
        bool inotify_watch_final;
        bool group_set;
        bool group_final;
        bool owner_set;
        bool owner_final;
        bool mode_set;
        bool mode_final;
        bool name_final;
        bool devlink_final;
        bool run_final;
};

/* udev-rules.c */
struct udev_rules;
struct udev_rules *udev_rules_new(int resolve_names);
struct udev_rules *udev_rules_unref(struct udev_rules *rules);
bool udev_rules_check_timestamp(struct udev_rules *rules);
int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event,
                              usec_t timeout_usec, usec_t timeout_warn_usec,
                              Hashmap *properties_list);
int udev_rules_apply_static_dev_perms(struct udev_rules *rules);

/* udev-event.c */
struct udev_event *udev_event_new(struct udev_device *dev, int exec_delay, sd_netlink *rtnl);
struct udev_event *udev_event_free(struct udev_event *event);
ssize_t udev_event_apply_format(struct udev_event *event,
                                const char *src, char *dest, size_t size,
                                bool replace_whitespace);
int udev_event_spawn(struct udev_event *event,
                     usec_t timeout_usec,
                     usec_t timeout_warn_usec,
                     bool accept_failure,
                     const char *cmd, char *result, size_t ressize);
int udev_event_execute_rules(struct udev_event *event,
                             usec_t timeout_usec, usec_t timeout_warn_usec,
                             Hashmap *properties_list,
                             struct udev_rules *rules);
void udev_event_execute_run(struct udev_event *event, usec_t timeout_usec, usec_t timeout_warn_usec);

/* Cleanup functions */
DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_event*, udev_event_free);
DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_rules*, udev_rules_unref);
Add SPDX license identifiers to source files under the GPL 2017-11-18 17:14:42 +01:00			`/* SPDX-License-Identifier: GPL-2.0+ */`
tree-wide: place #pragma once at the same place everywhere Usually, we place the #pragma once before the copyright blurb in header files, but in a few cases we didn't. Move those around, so that we do the same thing everywhere. 2016-02-16 20:05:15 +01:00			`#pragma once`

added initial files. 2005-04-27 05:59:47 +02:00			`/*`
tree-wide: use proper unicode © instead of (C) where we can Let's use a proper unicode copyright symbol where we can, it's prettier. This important patch is very important. 2018-06-12 17:15:23 +02:00			`* Copyright © 2003 Greg Kroah-Hartman <greg@kroah.com>`
added initial files. 2005-04-27 05:59:47 +02:00			`*/`

[PATCH] Build failure - missing linux/limits.h include? On Tuesday 25 November 2003 00:12, Chris Larson wrote: > udev fails to compile here unless I'm doing a KLIBC build. �The reason > appears to be that the normal limits.h in the gcc inc dir doesn't pull > in linux/limits.h, whereas the limits.h out in the klibc include dirs > does. �I'd think it'd be best to add a #include <linux/limits.h> to > udev.h directly, since it uses PATH_MAX. No, don't include kernel headers directly if you can avoid it. The problem you are referring to seems to be with old tool chains, I have the same symptom with my s390 gcc-2.95/glibc-2.1.3. Including <sys/param.h> instead of <limits.h> seems to fix it. 2003-12-02 09:26:46 +01:00			`#include <sys/param.h>`
include sys/sysmacros.h in more places Since glibc is moving away from implicitly including sys/sysmacros.h all the time via sys/types.h, include the header directly in more places. This seems to cover most makedev/major/minor usage. 2016-03-14 22:44:49 +01:00			`#include <sys/sysmacros.h>`
util-lib: split our string related calls from util.[ch] into its own file string-util.[ch] There are more than enough calls doing string manipulations to deserve its own files, hence do something about it. This patch also sorts the #include blocks of all files that needed to be updated, according to the sorting suggestions from CODING_STYLE. Since pretty much every file needs our string manipulation functions this effectively means that most files have sorted #include blocks now. Also touches a few unrelated include files. 2015-10-24 22:58:24 +02:00			`#include <sys/types.h>`
replace libsysfs We never used any of the libsysfs convenience features. Here we replace it completely with 300 lines of code, which are much simpler and a bit faster cause udev(d) does not open any syfs file for a simple event which does not need any parent device information. Signed-off-by: Kay Sievers <kay.sievers@suse.de> 2006-01-09 21:18:00 +01:00
libudev: move to top-level directory 2009-06-08 21:36:06 +02:00			`#include "libudev.h"`
udev-watch: replace udev_device by sd_device and modernize code a bit 2018-09-14 21:13:29 +02:00			`#include "sd-device.h"`
util-lib: split our string related calls from util.[ch] into its own file string-util.[ch] There are more than enough calls doing string manipulations to deserve its own files, hence do something about it. This patch also sorts the #include blocks of all files that needed to be updated, according to the sorting suggestions from CODING_STYLE. Since pretty much every file needs our string manipulation functions this effectively means that most files have sorted #include blocks now. Also touches a few unrelated include files. 2015-10-24 22:58:24 +02:00			`#include "sd-netlink.h"`

udev: use Hashmap for storing SECLABEL 2018-10-16 22:37:34 +02:00			`#include "hashmap.h"`
selinux: unify systemd and udev code 2012-04-17 16:05:03 +02:00			`#include "label.h"`
util-lib: split our string related calls from util.[ch] into its own file string-util.[ch] There are more than enough calls doing string manipulations to deserve its own files, hence do something about it. This patch also sorts the #include blocks of all files that needed to be updated, according to the sorting suggestions from CODING_STYLE. Since pretty much every file needs our string manipulation functions this effectively means that most files have sorted #include blocks now. Also touches a few unrelated include files. 2015-10-24 22:58:24 +02:00			`#include "libudev-private.h"`
			`#include "macro.h"`
udev: use conf_files_list() to search rules files 2012-05-07 13:21:05 +02:00			`#include "strv.h"`
util-lib: split our string related calls from util.[ch] into its own file string-util.[ch] There are more than enough calls doing string manipulations to deserve its own files, hence do something about it. This patch also sorts the #include blocks of all files that needed to be updated, according to the sorting suggestions from CODING_STYLE. Since pretty much every file needs our string manipulation functions this effectively means that most files have sorted #include blocks now. Also touches a few unrelated include files. 2015-10-24 22:58:24 +02:00			`#include "util.h"`
added initial files. 2005-04-27 05:59:47 +02:00
udevd: use libudev 2008-10-16 17:16:58 +02:00			`struct udev_event {`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`struct udev_device *dev;`
udev: use sd_device for udev_event.dev_parent 2018-10-29 07:16:00 +01:00			`sd_device *dev_parent;`
udev: use sd_device for udev_event.dev_db Also, this adds sd_device_unref for the object in udev_event_free() for safety and readability of code. 2018-10-29 07:01:39 +01:00			`sd_device *dev_db_clone;`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`char *name;`
			`char *program_result;`
			`mode_t mode;`
			`uid_t uid;`
			`gid_t gid;`
udev: use Hashmap for storing SECLABEL 2018-10-16 22:37:34 +02:00			`Hashmap *seclabel_list;`
udev: use Hashmap for storing PROGRAM or BUILTIN 2018-10-16 23:11:33 +02:00			`Hashmap *run_list;`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`int exec_delay;`
udev: use usec_t and now() 2012-11-11 20:45:05 +01:00			`usec_t birth_usec;`
sd-netlink: rename from sd-rtnl 2015-06-12 16:31:33 +02:00			`sd_netlink *rtnl;`
tree-wide: replace 'unsigned int' with 'unsigned' 2018-10-19 20:00:46 +02:00			`unsigned builtin_run;`
			`unsigned builtin_ret;`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`bool inotify_watch;`
			`bool inotify_watch_final;`
udev: in addition to DEVMODE, honor DEVUID, DEVGID from the uevent 2012-12-31 04:48:44 +01:00			`bool group_set;`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`bool group_final;`
udev: in addition to DEVMODE, honor DEVUID, DEVGID from the uevent 2012-12-31 04:48:44 +01:00			`bool owner_set;`
tabs are as useful as a hole in the head 2012-01-10 01:34:15 +01:00			`bool owner_final;`
			`bool mode_set;`
			`bool mode_final;`
			`bool name_final;`
			`bool devlink_final;`
			`bool run_final;`
udevd: use libudev 2008-10-16 17:16:58 +02:00			`};`

merge udev-rules.c and udev-rules-parse.c 2008-10-18 14:33:37 +02:00			`/* udev-rules.c */`
move udev_rules_apply_format() to udev-event.c 2008-10-18 19:19:56 +02:00			`struct udev_rules;`
udev: drop unused udev struct 2018-08-22 12:57:32 +02:00			`struct udev_rules *udev_rules_new(int resolve_names);`
invalidate rules and kmod index with 'udevadm control --reload' - rename --reload-rules to --reload - invalidate rules and databases only, delay parsing to the next event - enable debug output for test-builtin 2011-12-25 16:37:15 +01:00			`struct udev_rules udev_rules_unref(struct udev_rules rules);`
udev: remove configuration options for /dev, /sys, /run directories 2012-04-16 17:21:22 +02:00			`bool udev_rules_check_timestamp(struct udev_rules *rules);`
udev: use Hashmap for storing SECLABEL 2018-10-16 22:37:34 +02:00			`int udev_rules_apply_to_event(struct udev_rules rules, struct udev_event event,`
			`usec_t timeout_usec, usec_t timeout_warn_usec,`
udev: use Hashmap for storing global properties 2018-10-16 23:47:16 +02:00			`Hashmap *properties_list);`
udev: export tags of "dead" device nodes to /run/udev/static_node-tags/ Based on a patch by Kay Sievers. A tag is exported at boot as a symlinks to the device node in the folder /run/udev/static_node-tags/<tagname>/, if the device node exists. These tags are cleaned up by udevadm info --cleanup-db, but are otherwise never removed. 2013-07-07 18:32:34 +02:00			`int udev_rules_apply_static_dev_perms(struct udev_rules *rules);`
move udev_rules_apply_format() to udev-event.c 2008-10-18 19:19:56 +02:00
			`/* udev-event.c */`
udev-event: make udev_event_new() take sd_netlink and take a reference of that 2018-11-01 14:19:31 +01:00			`struct udev_event udev_event_new(struct udev_device dev, int exec_delay, sd_netlink *rtnl);`
udev-event: rename udev_event_unref() to udev_event_free() As struct udev_event does not have a reference counter. 2018-10-25 00:04:59 +02:00			`struct udev_event udev_event_free(struct udev_event event);`
udev-event: replace udev_device in subst_format_var() by sd_device 2018-10-25 06:59:03 +02:00			`ssize_t udev_event_apply_format(struct udev_event *event,`
			`const char src, char dest, size_t size,`
			`bool replace_whitespace);`
timeout handling without alarm() 2011-04-20 01:53:03 +02:00			`int udev_event_spawn(struct udev_event *event,`
udev: unify event timeout handling 2014-07-29 15:18:27 +02:00			`usec_t timeout_usec,`
udev: timeout - warn after a third of the timeout before killing 2014-09-11 18:49:04 +02:00			`usec_t timeout_warn_usec,`
udevd: event - don't log about failures of spawn processes when this is expected PROGRAM and IMPORT{program} uses the exit code of the spawn process to decide if a rule matches or not, a failing process is hence normal operation and not something we should warn about. We still warn about other types of failing processes. 2015-06-10 15:20:02 +02:00			`bool accept_failure,`
udev: event - simplify udev_event_spawn() logic Push the extraction of the envp + argv as close as possible to their use, to avoid code duplication. As a sideeffect fix logging when delaing execution. 2015-06-28 23:42:52 +02:00			`const char cmd, char result, size_t ressize);`
udev-event: replace udev_device in udev_event_execute_rules() by sd_device Also, this adds many logs. 2018-10-25 04:14:11 +02:00			`int udev_event_execute_rules(struct udev_event *event,`
			`usec_t timeout_usec, usec_t timeout_warn_usec,`
			`Hashmap *properties_list,`
			`struct udev_rules *rules);`
udevd: simplify signal mask handling We used to block all signals, and restore the original signal mask before exec'ing external processes. Now we just block the signals we care about and unconditionally unblock all signals before exec'ing. 2015-06-02 17:07:21 +02:00			`void udev_event_execute_run(struct udev_event *event, usec_t timeout_usec, usec_t timeout_warn_usec);`
merge udev-rules.c and udev-rules-parse.c 2008-10-18 14:33:37 +02:00
udev: move udev cleanup functions from udev-util.h to udev.h 2018-08-22 09:25:17 +02:00			`/* Cleanup functions */`
udev-event: rename udev_event_unref() to udev_event_free() As struct udev_event does not have a reference counter. 2018-10-25 00:04:59 +02:00			`DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_event*, udev_event_free);`
udev: move udev cleanup functions from udev-util.h to udev.h 2018-08-22 09:25:17 +02:00			`DEFINE_TRIVIAL_CLEANUP_FUNC(struct udev_rules*, udev_rules_unref);`