udev/udev_rules.h

   1 /*
   2  * Copyright (C) 2003-2004 Greg Kroah-Hartman <greg@kroah.com>
   3  * Copyright (C) 2004-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_RULES_H
  21 #define UDEV_RULES_H
  22
  23 #include "udev.h"
  24 #include "list.h"
  25
  26 #define PAIRS_MAX               5
  27
  28 enum key_operation {
  29         KEY_OP_UNSET,
  30         KEY_OP_MATCH,
  31         KEY_OP_NOMATCH,
  32         KEY_OP_ADD,
  33         KEY_OP_ASSIGN,
  34         KEY_OP_ASSIGN_FINAL,
  35 };
  36
  37 struct key {
  38         enum key_operation operation;
  39         size_t val_off;
  40 };
  41
  42 struct key_pair {
  43         struct key key;
  44         size_t key_name_off;
  45 };
  46
  47 struct key_pairs {
  48         int count;
  49         struct key_pair keys[PAIRS_MAX];
  50 };
  51
  52 enum import_type {
  53         IMPORT_UNSET,
  54         IMPORT_PROGRAM,
  55         IMPORT_FILE,
  56         IMPORT_PARENT,
  57 };
  58
  59 enum escape_type {
  60         ESCAPE_UNSET,
  61         ESCAPE_NONE,
  62         ESCAPE_REPLACE,
  63 };
  64
  65 struct udev_rule {
  66         struct key action;
  67         struct key devpath;
  68         struct key kernel;
  69         struct key subsystem;
  70         struct key driver;
  71         struct key_pairs attr;
  72
  73         struct key kernels;
  74         struct key subsystems;
  75         struct key drivers;
  76         struct key_pairs attrs;
  77
  78         struct key_pairs env;
  79         struct key program;
  80         struct key result;
  81         struct key import;
  82         enum import_type import_type;
  83         struct key test;
  84         mode_t test_mode_mask;
  85         struct key run;
  86         struct key wait_for;
  87         struct key label;
  88         struct key goto_label;
  89
  90         struct key name;
  91         struct key symlink;
  92         struct key symlink_match;
  93         struct key owner;
  94         struct key group;
  95         struct key mode;
  96         enum escape_type string_escape;
  97
  98         unsigned int link_priority;
  99         int event_timeout;
 100         unsigned int partitions;
 101         unsigned int last_rule:1,
 102                      run_ignore_error:1,
 103                      ignore_device:1,
 104                      ignore_remove:1;
 105
 106         size_t bufsize;
 107         char buf[];
 108 };
 109
 110 struct udev_rules {
 111         struct udev *udev;
 112         char *buf;
 113         size_t bufsize;
 114         int resolve_names;
 115 };
 116
 117 struct udev_rules_iter {
 118         struct udev_rules *rules;
 119         size_t current;
 120 };
 121
 122 extern int udev_rules_init(struct udev *udev, struct udev_rules *rules, int resolve_names);
 123 extern void udev_rules_cleanup(struct udev_rules *rules);
 124
 125 extern void udev_rules_iter_init(struct udev_rules_iter *iter, struct udev_rules *rules);
 126 extern struct udev_rule *udev_rules_iter_next(struct udev_rules_iter *iter);
 127 extern struct udev_rule *udev_rules_iter_label(struct udev_rules_iter *iter, const char *label);
 128
 129 extern int udev_rules_get_name(struct udev_rules *rules, struct udevice *udev);
 130 extern int udev_rules_get_run(struct udev_rules *rules, struct udevice *udev);
 131 extern int udev_rules_run(struct udevice *udev);
 132
 133 extern void udev_rules_apply_format(struct udevice *udev, char *string, size_t maxsize);
 134
 135 #endif