Input: adxl34x - do not treat FIFO_MODE() as boolean
[sfrench/cifs-2.6.git] / 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/string.h>
19 #include <linux/kobject.h>
20 #include <linux/export.h>
21 #include <linux/kmod.h>
22 #include <linux/slab.h>
23 #include <linux/socket.h>
24 #include <linux/skbuff.h>
25 #include <linux/netlink.h>
26 #include <net/sock.h>
27 #include <net/net_namespace.h>
28
29
30 u64 uevent_seqnum;
31 #ifdef CONFIG_UEVENT_HELPER
32 char uevent_helper[UEVENT_HELPER_PATH_LEN] = CONFIG_UEVENT_HELPER_PATH;
33 #endif
34 #ifdef CONFIG_NET
35 struct uevent_sock {
36         struct list_head list;
37         struct sock *sk;
38 };
39 static LIST_HEAD(uevent_sock_list);
40 #endif
41
42 /* This lock protects uevent_seqnum and uevent_sock_list */
43 static DEFINE_MUTEX(uevent_sock_mutex);
44
45 /* the strings here must match the enum in include/linux/kobject.h */
46 static const char *kobject_actions[] = {
47         [KOBJ_ADD] =            "add",
48         [KOBJ_REMOVE] =         "remove",
49         [KOBJ_CHANGE] =         "change",
50         [KOBJ_MOVE] =           "move",
51         [KOBJ_ONLINE] =         "online",
52         [KOBJ_OFFLINE] =        "offline",
53         [KOBJ_BIND] =           "bind",
54         [KOBJ_UNBIND] =         "unbind",
55 };
56
57 /**
58  * kobject_action_type - translate action string to numeric type
59  *
60  * @buf: buffer containing the action string, newline is ignored
61  * @count: length of buffer
62  * @type: pointer to the location to store the action type
63  *
64  * Returns 0 if the action string was recognized.
65  */
66 int kobject_action_type(const char *buf, size_t count,
67                         enum kobject_action *type)
68 {
69         enum kobject_action action;
70         int ret = -EINVAL;
71
72         if (count && (buf[count-1] == '\n' || buf[count-1] == '\0'))
73                 count--;
74
75         if (!count)
76                 goto out;
77
78         for (action = 0; action < ARRAY_SIZE(kobject_actions); action++) {
79                 if (strncmp(kobject_actions[action], buf, count) != 0)
80                         continue;
81                 if (kobject_actions[action][count] != '\0')
82                         continue;
83                 *type = action;
84                 ret = 0;
85                 break;
86         }
87 out:
88         return ret;
89 }
90
91 #ifdef CONFIG_NET
92 static int kobj_bcast_filter(struct sock *dsk, struct sk_buff *skb, void *data)
93 {
94         struct kobject *kobj = data, *ksobj;
95         const struct kobj_ns_type_operations *ops;
96
97         ops = kobj_ns_ops(kobj);
98         if (!ops && kobj->kset) {
99                 ksobj = &kobj->kset->kobj;
100                 if (ksobj->parent != NULL)
101                         ops = kobj_ns_ops(ksobj->parent);
102         }
103
104         if (ops && ops->netlink_ns && kobj->ktype->namespace) {
105                 const void *sock_ns, *ns;
106                 ns = kobj->ktype->namespace(kobj);
107                 sock_ns = ops->netlink_ns(dsk);
108                 return sock_ns != ns;
109         }
110
111         return 0;
112 }
113 #endif
114
115 #ifdef CONFIG_UEVENT_HELPER
116 static int kobj_usermode_filter(struct kobject *kobj)
117 {
118         const struct kobj_ns_type_operations *ops;
119
120         ops = kobj_ns_ops(kobj);
121         if (ops) {
122                 const void *init_ns, *ns;
123                 ns = kobj->ktype->namespace(kobj);
124                 init_ns = ops->initial_ns();
125                 return ns != init_ns;
126         }
127
128         return 0;
129 }
130
131 static int init_uevent_argv(struct kobj_uevent_env *env, const char *subsystem)
132 {
133         int len;
134
135         len = strlcpy(&env->buf[env->buflen], subsystem,
136                       sizeof(env->buf) - env->buflen);
137         if (len >= (sizeof(env->buf) - env->buflen)) {
138                 WARN(1, KERN_ERR "init_uevent_argv: buffer size too small\n");
139                 return -ENOMEM;
140         }
141
142         env->argv[0] = uevent_helper;
143         env->argv[1] = &env->buf[env->buflen];
144         env->argv[2] = NULL;
145
146         env->buflen += len + 1;
147         return 0;
148 }
149
150 static void cleanup_uevent_env(struct subprocess_info *info)
151 {
152         kfree(info->data);
153 }
154 #endif
155
156 /**
157  * kobject_uevent_env - send an uevent with environmental data
158  *
159  * @kobj: struct kobject that the action is happening to
160  * @action: action that is happening
161  * @envp_ext: pointer to environmental data
162  *
163  * Returns 0 if kobject_uevent_env() is completed with success or the
164  * corresponding error when it fails.
165  */
166 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
167                        char *envp_ext[])
168 {
169         struct kobj_uevent_env *env;
170         const char *action_string = kobject_actions[action];
171         const char *devpath = NULL;
172         const char *subsystem;
173         struct kobject *top_kobj;
174         struct kset *kset;
175         const struct kset_uevent_ops *uevent_ops;
176         int i = 0;
177         int retval = 0;
178 #ifdef CONFIG_NET
179         struct uevent_sock *ue_sk;
180 #endif
181
182         pr_debug("kobject: '%s' (%p): %s\n",
183                  kobject_name(kobj), kobj, __func__);
184
185         /* search the kset we belong to */
186         top_kobj = kobj;
187         while (!top_kobj->kset && top_kobj->parent)
188                 top_kobj = top_kobj->parent;
189
190         if (!top_kobj->kset) {
191                 pr_debug("kobject: '%s' (%p): %s: attempted to send uevent "
192                          "without kset!\n", kobject_name(kobj), kobj,
193                          __func__);
194                 return -EINVAL;
195         }
196
197         kset = top_kobj->kset;
198         uevent_ops = kset->uevent_ops;
199
200         /* skip the event, if uevent_suppress is set*/
201         if (kobj->uevent_suppress) {
202                 pr_debug("kobject: '%s' (%p): %s: uevent_suppress "
203                                  "caused the event to drop!\n",
204                                  kobject_name(kobj), kobj, __func__);
205                 return 0;
206         }
207         /* skip the event, if the filter returns zero. */
208         if (uevent_ops && uevent_ops->filter)
209                 if (!uevent_ops->filter(kset, kobj)) {
210                         pr_debug("kobject: '%s' (%p): %s: filter function "
211                                  "caused the event to drop!\n",
212                                  kobject_name(kobj), kobj, __func__);
213                         return 0;
214                 }
215
216         /* originating subsystem */
217         if (uevent_ops && uevent_ops->name)
218                 subsystem = uevent_ops->name(kset, kobj);
219         else
220                 subsystem = kobject_name(&kset->kobj);
221         if (!subsystem) {
222                 pr_debug("kobject: '%s' (%p): %s: unset subsystem caused the "
223                          "event to drop!\n", kobject_name(kobj), kobj,
224                          __func__);
225                 return 0;
226         }
227
228         /* environment buffer */
229         env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
230         if (!env)
231                 return -ENOMEM;
232
233         /* complete object path */
234         devpath = kobject_get_path(kobj, GFP_KERNEL);
235         if (!devpath) {
236                 retval = -ENOENT;
237                 goto exit;
238         }
239
240         /* default keys */
241         retval = add_uevent_var(env, "ACTION=%s", action_string);
242         if (retval)
243                 goto exit;
244         retval = add_uevent_var(env, "DEVPATH=%s", devpath);
245         if (retval)
246                 goto exit;
247         retval = add_uevent_var(env, "SUBSYSTEM=%s", subsystem);
248         if (retval)
249                 goto exit;
250
251         /* keys passed in from the caller */
252         if (envp_ext) {
253                 for (i = 0; envp_ext[i]; i++) {
254                         retval = add_uevent_var(env, "%s", envp_ext[i]);
255                         if (retval)
256                                 goto exit;
257                 }
258         }
259
260         /* let the kset specific function add its stuff */
261         if (uevent_ops && uevent_ops->uevent) {
262                 retval = uevent_ops->uevent(kset, kobj, env);
263                 if (retval) {
264                         pr_debug("kobject: '%s' (%p): %s: uevent() returned "
265                                  "%d\n", kobject_name(kobj), kobj,
266                                  __func__, retval);
267                         goto exit;
268                 }
269         }
270
271         /*
272          * Mark "add" and "remove" events in the object to ensure proper
273          * events to userspace during automatic cleanup. If the object did
274          * send an "add" event, "remove" will automatically generated by
275          * the core, if not already done by the caller.
276          */
277         if (action == KOBJ_ADD)
278                 kobj->state_add_uevent_sent = 1;
279         else if (action == KOBJ_REMOVE)
280                 kobj->state_remove_uevent_sent = 1;
281
282         mutex_lock(&uevent_sock_mutex);
283         /* we will send an event, so request a new sequence number */
284         retval = add_uevent_var(env, "SEQNUM=%llu", (unsigned long long)++uevent_seqnum);
285         if (retval) {
286                 mutex_unlock(&uevent_sock_mutex);
287                 goto exit;
288         }
289
290 #if defined(CONFIG_NET)
291         /* send netlink message */
292         list_for_each_entry(ue_sk, &uevent_sock_list, list) {
293                 struct sock *uevent_sock = ue_sk->sk;
294                 struct sk_buff *skb;
295                 size_t len;
296
297                 if (!netlink_has_listeners(uevent_sock, 1))
298                         continue;
299
300                 /* allocate message with the maximum possible size */
301                 len = strlen(action_string) + strlen(devpath) + 2;
302                 skb = alloc_skb(len + env->buflen, GFP_KERNEL);
303                 if (skb) {
304                         char *scratch;
305
306                         /* add header */
307                         scratch = skb_put(skb, len);
308                         sprintf(scratch, "%s@%s", action_string, devpath);
309
310                         /* copy keys to our continuous event payload buffer */
311                         for (i = 0; i < env->envp_idx; i++) {
312                                 len = strlen(env->envp[i]) + 1;
313                                 scratch = skb_put(skb, len);
314                                 strcpy(scratch, env->envp[i]);
315                         }
316
317                         NETLINK_CB(skb).dst_group = 1;
318                         retval = netlink_broadcast_filtered(uevent_sock, skb,
319                                                             0, 1, GFP_KERNEL,
320                                                             kobj_bcast_filter,
321                                                             kobj);
322                         /* ENOBUFS should be handled in userspace */
323                         if (retval == -ENOBUFS || retval == -ESRCH)
324                                 retval = 0;
325                 } else
326                         retval = -ENOMEM;
327         }
328 #endif
329         mutex_unlock(&uevent_sock_mutex);
330
331 #ifdef CONFIG_UEVENT_HELPER
332         /* call uevent_helper, usually only enabled during early boot */
333         if (uevent_helper[0] && !kobj_usermode_filter(kobj)) {
334                 struct subprocess_info *info;
335
336                 retval = add_uevent_var(env, "HOME=/");
337                 if (retval)
338                         goto exit;
339                 retval = add_uevent_var(env,
340                                         "PATH=/sbin:/bin:/usr/sbin:/usr/bin");
341                 if (retval)
342                         goto exit;
343                 retval = init_uevent_argv(env, subsystem);
344                 if (retval)
345                         goto exit;
346
347                 retval = -ENOMEM;
348                 info = call_usermodehelper_setup(env->argv[0], env->argv,
349                                                  env->envp, GFP_KERNEL,
350                                                  NULL, cleanup_uevent_env, env);
351                 if (info) {
352                         retval = call_usermodehelper_exec(info, UMH_NO_WAIT);
353                         env = NULL;     /* freed by cleanup_uevent_env */
354                 }
355         }
356 #endif
357
358 exit:
359         kfree(devpath);
360         kfree(env);
361         return retval;
362 }
363 EXPORT_SYMBOL_GPL(kobject_uevent_env);
364
365 /**
366  * kobject_uevent - notify userspace by sending an uevent
367  *
368  * @kobj: struct kobject that the action is happening to
369  * @action: action that is happening
370  *
371  * Returns 0 if kobject_uevent() is completed with success or the
372  * corresponding error when it fails.
373  */
374 int kobject_uevent(struct kobject *kobj, enum kobject_action action)
375 {
376         return kobject_uevent_env(kobj, action, NULL);
377 }
378 EXPORT_SYMBOL_GPL(kobject_uevent);
379
380 /**
381  * add_uevent_var - add key value string to the environment buffer
382  * @env: environment buffer structure
383  * @format: printf format for the key=value pair
384  *
385  * Returns 0 if environment variable was added successfully or -ENOMEM
386  * if no space was available.
387  */
388 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
389 {
390         va_list args;
391         int len;
392
393         if (env->envp_idx >= ARRAY_SIZE(env->envp)) {
394                 WARN(1, KERN_ERR "add_uevent_var: too many keys\n");
395                 return -ENOMEM;
396         }
397
398         va_start(args, format);
399         len = vsnprintf(&env->buf[env->buflen],
400                         sizeof(env->buf) - env->buflen,
401                         format, args);
402         va_end(args);
403
404         if (len >= (sizeof(env->buf) - env->buflen)) {
405                 WARN(1, KERN_ERR "add_uevent_var: buffer size too small\n");
406                 return -ENOMEM;
407         }
408
409         env->envp[env->envp_idx++] = &env->buf[env->buflen];
410         env->buflen += len + 1;
411         return 0;
412 }
413 EXPORT_SYMBOL_GPL(add_uevent_var);
414
415 #if defined(CONFIG_NET)
416 static int uevent_net_init(struct net *net)
417 {
418         struct uevent_sock *ue_sk;
419         struct netlink_kernel_cfg cfg = {
420                 .groups = 1,
421                 .flags  = NL_CFG_F_NONROOT_RECV,
422         };
423
424         ue_sk = kzalloc(sizeof(*ue_sk), GFP_KERNEL);
425         if (!ue_sk)
426                 return -ENOMEM;
427
428         ue_sk->sk = netlink_kernel_create(net, NETLINK_KOBJECT_UEVENT, &cfg);
429         if (!ue_sk->sk) {
430                 printk(KERN_ERR
431                        "kobject_uevent: unable to create netlink socket!\n");
432                 kfree(ue_sk);
433                 return -ENODEV;
434         }
435         mutex_lock(&uevent_sock_mutex);
436         list_add_tail(&ue_sk->list, &uevent_sock_list);
437         mutex_unlock(&uevent_sock_mutex);
438         return 0;
439 }
440
441 static void uevent_net_exit(struct net *net)
442 {
443         struct uevent_sock *ue_sk;
444
445         mutex_lock(&uevent_sock_mutex);
446         list_for_each_entry(ue_sk, &uevent_sock_list, list) {
447                 if (sock_net(ue_sk->sk) == net)
448                         goto found;
449         }
450         mutex_unlock(&uevent_sock_mutex);
451         return;
452
453 found:
454         list_del(&ue_sk->list);
455         mutex_unlock(&uevent_sock_mutex);
456
457         netlink_kernel_release(ue_sk->sk);
458         kfree(ue_sk);
459 }
460
461 static struct pernet_operations uevent_net_ops = {
462         .init   = uevent_net_init,
463         .exit   = uevent_net_exit,
464 };
465
466 static int __init kobject_uevent_init(void)
467 {
468         return register_pernet_subsys(&uevent_net_ops);
469 }
470
471
472 postcore_initcall(kobject_uevent_init);
473 #endif