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 #include "list.h"
  29
  30 #define ALLOWED_CHARS                           "#+-.:=@_"
  31 #define ALLOWED_CHARS_FILE                      ALLOWED_CHARS "/"
  32 #define ALLOWED_CHARS_INPUT                     ALLOWED_CHARS_FILE " $%?,"
  33
  34 #define DEFAULT_PARTITIONS_COUNT                15
  35 #define UDEV_EVENT_TIMEOUT                      180
  36
  37 /* linux/include/linux/kobject.h */
  38 #define UEVENT_BUFFER_SIZE                      2048
  39 #define UEVENT_NUM_ENVP                         32
  40
  41 #define UDEV_CTRL_SOCK_PATH                     "@" UDEV_PREFIX "/org/kernel/udev/udevd"
  42
  43 #define UDEV_MAX(a,b) ((a) > (b) ? (a) : (b))
  44
  45 /* pipes */
  46 #define READ_END                                0
  47 #define WRITE_END                               1
  48
  49 struct udev_rules;
  50
  51 static inline void logging_init(const char *program_name)
  52 {
  53         openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
  54 }
  55
  56 static inline void logging_msg(struct udev *udev, int priority,
  57                           const char *file, int line, const char *fn,
  58                           const char *format, va_list args)
  59 {
  60         vsyslog(priority, format, args);
  61 }
  62
  63 static inline void logging_close(void)
  64 {
  65         closelog();
  66 }
  67
  68 /* udev-event.c */
  69 struct udev_event {
  70         struct udev *udev;
  71         struct udev_device *dev;
  72         struct udev_device *dev_parent;
  73         int devlink_final;
  74         int owner_final;
  75         int group_final;
  76         int mode_final;
  77         char tmp_node[UTIL_PATH_SIZE];
  78         char program_result[UTIL_PATH_SIZE];
  79         int run_final;
  80
  81         char name[UTIL_PATH_SIZE];
  82         mode_t mode;
  83         char owner[UTIL_NAME_SIZE];
  84         char group[UTIL_NAME_SIZE];
  85         struct udev_list_node run_list;
  86         int ignore_device;
  87         int test;
  88
  89         struct list_head node;
  90         pid_t pid;
  91         int exitstatus;
  92         time_t queue_time;
  93 };
  94 extern struct udev_event *udev_event_new(struct udev_device *dev);
  95 extern void udev_event_unref(struct udev_event *event);
  96 extern int udev_event_run(struct udev_event *event, struct udev_rules *rules);
  97
  98 /* udev-node.c */
  99 extern int udev_node_mknod(struct udev_device *dev, const char *file, dev_t devnum, mode_t mode, uid_t uid, gid_t gid);
 100 extern int udev_node_add(struct udev_device *dev, mode_t mode, const char *owner, const char *group, int test);
 101 extern int udev_node_remove(struct udev_device *dev, int test);
 102 extern void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old, int test);
 103
 104 /* udev-util.c */
 105 struct name_entry {
 106         struct list_head node;
 107         char name[UTIL_PATH_SIZE];
 108         unsigned int ignore_error:1;
 109 };
 110 extern struct name_entry *name_list_add(struct udev *udev, struct list_head *name_list, const char *name, int sort);
 111 extern struct name_entry *name_list_key_add(struct udev *udev, struct list_head *name_list, const char *key, const char *value);
 112 extern int name_list_key_remove(struct udev *udev, struct list_head *name_list, const char *key);
 113 extern void name_list_cleanup(struct udev *udev, struct list_head *name_list);
 114 extern int add_matching_files(struct udev *udev, struct list_head *name_list, const char *dirname, const char *suffix);
 115 extern uid_t lookup_user(struct udev *udev, const char *user);
 116 extern gid_t lookup_group(struct udev *udev, const char *group);
 117
 118 /* udev_utils_file.c */
 119 extern int create_path(struct udev *udev, const char *path);
 120 extern int delete_path(struct udev *udev, const char *path);
 121 extern int unlink_secure(struct udev *udev, const char *filename);
 122 extern int file_map(const char *filename, char **buf, size_t *bufsize);
 123 extern void file_unmap(void *buf, size_t bufsize);
 124 extern size_t buf_get_line(const char *buf, size_t buflen, size_t cur);
 125
 126 /* udev-selinux.c */
 127 #ifndef USE_SELINUX
 128 static inline void selinux_init(struct udev *udev) {}
 129 static inline void selinux_exit(struct udev *udev) {}
 130 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
 131 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
 132 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
 133 #else
 134 extern void selinux_init(struct udev *udev);
 135 extern void selinux_exit(struct udev *udev);
 136 extern void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
 137 extern void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
 138 extern void udev_selinux_resetfscreatecon(struct udev *udev);
 139 #endif
 140
 141 /* udevadm commands */
 142 extern int udevadm_monitor(struct udev *udev, int argc, char *argv[]);
 143 extern int udevadm_info(struct udev *udev, int argc, char *argv[]);
 144 extern int udevadm_control(struct udev *udev, int argc, char *argv[]);
 145 extern int udevadm_trigger(struct udev *udev, int argc, char *argv[]);
 146 extern int udevadm_settle(struct udev *udev, int argc, char *argv[]);
 147 extern int udevadm_test(struct udev *udev, int argc, char *argv[]);
 148 #endif