libudev/libudev-list.c

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <stddef.h>
  15 #include <unistd.h>
  16 #include <errno.h>
  17 #include <string.h>
  18
  19 #include "libudev.h"
  20 #include "libudev-private.h"
  21
  22 /**
  23  * udev_list_entry:
  24  *
  25  * One entry in a list, containing a name and an optional value.
  26  */
  27 struct udev_list_entry {
  28         struct udev_list_node node;
  29         struct udev *udev;
  30         struct udev_list_node *list;
  31         char *name;
  32         char *value;
  33         int flag;
  34 };
  35
  36 /* list head point to itself if empty */
  37 void udev_list_init(struct udev_list_node *list)
  38 {
  39         list->next = list;
  40         list->prev = list;
  41 }
  42
  43 int udev_list_is_empty(struct udev_list_node *list)
  44 {
  45         return list->next == list;
  46 }
  47
  48 static void udev_list_node_insert_between(struct udev_list_node *new,
  49                                           struct udev_list_node *prev,
  50                                           struct udev_list_node *next)
  51 {
  52         next->prev = new;
  53         new->next = next;
  54         new->prev = prev;
  55         prev->next = new;
  56 }
  57
  58 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list)
  59 {
  60         udev_list_node_insert_between(new, list->prev, list);
  61 }
  62
  63 void udev_list_node_remove(struct udev_list_node *entry)
  64 {
  65         struct udev_list_node *prev = entry->prev;
  66         struct udev_list_node *next = entry->next;
  67
  68         next->prev = prev;
  69         prev->next = next;
  70
  71         entry->prev = NULL;
  72         entry->next = NULL;
  73 }
  74
  75 /* return list entry which embeds this node */
  76 static struct udev_list_entry *list_node_to_entry(struct udev_list_node *node)
  77 {
  78         char *list;
  79
  80         list = (char *)node;
  81         list -= offsetof(struct udev_list_entry, node);
  82         return (struct udev_list_entry *)list;
  83 }
  84
  85 /* insert entry into a list as the last element  */
  86 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list_node *list)
  87 {
  88         /* inserting before the list head make the node the last node in the list */
  89         udev_list_node_insert_between(&new->node, list->prev, list);
  90         new->list = list;
  91 }
  92
  93 /* remove entry from a list */
  94 void udev_list_entry_remove(struct udev_list_entry *entry)
  95 {
  96         udev_list_node_remove(&entry->node);
  97         entry->list = NULL;
  98 }
  99
 100 /* insert entry into a list, before a given existing entry */
 101 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry)
 102 {
 103         udev_list_node_insert_between(&new->node, entry->node.prev, &entry->node);
 104         new->list = entry->list;
 105 }
 106
 107 struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
 108                                             const char *name, const char *value,
 109                                             int unique, int sort)
 110 {
 111         struct udev_list_entry *entry_loop = NULL;
 112         struct udev_list_entry *entry_new;
 113
 114         if (unique)
 115                 udev_list_entry_foreach(entry_loop, udev_list_get_entry(list)) {
 116                         if (strcmp(entry_loop->name, name) == 0) {
 117                                 dbg(udev, "'%s' is already in the list\n", name);
 118                                 free(entry_loop->value);
 119                                 if (value == NULL) {
 120                                         entry_loop->value = NULL;
 121                                         dbg(udev, "'%s' value unset\n", name);
 122                                         return entry_loop;
 123                                 }
 124                                 entry_loop->value = strdup(value);
 125                                 if (entry_loop->value == NULL)
 126                                         return NULL;
 127                                 dbg(udev, "'%s' value replaced with '%s'\n", name, value);
 128                                 return entry_loop;
 129                         }
 130                 }
 131
 132         if (sort)
 133                 udev_list_entry_foreach(entry_loop, udev_list_get_entry(list)) {
 134                         if (strcmp(entry_loop->name, name) > 0)
 135                                 break;
 136                 }
 137
 138         entry_new = malloc(sizeof(struct udev_list_entry));
 139         if (entry_new == NULL)
 140                 return NULL;
 141         memset(entry_new, 0x00, sizeof(struct udev_list_entry));
 142         entry_new->udev = udev;
 143         entry_new->name = strdup(name);
 144         if (entry_new->name == NULL) {
 145                 free(entry_new);
 146                 return NULL;
 147         }
 148         if (value != NULL) {
 149                 entry_new->value = strdup(value);
 150                 if (entry_new->value == NULL) {
 151                         free(entry_new->name);
 152                         free(entry_new);
 153                         return NULL;
 154                 }
 155         }
 156         if (entry_loop != NULL)
 157                 udev_list_entry_insert_before(entry_new, entry_loop);
 158         else
 159                 udev_list_entry_append(entry_new, list);
 160         dbg(udev, "'%s=%s' added\n", entry_new->name, entry_new->value);
 161         return entry_new;
 162 }
 163
 164 void udev_list_entry_delete(struct udev_list_entry *entry)
 165 {
 166         udev_list_node_remove(&entry->node);
 167         free(entry->name);
 168         free(entry->value);
 169         free(entry);
 170 }
 171
 172 void udev_list_cleanup_entries(struct udev *udev, struct udev_list_node *list)
 173 {
 174         struct udev_list_entry *entry_loop;
 175         struct udev_list_entry *entry_tmp;
 176
 177         udev_list_entry_foreach_safe(entry_loop, entry_tmp, udev_list_get_entry(list))
 178                 udev_list_entry_delete(entry_loop);
 179 }
 180
 181 struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list)
 182 {
 183         if (udev_list_is_empty(list))
 184                 return NULL;
 185         return list_node_to_entry(list->next);
 186 }
 187
 188 /**
 189  * udev_list_entry_get_next:
 190  * @list_entry: current entry
 191  *
 192  * Returns: the next entry from the list, #NULL is no more entries are found.
 193  */
 194 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry)
 195 {
 196         struct udev_list_node *next;
 197
 198         if (list_entry == NULL)
 199                 return NULL;
 200         next = list_entry->node.next;
 201         /* empty list or no more entries */
 202         if (next == list_entry->list)
 203                 return NULL;
 204         return list_node_to_entry(next);
 205 }
 206
 207 /**
 208  * udev_list_entry_get_by_name:
 209  * @list_entry: current entry
 210  * @name: name string to match
 211  *
 212  * Returns: the entry where @name matched, #NULL if no matching entry is found.
 213  */
 214 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name)
 215 {
 216         struct udev_list_entry *entry;
 217
 218         udev_list_entry_foreach(entry, list_entry) {
 219                 if (strcmp(udev_list_entry_get_name(entry), name) == 0) {
 220                         dbg(entry->udev, "found '%s=%s'\n", entry->name, entry->value);
 221                         return entry;
 222                 }
 223         }
 224         return NULL;
 225 }
 226
 227 /**
 228  * udev_list_entry_get_name:
 229  * @list_entry: current entry
 230  *
 231  * Returns: the name string of this entry.
 232  */
 233 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry)
 234 {
 235         if (list_entry == NULL)
 236                 return NULL;
 237         return list_entry->name;
 238 }
 239
 240 /**
 241  * udev_list_entry_get_value:
 242  * @list_entry: current entry
 243  *
 244  * Returns: the value string of this entry.
 245  */
 246 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry)
 247 {
 248         if (list_entry == NULL)
 249                 return NULL;
 250         return list_entry->value;
 251 }
 252
 253 int udev_list_entry_get_flag(struct udev_list_entry *list_entry)
 254 {
 255         if (list_entry == NULL)
 256                 return -EINVAL;
 257         return list_entry->flag;
 258 }
 259
 260 void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag)
 261 {
 262         if (list_entry == NULL)
 263                 return;
 264         list_entry->flag = flag;
 265 }