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 "config.h"
  23
  24 #include <sys/types.h>
  25 #include <sys/param.h>
  26
  27 #include "udev_sysdeps.h"
  28 #define LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE 1
  29 #include "lib/libudev.h"
  30 #include "lib/libudev-private.h"
  31 #include "lib/list.h"
  32
  33 #define COMMENT_CHARACTER                       '#'
  34 #define LINE_SIZE                               512
  35 #define PATH_SIZE                               512
  36 #define NAME_SIZE                               256
  37 #define VALUE_SIZE                              128
  38
  39 #define ALLOWED_CHARS                           "#+-.:=@_"
  40 #define ALLOWED_CHARS_FILE                      ALLOWED_CHARS "/"
  41 #define ALLOWED_CHARS_INPUT                     ALLOWED_CHARS_FILE " $%?,"
  42
  43 #define DEFAULT_PARTITIONS_COUNT                15
  44 #define UDEV_EVENT_TIMEOUT                      180
  45
  46 /* linux/include/linux/kobject.h */
  47 #define UEVENT_BUFFER_SIZE                      2048
  48 #define UEVENT_NUM_ENVP                         32
  49
  50 #define UDEV_CTRL_SOCK_PATH                     "@" UDEV_PREFIX "/org/kernel/udev/udevd"
  51
  52 #define UDEV_MAX(a,b) ((a) > (b) ? (a) : (b))
  53
  54 /* pipes */
  55 #define READ_END                                0
  56 #define WRITE_END                               1
  57
  58 struct udev_rules;
  59
  60 struct sysfs_device {
  61         struct list_head node;                  /* for device cache */
  62         struct sysfs_device *parent;            /* already cached parent*/
  63         char devpath[PATH_SIZE];
  64         char subsystem[NAME_SIZE];              /* $class, $bus, drivers, module */
  65         char kernel[NAME_SIZE];                 /* device instance name */
  66         char kernel_number[NAME_SIZE];
  67         char driver[NAME_SIZE];                 /* device driver name */
  68 };
  69
  70 struct udevice {
  71         struct udev *udev;
  72
  73         /* device event */
  74         struct sysfs_device *dev;               /* points to dev_local by default */
  75         struct sysfs_device dev_local;
  76         struct sysfs_device *dev_parent;        /* current parent device used for matching */
  77         char action[NAME_SIZE];
  78         char *devpath_old;
  79
  80         /* node */
  81         char name[PATH_SIZE];
  82         struct list_head symlink_list;
  83         int symlink_final;
  84         char owner[NAME_SIZE];
  85         int owner_final;
  86         char group[NAME_SIZE];
  87         int group_final;
  88         mode_t mode;
  89         int mode_final;
  90         dev_t devt;
  91
  92         /* event processing */
  93         struct list_head run_list;
  94         int run_final;
  95         struct list_head env_list;
  96         char tmp_node[PATH_SIZE];
  97         int partitions;
  98         int ignore_device;
  99         int ignore_remove;
 100         char program_result[PATH_SIZE];
 101         int link_priority;
 102         int event_timeout;
 103         int test_run;
 104 };
 105
 106 static inline void logging_init(const char *program_name)
 107 {
 108         openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
 109 }
 110
 111 static inline void logging_msg(struct udev *udev, int priority,
 112                           const char *file, int line, const char *fn,
 113                           const char *format, va_list args)
 114 {
 115         vsyslog(priority, format, args);
 116 }
 117
 118 static inline void logging_close(void)
 119 {
 120         closelog();
 121 }
 122
 123 /* udev_device.c */
 124 extern struct udevice *udev_device_init(struct udev *udev);
 125 extern void udev_device_cleanup(struct udevice *udevice);
 126 extern dev_t udev_device_get_devt(struct udevice *udevice);
 127
 128 /* udev_device_event.c */
 129 extern int udev_device_event(struct udev_rules *rules, struct udevice *udevice);
 130
 131 /* udev_sysfs.c */
 132 extern int sysfs_init(void);
 133 extern void sysfs_cleanup(void);
 134 extern void sysfs_device_set_values(struct udev *udev,
 135                                     struct sysfs_device *dev, const char *devpath,
 136                                     const char *subsystem, const char *driver);
 137 extern struct sysfs_device *sysfs_device_get(struct udev *udev, const char *devpath);
 138 extern struct sysfs_device *sysfs_device_get_parent(struct udev *udev, struct sysfs_device *dev);
 139 extern struct sysfs_device *sysfs_device_get_parent_with_subsystem(struct udev *udev, struct sysfs_device *dev, const char *subsystem);
 140 extern char *sysfs_attr_get_value(struct udev *udev, const char *devpath, const char *attr_name);
 141 extern int sysfs_resolve_link(struct udev *udev, char *path, size_t size);
 142 extern int sysfs_lookup_devpath_by_subsys_id(struct udev *udev, char *devpath, size_t len, const char *subsystem, const char *id);
 143
 144 /* udev_node.c */
 145 extern int udev_node_mknod(struct udevice *udevice, const char *file, dev_t devt, mode_t mode, uid_t uid, gid_t gid);
 146 extern void udev_node_update_symlinks(struct udevice *udevice, struct udevice *udev_old);
 147 extern int udev_node_add(struct udevice *udevice);
 148 extern int udev_node_remove(struct udevice *udevice);
 149
 150 /* udev_db.c */
 151 extern int udev_db_add_device(struct udevice *udevice);
 152 extern int udev_db_delete_device(struct udevice *udevice);
 153 extern int udev_db_rename(struct udev *udev, const char *devpath_old, const char *devpath);
 154 extern int udev_db_get_device(struct udevice *udevice, const char *devpath);
 155 extern int udev_db_get_devices_by_name(struct udev *udev, const char *name, struct list_head *name_list);
 156 extern int udev_db_get_all_entries(struct udev *udevconst, struct list_head *name_list);
 157
 158 /* udev_utils.c */
 159 struct name_entry {
 160         struct list_head node;
 161         char name[PATH_SIZE];
 162         unsigned int ignore_error:1;
 163 };
 164
 165 extern int log_priority(const char *priority);
 166 extern struct name_entry *name_list_add(struct udev *udev, struct list_head *name_list, const char *name, int sort);
 167 extern struct name_entry *name_list_key_add(struct udev *udev, struct list_head *name_list, const char *key, const char *value);
 168 extern int name_list_key_remove(struct udev *udev, struct list_head *name_list, const char *key);
 169 extern void name_list_cleanup(struct udev *udev, struct list_head *name_list);
 170 extern int add_matching_files(struct udev *udev, struct list_head *name_list, const char *dirname, const char *suffix);
 171 extern uid_t lookup_user(struct udev *udev, const char *user);
 172 extern gid_t lookup_group(struct udev *udev, const char *group);
 173
 174 /* udev_utils_string.c */
 175 extern int string_is_true(const char *str);
 176 extern void remove_trailing_chars(char *path, char c);
 177 extern size_t path_encode(char *s, size_t len);
 178 extern size_t path_decode(char *s);
 179 extern int utf8_encoded_valid_unichar(const char *str);
 180 extern int replace_chars(char *str, const char *white);
 181
 182 /* udev_utils_file.c */
 183 extern int create_path(struct udev *udev, const char *path);
 184 extern int delete_path(struct udev *udev, const char *path);
 185 extern int unlink_secure(struct udev *udev, const char *filename);
 186 extern int file_map(const char *filename, char **buf, size_t *bufsize);
 187 extern void file_unmap(void *buf, size_t bufsize);
 188 extern size_t buf_get_line(const char *buf, size_t buflen, size_t cur);
 189
 190 /* udevadm commands */
 191 extern int udevadm_monitor(struct udev *udev, int argc, char *argv[]);
 192 extern int udevadm_info(struct udev *udev, int argc, char *argv[]);
 193 extern int udevadm_control(struct udev *udev, int argc, char *argv[]);
 194 extern int udevadm_trigger(struct udev *udev, int argc, char *argv[]);
 195 extern int udevadm_settle(struct udev *udev, int argc, char *argv[]);
 196 extern int udevadm_test(struct udev *udev, int argc, char *argv[]);
 197
 198 #endif