udev_rules.c

   1 /*
   2  * udev_rules.c
   3  *
   4  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
   5  * Copyright (C) 2003-2005 Kay Sievers <kay.sievers@vrfy.org>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify it
   8  *      under the terms of the GNU General Public License as published by the
   9  *      Free Software Foundation version 2 of the License.
  10  *
  11  *      This program is distributed in the hope that it will be useful, but
  12  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *      General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU General Public License along
  17  *      with this program; if not, write to the Free Software Foundation, Inc.,
  18  *      675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  */
  21
  22 #include <stddef.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <stdio.h>
  26 #include <fcntl.h>
  27 #include <ctype.h>
  28 #include <unistd.h>
  29 #include <errno.h>
  30 #include <syslog.h>
  31 #include <sys/wait.h>
  32 #include <sys/stat.h>
  33
  34 #include "libsysfs/sysfs/libsysfs.h"
  35 #include "list.h"
  36 #include "udev_libc_wrapper.h"
  37 #include "udev.h"
  38 #include "udev_utils.h"
  39 #include "udev_version.h"
  40 #include "logging.h"
  41 #include "udev_rules.h"
  42 #include "udev_db.h"
  43
  44
  45 /* extract possible {attr} and move str behind it */
  46 static char *get_format_attribute(char **str)
  47 {
  48         char *pos;
  49         char *attr = NULL;
  50
  51         if (*str[0] == '{') {
  52                 pos = strchr(*str, '}');
  53                 if (pos == NULL) {
  54                         err("missing closing brace for format");
  55                         return NULL;
  56                 }
  57                 pos[0] = '\0';
  58                 attr = *str+1;
  59                 *str = pos+1;
  60                 dbg("attribute='%s', str='%s'", attr, *str);
  61         }
  62         return attr;
  63 }
  64
  65 /* extract possible format length and move str behind it*/
  66 static int get_format_len(char **str)
  67 {
  68         int num;
  69         char *tail;
  70
  71         if (isdigit(*str[0])) {
  72                 num = (int) strtoul(*str, &tail, 10);
  73                 if (num > 0) {
  74                         *str = tail;
  75                         dbg("format length=%i", num);
  76                         return num;
  77                 } else {
  78                         err("format parsing error '%s'", *str);
  79                 }
  80         }
  81         return -1;
  82 }
  83
  84 static int get_key(char **line, char **key, char **value)
  85 {
  86         char *linepos;
  87         char *temp;
  88
  89         linepos = *line;
  90         if (!linepos)
  91                 return -1;
  92
  93         if (strchr(linepos, '\\')) {
  94                 dbg("escaped characters are not supported, skip");
  95                 return -1;
  96         }
  97
  98         /* skip whitespace */
  99         while (isspace(linepos[0]))
 100                 linepos++;
 101
 102         /* get the key */
 103         *key = linepos;
 104         while (1) {
 105                 linepos++;
 106                 if (linepos[0] == '\0')
 107                         return -1;
 108                 if (isspace(linepos[0]))
 109                         break;
 110                 if (linepos[0] == '=')
 111                         break;
 112         }
 113
 114         /* terminate key */
 115         linepos[0] = '\0';
 116         linepos++;
 117
 118         /* skip whitespace */
 119         while (isspace(linepos[0]))
 120                 linepos++;
 121
 122         /* get the value*/
 123         if (linepos[0] == '"') {
 124                 linepos++;
 125                 temp = strchr(linepos, '"');
 126                 if (!temp) {
 127                         dbg("missing closing quote");
 128                         return -1;
 129                 }
 130                 dbg("value is quoted");
 131                 temp[0] = '\0';
 132         } else if (linepos[0] == '\'') {
 133                 linepos++;
 134                 temp = strchr(linepos, '\'');
 135                 if (!temp) {
 136                         dbg("missing closing quote");
 137                         return -1;
 138                 }
 139                 dbg("value is quoted");
 140                 temp[0] = '\0';
 141         } else if (linepos[0] == '\0') {
 142                 dbg("value is empty");
 143         } else {
 144                 temp = linepos;
 145                 while (temp[0] && !isspace(temp[0]))
 146                         temp++;
 147                 temp[0] = '\0';
 148         }
 149         *value = linepos;
 150
 151         return 0;
 152 }
 153
 154 static int import_keys_into_env(struct udevice *udev, const char *buf, size_t bufsize)
 155 {
 156         char line[LINE_SIZE];
 157         const char *bufline;
 158         char *linepos;
 159         char *variable;
 160         char *value;
 161         size_t cur;
 162         size_t count;
 163         int lineno;
 164
 165         /* loop through the whole buffer */
 166         lineno = 0;
 167         cur = 0;
 168         while (cur < bufsize) {
 169                 count = buf_get_line(buf, bufsize, cur);
 170                 bufline = &buf[cur];
 171                 cur += count+1;
 172                 lineno++;
 173
 174                 if (count >= sizeof(line)) {
 175                         err("line too long, conf line skipped %s, line %d", udev_config_filename, lineno);
 176                         continue;
 177                 }
 178
 179                 /* eat the whitespace */
 180                 while ((count > 0) && isspace(bufline[0])) {
 181                         bufline++;
 182                         count--;
 183                 }
 184                 if (count == 0)
 185                         continue;
 186
 187                 /* see if this is a comment */
 188                 if (bufline[0] == COMMENT_CHARACTER)
 189                         continue;
 190
 191                 memcpy(line, bufline, count);
 192                 line[count] = '\0';
 193
 194                 linepos = line;
 195                 if (get_key(&linepos, &variable, &value) == 0) {
 196                         dbg("import '%s=%s'", variable, value);
 197                         name_list_key_add(&udev->env_list, variable, value);
 198                         setenv(variable, value, 1);
 199                 }
 200         }
 201
 202         return 0;
 203 }
 204
 205 static int import_file_into_env(struct udevice *udev, const char *filename)
 206 {
 207         char *buf;
 208         size_t bufsize;
 209
 210         if (file_map(filename, &buf, &bufsize) != 0) {
 211                 err("can't open '%s'", filename);
 212                 return -1;
 213         }
 214         import_keys_into_env(udev, buf, bufsize);
 215         file_unmap(buf, bufsize);
 216
 217         return 0;
 218 }
 219
 220 static int import_program_into_env(struct udevice *udev, const char *program)
 221 {
 222         char result[1024];
 223         size_t reslen;
 224
 225         if (run_program(program, udev->subsystem, result, sizeof(result), &reslen, (udev_log_priority >= LOG_INFO)) != 0)
 226                 return -1;
 227         return import_keys_into_env(udev, result, reslen);
 228 }
 229
 230 static int import_parent_into_env(struct udevice *udev, struct sysfs_class_device *class_dev, const char *filter)
 231 {
 232         struct sysfs_class_device *parent = sysfs_get_classdev_parent(class_dev);
 233         int rc = -1;
 234
 235         if (parent != NULL) {
 236                 struct udevice udev_parent;
 237                 struct name_entry *name_loop;
 238
 239                 dbg("found parent '%s', get the node name", parent->path);
 240                 udev_init_device(&udev_parent, NULL, NULL, NULL);
 241                 /* import the udev_db of the parent */
 242                 if (udev_db_get_device(&udev_parent, &parent->path[strlen(sysfs_path)]) == 0) {
 243                         dbg("import stored parent env '%s'", udev_parent.name);
 244                         list_for_each_entry(name_loop, &udev_parent.env_list, node) {
 245                                 char name[NAME_SIZE];
 246                                 char *pos;
 247
 248                                 strlcpy(name, name_loop->name, sizeof(name));
 249                                 pos = strchr(name, '=');
 250                                 if (pos) {
 251                                         pos[0] = '\0';
 252                                         pos++;
 253                                         if (strcmp_pattern(filter, name) == 0) {
 254                                                 dbg("import key '%s'", name_loop->name);
 255                                                 name_list_add(&udev->env_list, name_loop->name, 0);
 256                                                 setenv(name, pos, 1);
 257                                         } else
 258                                                 dbg("skip key '%s'", name_loop->name);
 259                                 }
 260                         }
 261                         rc = 0;
 262                 } else
 263                         dbg("parent not found in database");
 264                 udev_cleanup_device(&udev_parent);
 265         }
 266
 267         return rc;
 268 }
 269
 270 /* finds the lowest positive N such that <name>N isn't present in the udevdb
 271  * if <name> doesn't exist, 0 is returned, N otherwise
 272  */
 273 static int find_free_number(const char *name, const char *devpath)
 274 {
 275         char db_devpath[PATH_SIZE];
 276         char filename[PATH_SIZE];
 277         int num = 0;
 278
 279         strlcpy(filename, name, sizeof(filename));
 280         while (1) {
 281                 dbg("look for existing node '%s'", filename);
 282                 if (udev_db_lookup_name(filename, db_devpath, sizeof(db_devpath)) != 0) {
 283                         dbg("free num=%d", num);
 284                         break;
 285                 }
 286
 287                 num++;
 288                 if (num > 100000) {
 289                         err("find_free_number aborted at num=%d", num);
 290                         num = -1;
 291                         break;
 292                 }
 293                 snprintf(filename, sizeof(filename), "%s%d", name, num);
 294                 filename[sizeof(filename)-1] = '\0';
 295         }
 296
 297         return num;
 298 }
 299
 300 static int find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device,
 301                                 const char *name, char *value, size_t len)
 302 {
 303         struct sysfs_class_device *class_dev_parent;
 304         struct sysfs_attribute *tmpattr;
 305
 306         dbg("look for device attribute '%s'", name);
 307         if (class_dev) {
 308                 dbg("look for class attribute '%s/%s'", class_dev->path, name);
 309                 tmpattr = sysfs_get_classdev_attr(class_dev, name);
 310                 if (tmpattr)
 311                         goto attr_found;
 312                 class_dev_parent = sysfs_get_classdev_parent(class_dev);
 313                 if (class_dev_parent) {
 314                         tmpattr = sysfs_get_classdev_attr(class_dev_parent, name);
 315                         if (tmpattr)
 316                                 goto attr_found;
 317                 }
 318         }
 319         if (sysfs_device) {
 320                 dbg("look for devices attribute '%s/%s'", sysfs_device->path, name);
 321                 tmpattr = sysfs_get_device_attr(sysfs_device, name);
 322                 if (tmpattr)
 323                         goto attr_found;
 324         }
 325         return -1;
 326
 327 attr_found:
 328         strlcpy(value, tmpattr->value, len);
 329         remove_trailing_char(value, '\n');
 330
 331         dbg("found attribute '%s'", tmpattr->path);
 332         return 0;
 333 }
 334
 335 #define WAIT_LOOP_PER_SECOND                    20
 336 static int wait_for_sysfs(struct udevice *udev, const char *file, int timeout)
 337 {
 338         char filename[PATH_SIZE];
 339         struct stat stats;
 340         int loop = timeout * WAIT_LOOP_PER_SECOND;
 341
 342         snprintf(filename, sizeof(filename), "%s%s/%s", sysfs_path, udev->devpath, file);
 343         filename[sizeof(filename)-1] = '\0';
 344         dbg("wait %i sec for '%s'", timeout, filename);
 345
 346         while (--loop) {
 347                 if (stat(filename, &stats) == 0) {
 348                         dbg("file appeared after %i loops", (timeout * WAIT_LOOP_PER_SECOND) - loop-1);
 349                         return 0;
 350                 }
 351                 usleep(1000 * 1000 / WAIT_LOOP_PER_SECOND);
 352         }
 353         dbg("waiting for '%s' failed", filename);
 354         return -1;
 355 }
 356
 357 static void apply_format(struct udevice *udev, char *string, size_t maxsize,
 358                          struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
 359 {
 360         char temp[PATH_SIZE];
 361         char temp2[PATH_SIZE];
 362         char *head, *tail, *pos, *cpos, *attr, *rest;
 363         int len;
 364         int i;
 365         unsigned int next_free_number;
 366         struct sysfs_class_device *class_dev_parent;
 367         enum subst_type {
 368                 SUBST_UNKNOWN,
 369                 SUBST_DEVPATH,
 370                 SUBST_ID,
 371                 SUBST_KERNEL_NUMBER,
 372                 SUBST_KERNEL_NAME,
 373                 SUBST_MAJOR,
 374                 SUBST_MINOR,
 375                 SUBST_RESULT,
 376                 SUBST_SYSFS,
 377                 SUBST_ENUM,
 378                 SUBST_PARENT,
 379                 SUBST_TEMP_NODE,
 380                 SUBST_ROOT,
 381                 SUBST_MODALIAS,
 382                 SUBST_ENV,
 383         };
 384         static const struct subst_map {
 385                 char *name;
 386                 char fmt;
 387                 enum subst_type type;
 388         } map[] = {
 389                 { .name = "devpath",            .fmt = 'p',     .type = SUBST_DEVPATH },
 390                 { .name = "id",                 .fmt = 'b',     .type = SUBST_ID },
 391                 { .name = "number",             .fmt = 'n',     .type = SUBST_KERNEL_NUMBER },
 392                 { .name = "kernel",             .fmt = 'k',     .type = SUBST_KERNEL_NAME },
 393                 { .name = "major",              .fmt = 'M',     .type = SUBST_MAJOR },
 394                 { .name = "minor",              .fmt = 'm',     .type = SUBST_MINOR },
 395                 { .name = "result",             .fmt = 'c',     .type = SUBST_RESULT },
 396                 { .name = "sysfs",              .fmt = 's',     .type = SUBST_SYSFS },
 397                 { .name = "enum",               .fmt = 'e',     .type = SUBST_ENUM },
 398                 { .name = "parent",             .fmt = 'P',     .type = SUBST_PARENT },
 399                 { .name = "tempnode",           .fmt = 'N',     .type = SUBST_TEMP_NODE },
 400                 { .name = "root",               .fmt = 'r',     .type = SUBST_ROOT },
 401                 { .name = "modalias",           .fmt = 'A',     .type = SUBST_MODALIAS },
 402                 { .name = "env",                .fmt = 'E',     .type = SUBST_ENV },
 403                 { NULL, '\0', 0 }
 404         };
 405         enum subst_type type;
 406         const struct subst_map *subst;
 407
 408         head = string;
 409         while (1) {
 410                 len = -1;
 411                 while (head[0] != '\0') {
 412                         if (head[0] == '$') {
 413                                 /* substitute named variable */
 414                                 if (head[1] == '\0')
 415                                         break;
 416                                 if (head[1] == '$') {
 417                                         strlcpy(temp, head+2, sizeof(temp));
 418                                         strlcpy(head+1, temp, maxsize);
 419                                         head++;
 420                                         continue;
 421                                 }
 422                                 head[0] = '\0';
 423                                 for (subst = map; subst->name; subst++) {
 424                                         if (strncasecmp(&head[1], subst->name, strlen(subst->name)) == 0) {
 425                                                 type = subst->type;
 426                                                 tail = head + strlen(subst->name)+1;
 427                                                 dbg("will substitute format name '%s'", subst->name);
 428                                                 goto found;
 429                                         }
 430                                 }
 431                         }
 432                         else if (head[0] == '%') {
 433                                 /* substitute format char */
 434                                 if (head[1] == '\0')
 435                                         break;
 436                                 if (head[1] == '%') {
 437                                         strlcpy(temp, head+2, sizeof(temp));
 438                                         strlcpy(head+1, temp, maxsize);
 439                                         head++;
 440                                         continue;
 441                                 }
 442                                 head[0] = '\0';
 443                                 tail = head+1;
 444                                 len = get_format_len(&tail);
 445                                 for (subst = map; subst->name; subst++) {
 446                                         if (tail[0] == subst->fmt) {
 447                                                 type = subst->type;
 448                                                 tail++;
 449                                                 dbg("will substitute format char '%c'", subst->fmt);
 450                                                 goto found;
 451                                         }
 452                                 }
 453                         }
 454                         head++;
 455                 }
 456                 break;
 457 found:
 458                 attr = get_format_attribute(&tail);
 459                 strlcpy(temp, tail, sizeof(temp));
 460                 dbg("format=%i, string='%s', tail='%s', class_dev=%p, sysfs_dev=%p",
 461                     type ,string, tail, class_dev, sysfs_device);
 462
 463                 switch (type) {
 464                 case SUBST_DEVPATH:
 465                         strlcat(string, udev->devpath, maxsize);
 466                         dbg("substitute devpath '%s'", udev->devpath);
 467                         break;
 468                 case SUBST_ID:
 469                         strlcat(string, udev->bus_id, maxsize);
 470                         dbg("substitute bus_id '%s'", udev->bus_id);
 471                         break;
 472                 case SUBST_KERNEL_NAME:
 473                         strlcat(string, udev->kernel_name, maxsize);
 474                         dbg("substitute kernel name '%s'", udev->kernel_name);
 475                         break;
 476                 case SUBST_KERNEL_NUMBER:
 477                         strlcat(string, udev->kernel_number, maxsize);
 478                         dbg("substitute kernel number '%s'", udev->kernel_number);
 479                         break;
 480                 case SUBST_MAJOR:
 481                         sprintf(temp2, "%d", major(udev->devt));
 482                         strlcat(string, temp2, maxsize);
 483                         dbg("substitute major number '%s'", temp2);
 484                         break;
 485                 case SUBST_MINOR:
 486                         sprintf(temp2, "%d", minor(udev->devt));
 487                         strlcat(string, temp2, maxsize);
 488                         dbg("substitute minor number '%s'", temp2);
 489                         break;
 490                 case SUBST_RESULT:
 491                         if (udev->program_result[0] == '\0')
 492                                 break;
 493                         /* get part part of the result string */
 494                         i = 0;
 495                         if (attr != NULL)
 496                                 i = strtoul(attr, &rest, 10);
 497                         if (i > 0) {
 498                                 dbg("request part #%d of result string", i);
 499                                 cpos = udev->program_result;
 500                                 while (--i) {
 501                                         while (cpos[0] != '\0' && !isspace(cpos[0]))
 502                                                 cpos++;
 503                                         while (isspace(cpos[0]))
 504                                                 cpos++;
 505                                 }
 506                                 if (i > 0) {
 507                                         err("requested part of result string not found");
 508                                         break;
 509                                 }
 510                                 strlcpy(temp2, cpos, sizeof(temp2));
 511                                 /* %{2+}c copies the whole string from the second part on */
 512                                 if (rest[0] != '+') {
 513                                         cpos = strchr(temp2, ' ');
 514                                         if (cpos)
 515                                                 cpos[0] = '\0';
 516                                 }
 517                                 strlcat(string, temp2, maxsize);
 518                                 dbg("substitute part of result string '%s'", temp2);
 519                         } else {
 520                                 strlcat(string, udev->program_result, maxsize);
 521                                 dbg("substitute result string '%s'", udev->program_result);
 522                         }
 523                         break;
 524                 case SUBST_SYSFS:
 525                         if (attr == NULL) {
 526                                 dbg("missing attribute");
 527                                 break;
 528                         }
 529                         if (find_sysfs_attribute(class_dev, sysfs_device, attr, temp2, sizeof(temp2)) != 0) {
 530                                 struct sysfs_device *parent_device;
 531
 532                                 dbg("sysfs attribute '%s' not found, walk up the physical devices", attr);
 533                                 parent_device = sysfs_get_device_parent(sysfs_device);
 534                                 while (parent_device) {
 535                                         dbg("looking at '%s'", parent_device->path);
 536                                         if (find_sysfs_attribute(NULL, parent_device, attr, temp2, sizeof(temp2)) == 0)
 537                                                 break;
 538                                         parent_device = sysfs_get_device_parent(parent_device);
 539                                 }
 540                                 if (!parent_device)
 541                                         break;
 542                         }
 543                         /* strip trailing whitespace of sysfs value */
 544                         i = strlen(temp2);
 545                         while (i > 0 && isspace(temp2[i-1]))
 546                                 temp2[--i] = '\0';
 547                         replace_untrusted_chars(temp2);
 548                         strlcat(string, temp2, maxsize);
 549                         dbg("substitute sysfs value '%s'", temp2);
 550                         break;
 551                 case SUBST_ENUM:
 552                         next_free_number = find_free_number(string, udev->devpath);
 553                         if (next_free_number > 0) {
 554                                 sprintf(temp2, "%d", next_free_number);
 555                                 strlcat(string, temp2, maxsize);
 556                         }
 557                         break;
 558                 case SUBST_PARENT:
 559                         if (!class_dev)
 560                                 break;
 561                         class_dev_parent = sysfs_get_classdev_parent(class_dev);
 562                         if (class_dev_parent != NULL) {
 563                                 struct udevice udev_parent;
 564
 565                                 dbg("found parent '%s', get the node name", class_dev_parent->path);
 566                                 udev_init_device(&udev_parent, NULL, NULL, NULL);
 567                                 /* lookup the name in the udev_db with the DEVPATH of the parent */
 568                                 if (udev_db_get_device(&udev_parent, &class_dev_parent->path[strlen(sysfs_path)]) == 0) {
 569                                         strlcat(string, udev_parent.name, maxsize);
 570                                         dbg("substitute parent node name'%s'", udev_parent.name);
 571                                 } else
 572                                         dbg("parent not found in database");
 573                                 udev_cleanup_device(&udev_parent);
 574                         }
 575                         break;
 576                 case SUBST_TEMP_NODE:
 577                         if (udev->tmp_node[0] == '\0') {
 578                                 dbg("create temporary device node for callout");
 579                                 snprintf(udev->tmp_node, sizeof(udev->tmp_node), "%s/.tmp-%u-%u",
 580                                          udev_root, major(udev->devt), minor(udev->devt));
 581                                 udev->tmp_node[sizeof(udev->tmp_node)-1] = '\0';
 582                                 udev_make_node(udev, udev->tmp_node, udev->devt, 0600, 0, 0);
 583                         }
 584                         strlcat(string, udev->tmp_node, maxsize);
 585                         dbg("substitute temporary device node name '%s'", udev->tmp_node);
 586                         break;
 587                 case SUBST_ROOT:
 588                         strlcat(string, udev_root, maxsize);
 589                         dbg("substitute udev_root '%s'", udev_root);
 590                         break;
 591                 case SUBST_MODALIAS:
 592                         if (find_sysfs_attribute(NULL, sysfs_device, "modalias", temp2, sizeof(temp2)) != 0)
 593                                 break;
 594                         strlcat(string, temp2, maxsize);
 595                         dbg("substitute MODALIAS '%s'", temp2);
 596                         break;
 597                 case SUBST_ENV:
 598                         if (attr == NULL) {
 599                                 dbg("missing attribute");
 600                                 break;
 601                         }
 602                         pos = getenv(attr);
 603                         if (pos == NULL) {
 604                                 dbg("env '%s' not avialable", attr);
 605                                 break;
 606                         }
 607                         dbg("substitute env '%s=%s'", attr, pos);
 608                         strlcat(string, pos, maxsize);
 609                         break;
 610                 default:
 611                         err("unknown substitution type=%i", type);
 612                         break;
 613                 }
 614                 /* possibly truncate to format-char specified length */
 615                 if (len != -1) {
 616                         head[len] = '\0';
 617                         dbg("truncate to %i chars, subtitution string becomes '%s'", len, head);
 618                 }
 619                 strlcat(string, temp, maxsize);
 620         }
 621 }
 622
 623 static char *key_val(struct udev_rule *rule, struct key *key)
 624 {
 625         return rule->buf + key->val_off;
 626 }
 627
 628 static char *key_pair_name(struct udev_rule *rule, struct key_pair *pair)
 629 {
 630         return rule->buf + pair->key_name_off;
 631 }
 632
 633 static int match_key(const char *key_name, struct udev_rule *rule, struct key *key, const char *val)
 634 {
 635         int match;
 636         char value[PATH_SIZE];
 637         char *key_value;
 638         char *pos;
 639
 640         if (key->operation == KEY_OP_UNSET)
 641                 return 0;
 642
 643         strlcpy(value, rule->buf + key->val_off, sizeof(value));
 644         key_value = value;
 645
 646         dbg("key %s value='%s'", key_name, key_value);
 647         while (key_value) {
 648                 pos = strchr(key_value, '|');
 649                 if (pos) {
 650                         pos[0] = '\0';
 651                         pos++;
 652                 }
 653                 dbg("match %s '%s' <-> '%s'", key_name, key_value, val);
 654                 match = (strcmp_pattern(key_value, val) == 0);
 655                 if (match && (key->operation != KEY_OP_NOMATCH)) {
 656                         dbg("%s is true (matching value)", key_name);
 657                         return 0;
 658                 }
 659                 if (!match && (key->operation == KEY_OP_NOMATCH)) {
 660                         dbg("%s is true (non-matching value)", key_name);
 661                         return 0;
 662                 }
 663                 key_value = pos;
 664         }
 665         dbg("%s is false", key_name);
 666         return -1;
 667 }
 668
 669 static int match_rule(struct udevice *udev, struct udev_rule *rule,
 670                       struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
 671 {
 672         struct sysfs_device *parent_device = sysfs_device;
 673         int i;
 674
 675         if (match_key("ACTION", rule, &rule->action, udev->action))
 676                 goto exit;
 677
 678         if (match_key("KERNEL", rule, &rule->kernel_name, udev->kernel_name))
 679                 goto exit;
 680
 681         if (match_key("SUBSYSTEM", rule, &rule->subsystem, udev->subsystem))
 682                 goto exit;
 683
 684         if (match_key("DEVPATH", rule, &rule->devpath, udev->devpath))
 685                 goto exit;
 686
 687         if (rule->modalias.operation != KEY_OP_UNSET) {
 688                 char value[NAME_SIZE];
 689
 690                 if (find_sysfs_attribute(NULL, sysfs_device, "modalias", value, sizeof(value)) != 0) {
 691                         dbg("MODALIAS value not found");
 692                         goto exit;
 693                 }
 694                 if (match_key("MODALIAS", rule, &rule->modalias, value))
 695                         goto exit;
 696         }
 697
 698         for (i = 0; i < rule->env.count; i++) {
 699                 struct key_pair *pair = &rule->env.keys[i];
 700
 701                 /* we only check for matches, assignments will be handled later */
 702                 if (pair->key.operation != KEY_OP_ASSIGN) {
 703                         const char *key_name = key_pair_name(rule, pair);
 704                         const char *value = getenv(key_name);
 705
 706                         if (!value) {
 707                                 dbg("ENV{'%s'} is not set, treat as empty", key_name);
 708                                 value = "";
 709                         }
 710                         if (match_key("ENV", rule, &pair->key, value))
 711                                 goto exit;
 712                 }
 713         }
 714
 715         if (rule->wait_for_sysfs.operation != KEY_OP_UNSET) {
 716                 int match;
 717
 718                 match = (wait_for_sysfs(udev, key_val(rule, &rule->wait_for_sysfs), 3) == 0);
 719                 if (match && (rule->wait_for_sysfs.operation != KEY_OP_NOMATCH)) {
 720                         dbg("WAIT_FOR_SYSFS is true (matching value)");
 721                         return 0;
 722                 }
 723                 if (!match && (rule->wait_for_sysfs.operation == KEY_OP_NOMATCH)) {
 724                         dbg("WAIT_FOR_SYSFS is true, (non matching value)");
 725                         return 0;
 726                 }
 727                 dbg("WAIT_FOR_SYSFS is false");
 728                 return -1;
 729         }
 730
 731         /* walk up the chain of physical devices and find a match */
 732         while (1) {
 733                 /* check for matching driver */
 734                 if (rule->driver.operation != KEY_OP_UNSET) {
 735                         if (parent_device == NULL) {
 736                                 dbg("device has no sysfs_device");
 737                                 goto exit;
 738                         }
 739                         if (match_key("DRIVER", rule, &rule->driver, parent_device->driver_name))
 740                                 goto try_parent;
 741                 }
 742
 743                 /* check for matching bus value */
 744                 if (rule->bus.operation != KEY_OP_UNSET) {
 745                         if (parent_device == NULL) {
 746                                 dbg("device has no sysfs_device");
 747                                 goto exit;
 748                         }
 749                         if (match_key("BUS", rule, &rule->bus, parent_device->bus))
 750                                 goto try_parent;
 751                 }
 752
 753                 /* check for matching bus id */
 754                 if (rule->id.operation != KEY_OP_UNSET) {
 755                         if (parent_device == NULL) {
 756                                 dbg("device has no sysfs_device");
 757                                 goto exit;
 758                         }
 759                         if (match_key("ID", rule, &rule->id, parent_device->bus_id))
 760                                 goto try_parent;
 761                 }
 762
 763                 /* check for matching sysfs pairs */
 764                 if (rule->sysfs.count) {
 765                         dbg("check %i SYSFS keys", rule->sysfs.count);
 766                         for (i = 0; i < rule->sysfs.count; i++) {
 767                                 struct key_pair *pair = &rule->sysfs.keys[i];
 768                                 const char *key_name = key_pair_name(rule, pair);
 769                                 const char *key_value = key_val(rule, &pair->key);
 770                                 char value[VALUE_SIZE];
 771                                 size_t len;
 772
 773                                 if (find_sysfs_attribute(class_dev, parent_device, key_name, value, sizeof(value)) != 0)
 774                                         goto try_parent;
 775
 776                                 /* strip trailing whitespace of value, if not asked to match for it */
 777                                 len = strlen(key_value);
 778                                 if (len && !isspace(key_value[len-1])) {
 779                                         len = strlen(value);
 780                                         while (len > 0 && isspace(value[len-1]))
 781                                                 value[--len] = '\0';
 782                                         dbg("removed %zi trailing whitespace chars from '%s'", strlen(value)-len, value);
 783                                 }
 784
 785                                 if (match_key("SYSFS", rule, &pair->key, value))
 786                                         goto try_parent;
 787                         }
 788                         dbg("all %i SYSFS keys matched", rule->sysfs.count);
 789                 }
 790
 791                 /* found matching physical device  */
 792                 break;
 793 try_parent:
 794                 dbg("try parent sysfs device");
 795                 parent_device = sysfs_get_device_parent(parent_device);
 796                 if (parent_device == NULL)
 797                         goto exit;
 798                 dbg("look at sysfs_device->path='%s'", parent_device->path);
 799                 dbg("look at sysfs_device->bus_id='%s'", parent_device->bus_id);
 800         }
 801
 802         /* execute external program */
 803         if (rule->program.operation != KEY_OP_UNSET) {
 804                 char program[PATH_SIZE];
 805                 char result[PATH_SIZE];
 806
 807                 strlcpy(program, key_val(rule, &rule->program), sizeof(program));
 808                 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
 809                 if (run_program(program, udev->subsystem, result, sizeof(result), NULL, (udev_log_priority >= LOG_INFO)) != 0) {
 810                         dbg("PROGRAM is false");
 811                         udev->program_result[0] = '\0';
 812                         if (rule->program.operation != KEY_OP_NOMATCH)
 813                                 goto exit;
 814                 } else {
 815                         dbg("PROGRAM matches");
 816                         remove_trailing_char(result, '\n');
 817                         replace_untrusted_chars(result);
 818                         dbg("result is '%s'", result);
 819                         strlcpy(udev->program_result, result, sizeof(udev->program_result));
 820                         dbg("PROGRAM returned successful");
 821                         if (rule->program.operation == KEY_OP_NOMATCH)
 822                                 goto exit;
 823                 }
 824                 dbg("PROGRAM key is true");
 825         }
 826
 827         /* check for matching result of external program */
 828         if (match_key("RESULT", rule, &rule->result, udev->program_result))
 829                 goto exit;
 830
 831         /* import variables returned from program or or file into environment */
 832         if (rule->import.operation != KEY_OP_UNSET) {
 833                 char import[PATH_SIZE];
 834                 int rc = -1;
 835
 836                 strlcpy(import, key_val(rule, &rule->import), sizeof(import));
 837                 apply_format(udev, import, sizeof(import), class_dev, sysfs_device);
 838                 dbg("check for IMPORT import='%s'", import);
 839                 if (rule->import_type == IMPORT_PROGRAM) {
 840                         rc = import_program_into_env(udev, import);
 841                 } else if (rule->import_type == IMPORT_FILE) {
 842                         dbg("import file import='%s'", import);
 843                         rc = import_file_into_env(udev, import);
 844                 } else if (rule->import_type == IMPORT_PARENT && class_dev) {
 845                         dbg("import parent import='%s'", import);
 846                         rc = import_parent_into_env(udev, class_dev, import);
 847                 }
 848                 if (rc) {
 849                         dbg("IMPORT failed");
 850                         if (rule->import.operation != KEY_OP_NOMATCH)
 851                                 goto exit;
 852                 } else
 853                         dbg("IMPORT '%s' imported", key_val(rule, &rule->import));
 854                 dbg("IMPORT key is true");
 855         }
 856
 857         /* rule matches, if we have ENV assignments export it */
 858         for (i = 0; i < rule->env.count; i++) {
 859                 struct key_pair *pair = &rule->env.keys[i];
 860
 861                 if (pair->key.operation == KEY_OP_ASSIGN) {
 862                         const char *key_name = key_pair_name(rule, pair);
 863                         const char *value = key_val(rule, &pair->key);
 864
 865                         name_list_key_add(&udev->env_list, key_name, value);
 866                         setenv(key_name, value, 1);
 867                         dbg("export ENV '%s=%s'", key_name, value);
 868                 }
 869         }
 870
 871         return 0;
 872
 873 exit:
 874         return -1;
 875 }
 876
 877 int udev_rules_get_name(struct udev_rules *rules, struct udevice *udev, struct sysfs_class_device *class_dev)
 878 {
 879         struct sysfs_class_device *class_dev_parent;
 880         struct sysfs_device *sysfs_device = NULL;
 881         struct udev_rule *rule;
 882         int name_set = 0;
 883
 884         dbg("class_dev->name='%s'", class_dev->name);
 885
 886         /* Figure out where the "device"-symlink is at.  For char devices this will
 887          * always be in the class_dev->path.  On block devices, only the main block
 888          * device will have the device symlink in it's path. All partition devices
 889          * need to look at the symlink in its parent directory.
 890          */
 891         class_dev_parent = sysfs_get_classdev_parent(class_dev);
 892         if (class_dev_parent != NULL) {
 893                 dbg("given class device has a parent, use this instead");
 894                 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
 895         } else {
 896                 sysfs_device = sysfs_get_classdev_device(class_dev);
 897         }
 898
 899         if (sysfs_device) {
 900                 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
 901                     sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
 902                 strlcpy(udev->bus_id, sysfs_device->bus_id, sizeof(udev->bus_id));
 903         }
 904
 905         dbg("udev->kernel_name='%s'", udev->kernel_name);
 906
 907         /* look for a matching rule to apply */
 908         udev_rules_iter_init(rules);
 909         while (1) {
 910                 rule = udev_rules_iter_next(rules);
 911                 if (rule == NULL)
 912                         break;
 913
 914                 if (name_set && rule->name.operation != KEY_OP_UNSET) {
 915                         dbg("node name already set, rule ignored");
 916                         continue;
 917                 }
 918
 919                 dbg("process rule");
 920                 if (match_rule(udev, rule, class_dev, sysfs_device) == 0) {
 921                         /* apply options */
 922                         if (rule->ignore_device) {
 923                                 info("rule applied, '%s' is ignored", udev->kernel_name);
 924                                 udev->ignore_device = 1;
 925                                 return 0;
 926                         }
 927                         if (rule->ignore_remove) {
 928                                 udev->ignore_remove = 1;
 929                                 dbg("remove event should be ignored");
 930                         }
 931                         /* apply all_partitions option only at a main block device */
 932                         if (rule->partitions && udev->type == DEV_BLOCK && udev->kernel_number[0] == '\0') {
 933                                 udev->partitions = rule->partitions;
 934                                 dbg("creation of partition nodes requested");
 935                         }
 936
 937                         /* apply permissions */
 938                         if (!udev->mode_final && rule->mode != 0000) {
 939                                 if (rule->mode_operation == KEY_OP_ASSIGN_FINAL)
 940                                         udev->mode_final = 1;
 941                                 udev->mode = rule->mode;
 942                                 dbg("applied mode=%#o to '%s'", rule->mode, udev->kernel_name);
 943                         }
 944                         if (!udev->owner_final && rule->owner.operation != KEY_OP_UNSET) {
 945                                 if (rule->owner.operation == KEY_OP_ASSIGN_FINAL)
 946                                         udev->owner_final = 1;
 947                                 strlcpy(udev->owner, key_val(rule, &rule->owner), sizeof(udev->owner));
 948                                 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
 949                                 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
 950                         }
 951                         if (!udev->group_final && rule->group.operation != KEY_OP_UNSET) {
 952                                 if (rule->group.operation == KEY_OP_ASSIGN_FINAL)
 953                                         udev->group_final = 1;
 954                                 strlcpy(udev->group, key_val(rule, &rule->group), sizeof(udev->group));
 955                                 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
 956                                 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
 957                         }
 958
 959                         /* collect symlinks */
 960                         if (!udev->symlink_final && rule->symlink.operation != KEY_OP_UNSET) {
 961                                 char temp[PATH_SIZE];
 962                                 char *pos, *next;
 963
 964                                 if (rule->symlink.operation == KEY_OP_ASSIGN_FINAL)
 965                                         udev->symlink_final = 1;
 966                                 if (rule->symlink.operation == KEY_OP_ASSIGN || rule->symlink.operation == KEY_OP_ASSIGN_FINAL) {
 967                                         info("reset symlink list");
 968                                         name_list_cleanup(&udev->symlink_list);
 969                                 }
 970                                 strlcpy(temp, key_val(rule, &rule->symlink), sizeof(temp));
 971                                 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
 972                                 dbg("rule applied, added symlink '%s'", temp);
 973
 974                                 /* add multiple symlinks separated by spaces */
 975                                 pos = temp;
 976                                 while (isspace(pos[0]))
 977                                         pos++;
 978                                 next = strchr(pos, ' ');
 979                                 while (next) {
 980                                         next[0] = '\0';
 981                                         info("add symlink '%s'", pos);
 982                                         name_list_add(&udev->symlink_list, pos, 0);
 983                                         while (isspace(next[1]))
 984                                                 next++;
 985                                         pos = &next[1];
 986                                         next = strchr(pos, ' ');
 987                                 }
 988                                 if (pos[0] != '\0') {
 989                                         info("add symlink '%s'", pos);
 990                                         name_list_add(&udev->symlink_list, pos, 0);
 991                                 }
 992                         }
 993
 994                         /* set name, later rules with name set will be ignored */
 995                         if (rule->name.operation != KEY_OP_UNSET) {
 996                                 name_set = 1;
 997                                 strlcpy(udev->name, key_val(rule, &rule->name), sizeof(udev->name));
 998                                 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
 999
1000                                 info("rule applied, '%s' becomes '%s'", udev->kernel_name, udev->name);
1001                                 if (udev->type != DEV_NET)
1002                                         dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
1003                                             udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
1004                         }
1005
1006                         if (!udev->run_final && rule->run.operation != KEY_OP_UNSET) {
1007                                 char program[PATH_SIZE];
1008
1009                                 if (rule->run.operation == KEY_OP_ASSIGN_FINAL)
1010                                         udev->run_final = 1;
1011                                 if (rule->run.operation == KEY_OP_ASSIGN || rule->run.operation == KEY_OP_ASSIGN_FINAL) {
1012                                         info("reset run list");
1013                                         name_list_cleanup(&udev->run_list);
1014                                 }
1015                                 strlcpy(program, key_val(rule, &rule->run), sizeof(program));
1016                                 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
1017                                 dbg("add run '%s'", program);
1018                                 name_list_add(&udev->run_list, program, 0);
1019                         }
1020
1021                         if (rule->last_rule) {
1022                                 dbg("last rule to be applied");
1023                                 break;
1024                         }
1025
1026                         if (rule->goto_label.operation != KEY_OP_UNSET) {
1027                                 dbg("moving forward to label '%s'", key_val(rule, &rule->goto_label));
1028                                 udev_rules_iter_label(rules, key_val(rule, &rule->goto_label));
1029                         }
1030                 }
1031         }
1032
1033         if (!name_set) {
1034                 strlcpy(udev->name, udev->kernel_name, sizeof(udev->name));
1035                 info("no node name set, will use kernel name '%s'", udev->name);
1036         }
1037
1038         if (udev->tmp_node[0] != '\0') {
1039                 dbg("removing temporary device node");
1040                 unlink_secure(udev->tmp_node);
1041                 udev->tmp_node[0] = '\0';
1042         }
1043
1044         return 0;
1045 }
1046
1047 int udev_rules_get_run(struct udev_rules *rules, struct udevice *udev,
1048                        struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_dev)
1049 {
1050         struct udev_rule *rule;
1051
1052         if (class_dev && !sysfs_dev)
1053                 sysfs_dev = sysfs_get_classdev_device(class_dev);
1054         if (sysfs_dev) {
1055                 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
1056                     sysfs_dev->path, sysfs_dev->bus_id, sysfs_dev->bus);
1057                 strlcpy(udev->bus_id, sysfs_dev->bus_id, sizeof(udev->bus_id));
1058         }
1059
1060         dbg("udev->kernel_name='%s'", udev->kernel_name);
1061
1062         /* look for a matching rule to apply */
1063         udev_rules_iter_init(rules);
1064         while (1) {
1065                 rule = udev_rules_iter_next(rules);
1066                 if (rule == NULL)
1067                         break;
1068
1069                 dbg("process rule");
1070                 if (rule->name.operation != KEY_OP_UNSET || rule->symlink.operation != KEY_OP_UNSET ||
1071                     rule->mode_operation != KEY_OP_UNSET || rule->owner.operation != KEY_OP_UNSET || rule->group.operation != KEY_OP_UNSET) {
1072                         dbg("skip rule that names a device");
1073                         continue;
1074                 }
1075
1076                 if (match_rule(udev, rule, class_dev, sysfs_dev) == 0) {
1077                         if (rule->ignore_device) {
1078                                 info("rule applied, '%s' is ignored", udev->kernel_name);
1079                                 udev->ignore_device = 1;
1080                                 return 0;
1081                         }
1082
1083                         if (!udev->run_final && rule->run.operation != KEY_OP_UNSET) {
1084                                 char program[PATH_SIZE];
1085
1086                                 if (rule->run.operation == KEY_OP_ASSIGN || rule->run.operation == KEY_OP_ASSIGN_FINAL) {
1087                                         info("reset run list");
1088                                         name_list_cleanup(&udev->run_list);
1089                                 }
1090                                 strlcpy(program, key_val(rule, &rule->run), sizeof(program));
1091                                 apply_format(udev, program, sizeof(program), class_dev, sysfs_dev);
1092                                 dbg("add run '%s'", program);
1093                                 name_list_add(&udev->run_list, program, 0);
1094                                 if (rule->run.operation == KEY_OP_ASSIGN_FINAL)
1095                                         break;
1096                         }
1097
1098                         if (rule->last_rule) {
1099                                 dbg("last rule to be applied");
1100                                 break;
1101                         }
1102
1103                         if (rule->goto_label.operation != KEY_OP_UNSET) {
1104                                 dbg("moving forward to label '%s'", key_val(rule, &rule->goto_label));
1105                                 udev_rules_iter_label(rules, key_val(rule, &rule->goto_label));
1106                         }
1107                 }
1108         }
1109
1110         return 0;
1111 }