udev/udev.h

   1 /*
   2  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
   3  * Copyright (C) 2003-2008 Kay Sievers <kay.sievers@vrfy.org>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef _UDEV_H_
  20 #define _UDEV_H_
  21
  22 #include <sys/types.h>
  23 #include <sys/param.h>
  24
  25 #include "udev-sysdeps.h"
  26 #include "lib/libudev.h"
  27 #include "lib/libudev-private.h"
  28
  29 #define ALLOWED_CHARS                           "#+-.:=@_"
  30 #define ALLOWED_CHARS_FILE                      ALLOWED_CHARS "/"
  31 #define ALLOWED_CHARS_INPUT                     ALLOWED_CHARS_FILE " $%?,"
  32
  33 #define DEFAULT_FAKE_PARTITIONS_COUNT           15
  34 #define UDEV_EVENT_TIMEOUT                      180
  35
  36 /* linux/include/linux/kobject.h */
  37 #define UEVENT_BUFFER_SIZE                      2048
  38 #define UEVENT_NUM_ENVP                         32
  39
  40 #define UDEV_CTRL_SOCK_PATH                     "@" UDEV_PREFIX "/org/kernel/udev/udevd"
  41
  42 #define UDEV_MAX(a,b) ((a) > (b) ? (a) : (b))
  43 #define READ_END                                0
  44 #define WRITE_END                               1
  45
  46 static inline void logging_init(const char *program_name)
  47 {
  48         openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
  49 }
  50
  51 static inline void logging_msg(struct udev *udev, int priority,
  52                           const char *file, int line, const char *fn,
  53                           const char *format, va_list args)
  54 {
  55         vsyslog(priority, format, args);
  56 }
  57
  58 static inline void logging_close(void)
  59 {
  60         closelog();
  61 }
  62
  63 /* udev-event.c */
  64 struct udev_event {
  65         struct udev *udev;
  66         struct udev_device *dev;
  67         struct udev_device *dev_parent;
  68         int devlink_final;
  69         int owner_final;
  70         int group_final;
  71         int mode_final;
  72         char tmp_node[UTIL_PATH_SIZE];
  73         char program_result[UTIL_PATH_SIZE];
  74         int run_final;
  75
  76         char name[UTIL_PATH_SIZE];
  77         mode_t mode;
  78         char owner[UTIL_NAME_SIZE];
  79         char group[UTIL_NAME_SIZE];
  80         struct udev_list_node run_list;
  81         int ignore_device;
  82         int test;
  83
  84         struct udev_list_node node;
  85         pid_t pid;
  86         int exitstatus;
  87         time_t queue_time;
  88 };
  89 struct udev_rules;
  90 extern struct udev_event *udev_event_new(struct udev_device *dev);
  91 extern void udev_event_unref(struct udev_event *event);
  92 extern int udev_event_execute_rules(struct udev_event *event, struct udev_rules *rules);
  93
  94 /* udev-rules.c */
  95 extern struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names);
  96 extern void udev_rules_unref(struct udev_rules *rules);
  97 extern int udev_rules_get_name(struct udev_rules *rules, struct udev_event *event);
  98 extern int udev_rules_get_run(struct udev_rules *rules, struct udev_event *event);
  99 extern int udev_rules_run(struct udev_event *event);
 100 extern void udev_rules_apply_format(struct udev_event *event, char *string, size_t maxsize);
 101
 102 /* udev-node.c */
 103 extern int udev_node_mknod(struct udev_device *dev, const char *file, dev_t devnum, mode_t mode, uid_t uid, gid_t gid);
 104 extern int udev_node_add(struct udev_device *dev, mode_t mode, const char *owner, const char *group, int test);
 105 extern int udev_node_remove(struct udev_device *dev, int test);
 106 extern void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old, int test);
 107
 108 /* udev-util.c */
 109 extern int create_path(struct udev *udev, const char *path);
 110 extern int delete_path(struct udev *udev, const char *path);
 111 extern int unlink_secure(struct udev *udev, const char *filename);
 112 extern uid_t lookup_user(struct udev *udev, const char *user);
 113 extern gid_t lookup_group(struct udev *udev, const char *group);
 114 extern int run_program(struct udev *udev, const char *command, char **envp,
 115                        char *result, size_t ressize, size_t *reslen);
 116
 117 /* udev_utils_file.c */
 118 extern int file_map(const char *filename, char **buf, size_t *bufsize);
 119 extern void file_unmap(void *buf, size_t bufsize);
 120 extern size_t buf_get_line(const char *buf, size_t buflen, size_t cur);
 121
 122 /* udev-selinux.c */
 123 #ifndef USE_SELINUX
 124 static inline void selinux_init(struct udev *udev) {}
 125 static inline void selinux_exit(struct udev *udev) {}
 126 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
 127 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
 128 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
 129 #else
 130 extern void selinux_init(struct udev *udev);
 131 extern void selinux_exit(struct udev *udev);
 132 extern void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
 133 extern void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
 134 extern void udev_selinux_resetfscreatecon(struct udev *udev);
 135 #endif
 136
 137 /* udevadm commands */
 138 extern int udevadm_monitor(struct udev *udev, int argc, char *argv[]);
 139 extern int udevadm_info(struct udev *udev, int argc, char *argv[]);
 140 extern int udevadm_control(struct udev *udev, int argc, char *argv[]);
 141 extern int udevadm_trigger(struct udev *udev, int argc, char *argv[]);
 142 extern int udevadm_settle(struct udev *udev, int argc, char *argv[]);
 143 extern int udevadm_test(struct udev *udev, int argc, char *argv[]);
 144 #endif