lib/kobject_uevent.c

   1 /*
   2  * kernel userspace event delivery
   3  *
   4  * Copyright (C) 2004 Red Hat, Inc.  All rights reserved.
   5  * Copyright (C) 2004 Novell, Inc.  All rights reserved.
   6  * Copyright (C) 2004 IBM, Inc. All rights reserved.
   7  *
   8  * Licensed under the GNU GPL v2.
   9  *
  10  * Authors:
  11  *      Robert Love             <rml@novell.com>
  12  *      Kay Sievers             <kay.sievers@vrfy.org>
  13  *      Arjan van de Ven        <arjanv@redhat.com>
  14  *      Greg Kroah-Hartman      <greg@kroah.com>
  15  */
  16
  17 #include <linux/spinlock.h>
  18 #include <linux/socket.h>
  19 #include <linux/skbuff.h>
  20 #include <linux/netlink.h>
  21 #include <linux/string.h>
  22 #include <linux/kobject.h>
  23 #include <net/sock.h>
  24
  25 #define BUFFER_SIZE     2048    /* buffer for the variables */
  26 #define NUM_ENVP        32      /* number of env pointers */
  27
  28 #if defined(CONFIG_HOTPLUG)
  29 u64 uevent_seqnum;
  30 char uevent_helper[UEVENT_HELPER_PATH_LEN] = "/sbin/hotplug";
  31 static DEFINE_SPINLOCK(sequence_lock);
  32 #if defined(CONFIG_NET)
  33 static struct sock *uevent_sock;
  34 #endif
  35
  36 static char *action_to_string(enum kobject_action action)
  37 {
  38         switch (action) {
  39         case KOBJ_ADD:
  40                 return "add";
  41         case KOBJ_REMOVE:
  42                 return "remove";
  43         case KOBJ_CHANGE:
  44                 return "change";
  45         case KOBJ_MOUNT:
  46                 return "mount";
  47         case KOBJ_UMOUNT:
  48                 return "umount";
  49         case KOBJ_OFFLINE:
  50                 return "offline";
  51         case KOBJ_ONLINE:
  52                 return "online";
  53         case KOBJ_MOVE:
  54                 return "move";
  55         default:
  56                 return NULL;
  57         }
  58 }
  59
  60 /**
  61  * kobject_uevent_env - send an uevent with environmental data
  62  *
  63  * @action: action that is happening (usually KOBJ_MOVE)
  64  * @kobj: struct kobject that the action is happening to
  65  * @envp_ext: pointer to environmental data
  66  *
  67  * Returns 0 if kobject_uevent() is completed with success or the
  68  * corresponding error when it fails.
  69  */
  70 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
  71                         char *envp_ext[])
  72 {
  73         char **envp;
  74         char *buffer;
  75         char *scratch;
  76         const char *action_string;
  77         const char *devpath = NULL;
  78         const char *subsystem;
  79         struct kobject *top_kobj;
  80         struct kset *kset;
  81         struct kset_uevent_ops *uevent_ops;
  82         u64 seq;
  83         char *seq_buff;
  84         int i = 0;
  85         int retval = 0;
  86         int j;
  87
  88         pr_debug("%s\n", __FUNCTION__);
  89
  90         action_string = action_to_string(action);
  91         if (!action_string) {
  92                 pr_debug("kobject attempted to send uevent without action_string!\n");
  93                 return -EINVAL;
  94         }
  95
  96         /* search the kset we belong to */
  97         top_kobj = kobj;
  98         if (!top_kobj->kset && top_kobj->parent) {
  99                 do {
 100                         top_kobj = top_kobj->parent;
 101                 } while (!top_kobj->kset && top_kobj->parent);
 102         }
 103         if (!top_kobj->kset) {
 104                 pr_debug("kobject attempted to send uevent without kset!\n");
 105                 return -EINVAL;
 106         }
 107
 108         kset = top_kobj->kset;
 109         uevent_ops = kset->uevent_ops;
 110
 111         /*  skip the event, if the filter returns zero. */
 112         if (uevent_ops && uevent_ops->filter)
 113                 if (!uevent_ops->filter(kset, kobj)) {
 114                         pr_debug("kobject filter function caused the event to drop!\n");
 115                         return 0;
 116                 }
 117
 118         /* originating subsystem */
 119         if (uevent_ops && uevent_ops->name)
 120                 subsystem = uevent_ops->name(kset, kobj);
 121         else
 122                 subsystem = kobject_name(&kset->kobj);
 123         if (!subsystem) {
 124                 pr_debug("unset subsytem caused the event to drop!\n");
 125                 return 0;
 126         }
 127
 128         /* environment index */
 129         envp = kzalloc(NUM_ENVP * sizeof (char *), GFP_KERNEL);
 130         if (!envp)
 131                 return -ENOMEM;
 132
 133         /* environment values */
 134         buffer = kmalloc(BUFFER_SIZE, GFP_KERNEL);
 135         if (!buffer) {
 136                 retval = -ENOMEM;
 137                 goto exit;
 138         }
 139
 140         /* complete object path */
 141         devpath = kobject_get_path(kobj, GFP_KERNEL);
 142         if (!devpath) {
 143                 retval = -ENOENT;
 144                 goto exit;
 145         }
 146
 147         /* event environemnt for helper process only */
 148         envp[i++] = "HOME=/";
 149         envp[i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
 150
 151         /* default keys */
 152         scratch = buffer;
 153         envp [i++] = scratch;
 154         scratch += sprintf(scratch, "ACTION=%s", action_string) + 1;
 155         envp [i++] = scratch;
 156         scratch += sprintf (scratch, "DEVPATH=%s", devpath) + 1;
 157         envp [i++] = scratch;
 158         scratch += sprintf(scratch, "SUBSYSTEM=%s", subsystem) + 1;
 159         for (j = 0; envp_ext && envp_ext[j]; j++)
 160                 envp[i++] = envp_ext[j];
 161         /* just reserve the space, overwrite it after kset call has returned */
 162         envp[i++] = seq_buff = scratch;
 163         scratch += strlen("SEQNUM=18446744073709551616") + 1;
 164
 165         /* let the kset specific function add its stuff */
 166         if (uevent_ops && uevent_ops->uevent) {
 167                 retval = uevent_ops->uevent(kset, kobj,
 168                                   &envp[i], NUM_ENVP - i, scratch,
 169                                   BUFFER_SIZE - (scratch - buffer));
 170                 if (retval) {
 171                         pr_debug ("%s - uevent() returned %d\n",
 172                                   __FUNCTION__, retval);
 173                         goto exit;
 174                 }
 175         }
 176
 177         /* we will send an event, request a new sequence number */
 178         spin_lock(&sequence_lock);
 179         seq = ++uevent_seqnum;
 180         spin_unlock(&sequence_lock);
 181         sprintf(seq_buff, "SEQNUM=%llu", (unsigned long long)seq);
 182
 183 #if defined(CONFIG_NET)
 184         /* send netlink message */
 185         if (uevent_sock) {
 186                 struct sk_buff *skb;
 187                 size_t len;
 188
 189                 /* allocate message with the maximum possible size */
 190                 len = strlen(action_string) + strlen(devpath) + 2;
 191                 skb = alloc_skb(len + BUFFER_SIZE, GFP_KERNEL);
 192                 if (skb) {
 193                         /* add header */
 194                         scratch = skb_put(skb, len);
 195                         sprintf(scratch, "%s@%s", action_string, devpath);
 196
 197                         /* copy keys to our continuous event payload buffer */
 198                         for (i = 2; envp[i]; i++) {
 199                                 len = strlen(envp[i]) + 1;
 200                                 scratch = skb_put(skb, len);
 201                                 strcpy(scratch, envp[i]);
 202                         }
 203
 204                         NETLINK_CB(skb).dst_group = 1;
 205                         netlink_broadcast(uevent_sock, skb, 0, 1, GFP_KERNEL);
 206                 }
 207         }
 208 #endif
 209
 210         /* call uevent_helper, usually only enabled during early boot */
 211         if (uevent_helper[0]) {
 212                 char *argv [3];
 213
 214                 argv [0] = uevent_helper;
 215                 argv [1] = (char *)subsystem;
 216                 argv [2] = NULL;
 217                 call_usermodehelper (argv[0], argv, envp, 0);
 218         }
 219
 220 exit:
 221         kfree(devpath);
 222         kfree(buffer);
 223         kfree(envp);
 224         return retval;
 225 }
 226
 227 EXPORT_SYMBOL_GPL(kobject_uevent_env);
 228
 229 /**
 230  * kobject_uevent - notify userspace by ending an uevent
 231  *
 232  * @action: action that is happening (usually KOBJ_ADD and KOBJ_REMOVE)
 233  * @kobj: struct kobject that the action is happening to
 234  *
 235  * Returns 0 if kobject_uevent() is completed with success or the
 236  * corresponding error when it fails.
 237  */
 238 int kobject_uevent(struct kobject *kobj, enum kobject_action action)
 239 {
 240         return kobject_uevent_env(kobj, action, NULL);
 241 }
 242
 243 EXPORT_SYMBOL_GPL(kobject_uevent);
 244
 245 /**
 246  * add_uevent_var - helper for creating event variables
 247  * @envp: Pointer to table of environment variables, as passed into
 248  * uevent() method.
 249  * @num_envp: Number of environment variable slots available, as
 250  * passed into uevent() method.
 251  * @cur_index: Pointer to current index into @envp.  It should be
 252  * initialized to 0 before the first call to add_uevent_var(),
 253  * and will be incremented on success.
 254  * @buffer: Pointer to buffer for environment variables, as passed
 255  * into uevent() method.
 256  * @buffer_size: Length of @buffer, as passed into uevent() method.
 257  * @cur_len: Pointer to current length of space used in @buffer.
 258  * Should be initialized to 0 before the first call to
 259  * add_uevent_var(), and will be incremented on success.
 260  * @format: Format for creating environment variable (of the form
 261  * "XXX=%x") for snprintf().
 262  *
 263  * Returns 0 if environment variable was added successfully or -ENOMEM
 264  * if no space was available.
 265  */
 266 int add_uevent_var(char **envp, int num_envp, int *cur_index,
 267                    char *buffer, int buffer_size, int *cur_len,
 268                    const char *format, ...)
 269 {
 270         va_list args;
 271
 272         /*
 273          * We check against num_envp - 1 to make sure there is at
 274          * least one slot left after we return, since kobject_uevent()
 275          * needs to set the last slot to NULL.
 276          */
 277         if (*cur_index >= num_envp - 1)
 278                 return -ENOMEM;
 279
 280         envp[*cur_index] = buffer + *cur_len;
 281
 282         va_start(args, format);
 283         *cur_len += vsnprintf(envp[*cur_index],
 284                               max(buffer_size - *cur_len, 0),
 285                               format, args) + 1;
 286         va_end(args);
 287
 288         if (*cur_len > buffer_size)
 289                 return -ENOMEM;
 290
 291         (*cur_index)++;
 292         return 0;
 293 }
 294 EXPORT_SYMBOL_GPL(add_uevent_var);
 295
 296 #if defined(CONFIG_NET)
 297 static int __init kobject_uevent_init(void)
 298 {
 299         uevent_sock = netlink_kernel_create(NETLINK_KOBJECT_UEVENT, 1, NULL,
 300                                             NULL, THIS_MODULE);
 301
 302         if (!uevent_sock) {
 303                 printk(KERN_ERR
 304                        "kobject_uevent: unable to create netlink socket!\n");
 305                 return -ENODEV;
 306         }
 307
 308         return 0;
 309 }
 310
 311 postcore_initcall(kobject_uevent_init);
 312 #endif
 313
 314 #endif /* CONFIG_HOTPLUG */