udev/udev.h

   1 /*
   2  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
   3  * Copyright (C) 2003-2006 Kay Sievers <kay.sievers@vrfy.org>
   4  *
   5  *      This program is free software; you can redistribute it and/or modify it
   6  *      under the terms of the GNU General Public License as published by the
   7  *      Free Software Foundation version 2 of the License.
   8  *
   9  *      This program is distributed in the hope that it will be useful, but
  10  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *      General Public License for more details.
  13  *
  14  *      You should have received a copy of the GNU General Public License along
  15  *      with this program; if not, write to the Free Software Foundation, Inc.,
  16  *      51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  *
  18  */
  19
  20 #ifndef _UDEV_H_
  21 #define _UDEV_H_
  22
  23 #include <sys/types.h>
  24 #include <sys/param.h>
  25
  26 #include "list.h"
  27 #include "logging.h"
  28 #include "udev_sysdeps.h"
  29
  30 #define COMMENT_CHARACTER                       '#'
  31 #define LINE_SIZE                               512
  32 #define PATH_SIZE                               512
  33 #define NAME_SIZE                               256
  34 #define VALUE_SIZE                              128
  35
  36 #define ALLOWED_CHARS                           "#+-.:=@_"
  37 #define ALLOWED_CHARS_FILE                      ALLOWED_CHARS "/"
  38 #define ALLOWED_CHARS_INPUT                     ALLOWED_CHARS_FILE " $%?,"
  39
  40 #define DEFAULT_PARTITIONS_COUNT                15
  41 #define UDEV_EVENT_TIMEOUT                      180
  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 struct sysfs_device {
  52         struct list_head node;                  /* for device cache */
  53         struct sysfs_device *parent;            /* already cached parent*/
  54         char devpath[PATH_SIZE];
  55         char subsystem[NAME_SIZE];              /* $class, $bus, drivers, module */
  56         char kernel[NAME_SIZE];                 /* device instance name */
  57         char kernel_number[NAME_SIZE];
  58         char driver[NAME_SIZE];                 /* device driver name */
  59 };
  60
  61 struct udevice {
  62         /* device event */
  63         struct sysfs_device *dev;               /* points to dev_local by default */
  64         struct sysfs_device dev_local;
  65         struct sysfs_device *dev_parent;        /* current parent device used for matching */
  66         char action[NAME_SIZE];
  67         char *devpath_old;
  68
  69         /* node */
  70         char name[PATH_SIZE];
  71         struct list_head symlink_list;
  72         int symlink_final;
  73         char owner[NAME_SIZE];
  74         int owner_final;
  75         char group[NAME_SIZE];
  76         int group_final;
  77         mode_t mode;
  78         int mode_final;
  79         dev_t devt;
  80
  81         /* event processing */
  82         struct list_head run_list;
  83         int run_final;
  84         struct list_head env_list;
  85         char tmp_node[PATH_SIZE];
  86         int partitions;
  87         int ignore_device;
  88         int ignore_remove;
  89         char program_result[PATH_SIZE];
  90         int link_priority;
  91         int event_timeout;
  92         int test_run;
  93 };
  94
  95 /* udev_config.c */
  96 extern char udev_root[PATH_SIZE];
  97 extern char udev_config_filename[PATH_SIZE];
  98 extern char udev_rules_dir[PATH_SIZE];
  99 extern int udev_log_priority;
 100 extern int udev_run;
 101 extern void udev_config_init(void);
 102
 103 /* udev_device.c */
 104 extern struct udevice *udev_device_init(struct udevice *udev);
 105 extern void udev_device_cleanup(struct udevice *udev);
 106 extern int udev_device_event(struct udev_rules *rules, struct udevice *udev);
 107 extern dev_t udev_device_get_devt(struct udevice *udev);
 108
 109 /* udev_sysfs.c */
 110 extern char sysfs_path[PATH_SIZE];
 111 extern int sysfs_init(void);
 112 extern void sysfs_cleanup(void);
 113 extern void sysfs_device_set_values(struct sysfs_device *dev, const char *devpath,
 114                                     const char *subsystem, const char *driver);
 115 extern struct sysfs_device *sysfs_device_get(const char *devpath);
 116 extern struct sysfs_device *sysfs_device_get_parent(struct sysfs_device *dev);
 117 extern struct sysfs_device *sysfs_device_get_parent_with_subsystem(struct sysfs_device *dev, const char *subsystem);
 118 extern char *sysfs_attr_get_value(const char *devpath, const char *attr_name);
 119 extern int sysfs_resolve_link(char *path, size_t size);
 120 extern int sysfs_lookup_devpath_by_subsys_id(char *devpath, size_t len, const char *subsystem, const char *id);
 121
 122 /* udev_node.c */
 123 extern int udev_node_mknod(struct udevice *udev, const char *file, dev_t devt, mode_t mode, uid_t uid, gid_t gid);
 124 extern void udev_node_update_symlinks(struct udevice *udev, struct udevice *udev_old);
 125 extern int udev_node_add(struct udevice *udev);
 126 extern int udev_node_remove(struct udevice *udev);
 127
 128 /* udev_db.c */
 129 extern int udev_db_add_device(struct udevice *dev);
 130 extern int udev_db_delete_device(struct udevice *dev);
 131 extern int udev_db_rename(const char *devpath_old, const char *devpath);
 132 extern int udev_db_get_device(struct udevice *udev, const char *devpath);
 133 extern int udev_db_get_devices_by_name(const char *name, struct list_head *name_list);
 134 extern int udev_db_get_all_entries(struct list_head *name_list);
 135
 136 /* udev_utils.c */
 137 struct name_entry {
 138         struct list_head node;
 139         char name[PATH_SIZE];
 140         unsigned int ignore_error:1;
 141 };
 142
 143 extern int log_priority(const char *priority);
 144 extern struct name_entry *name_list_add(struct list_head *name_list, const char *name, int sort);
 145 extern struct name_entry *name_list_key_add(struct list_head *name_list, const char *key, const char *value);
 146 extern int name_list_key_remove(struct list_head *name_list, const char *key);
 147 extern void name_list_cleanup(struct list_head *name_list);
 148 extern int add_matching_files(struct list_head *name_list, const char *dirname, const char *suffix);
 149 extern uid_t lookup_user(const char *user);
 150 extern gid_t lookup_group(const char *group);
 151
 152 /* udev_utils_string.c */
 153 extern int string_is_true(const char *str);
 154 extern void remove_trailing_chars(char *path, char c);
 155 extern size_t path_encode(char *s, size_t len);
 156 extern size_t path_decode(char *s);
 157 extern int utf8_encoded_valid_unichar(const char *str);
 158 extern int replace_chars(char *str, const char *white);
 159
 160 /* udev_utils_file.c */
 161 extern int create_path(const char *path);
 162 extern int delete_path(const char *path);
 163 extern int file_map(const char *filename, char **buf, size_t *bufsize);
 164 extern void file_unmap(void *buf, size_t bufsize);
 165 extern int unlink_secure(const char *filename);
 166 extern size_t buf_get_line(const char *buf, size_t buflen, size_t cur);
 167
 168 /* udev commands */
 169 extern int udevmonitor(int argc, char *argv[], char *envp[]);
 170 extern int udevinfo(int argc, char *argv[], char *envp[]);
 171 extern int udevcontrol(int argc, char *argv[], char *envp[]);
 172 extern int udevtrigger(int argc, char *argv[], char *envp[]);
 173 extern int udevsettle(int argc, char *argv[], char *envp[]);
 174 extern int udevtest(int argc, char *argv[], char *envp[]);
 175
 176 #endif