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 <linux/uuid.h> 27 #include <linux/ctype.h> 28 #include <net/sock.h> 29 #include <net/net_namespace.h> 30 31 32 u64 uevent_seqnum; 33 #ifdef CONFIG_UEVENT_HELPER 34 char uevent_helper[UEVENT_HELPER_PATH_LEN] = CONFIG_UEVENT_HELPER_PATH; 35 #endif 36 #ifdef CONFIG_NET 37 struct uevent_sock { 38 struct list_head list; 39 struct sock *sk; 40 }; 41 static LIST_HEAD(uevent_sock_list); 42 #endif 43 44 /* This lock protects uevent_seqnum and uevent_sock_list */ 45 static DEFINE_MUTEX(uevent_sock_mutex); 46 47 /* the strings here must match the enum in include/linux/kobject.h */ 48 static const char *kobject_actions[] = { 49 [KOBJ_ADD] = "add", 50 [KOBJ_REMOVE] = "remove", 51 [KOBJ_CHANGE] = "change", 52 [KOBJ_MOVE] = "move", 53 [KOBJ_ONLINE] = "online", 54 [KOBJ_OFFLINE] = "offline", 55 [KOBJ_BIND] = "bind", 56 [KOBJ_UNBIND] = "unbind", 57 }; 58 59 static int kobject_action_type(const char *buf, size_t count, 60 enum kobject_action *type, 61 const char **args) 62 { 63 enum kobject_action action; 64 size_t count_first; 65 const char *args_start; 66 int ret = -EINVAL; 67 68 if (count && (buf[count-1] == '\n' || buf[count-1] == '\0')) 69 count--; 70 71 if (!count) 72 goto out; 73 74 args_start = strnchr(buf, count, ' '); 75 if (args_start) { 76 count_first = args_start - buf; 77 args_start = args_start + 1; 78 } else 79 count_first = count; 80 81 for (action = 0; action < ARRAY_SIZE(kobject_actions); action++) { 82 if (strncmp(kobject_actions[action], buf, count_first) != 0) 83 continue; 84 if (kobject_actions[action][count_first] != '\0') 85 continue; 86 if (args) 87 *args = args_start; 88 *type = action; 89 ret = 0; 90 break; 91 } 92 out: 93 return ret; 94 } 95 96 static const char *action_arg_word_end(const char *buf, const char *buf_end, 97 char delim) 98 { 99 const char *next = buf; 100 101 while (next <= buf_end && *next != delim) 102 if (!isalnum(*next++)) 103 return NULL; 104 105 if (next == buf) 106 return NULL; 107 108 return next; 109 } 110 111 static int kobject_action_args(const char *buf, size_t count, 112 struct kobj_uevent_env **ret_env) 113 { 114 struct kobj_uevent_env *env = NULL; 115 const char *next, *buf_end, *key; 116 int key_len; 117 int r = -EINVAL; 118 119 if (count && (buf[count - 1] == '\n' || buf[count - 1] == '\0')) 120 count--; 121 122 if (!count) 123 return -EINVAL; 124 125 env = kzalloc(sizeof(*env), GFP_KERNEL); 126 if (!env) 127 return -ENOMEM; 128 129 /* first arg is UUID */ 130 if (count < UUID_STRING_LEN || !uuid_is_valid(buf) || 131 add_uevent_var(env, "SYNTH_UUID=%.*s", UUID_STRING_LEN, buf)) 132 goto out; 133 134 /* 135 * the rest are custom environment variables in KEY=VALUE 136 * format with ' ' delimiter between each KEY=VALUE pair 137 */ 138 next = buf + UUID_STRING_LEN; 139 buf_end = buf + count - 1; 140 141 while (next <= buf_end) { 142 if (*next != ' ') 143 goto out; 144 145 /* skip the ' ', key must follow */ 146 key = ++next; 147 if (key > buf_end) 148 goto out; 149 150 buf = next; 151 next = action_arg_word_end(buf, buf_end, '='); 152 if (!next || next > buf_end || *next != '=') 153 goto out; 154 key_len = next - buf; 155 156 /* skip the '=', value must follow */ 157 if (++next > buf_end) 158 goto out; 159 160 buf = next; 161 next = action_arg_word_end(buf, buf_end, ' '); 162 if (!next) 163 goto out; 164 165 if (add_uevent_var(env, "SYNTH_ARG_%.*s=%.*s", 166 key_len, key, (int) (next - buf), buf)) 167 goto out; 168 } 169 170 r = 0; 171 out: 172 if (r) 173 kfree(env); 174 else 175 *ret_env = env; 176 return r; 177 } 178 179 /** 180 * kobject_synth_uevent - send synthetic uevent with arguments 181 * 182 * @kobj: struct kobject for which synthetic uevent is to be generated 183 * @buf: buffer containing action type and action args, newline is ignored 184 * @count: length of buffer 185 * 186 * Returns 0 if kobject_synthetic_uevent() is completed with success or the 187 * corresponding error when it fails. 188 */ 189 int kobject_synth_uevent(struct kobject *kobj, const char *buf, size_t count) 190 { 191 char *no_uuid_envp[] = { "SYNTH_UUID=0", NULL }; 192 enum kobject_action action; 193 const char *action_args; 194 struct kobj_uevent_env *env; 195 const char *msg = NULL, *devpath; 196 int r; 197 198 r = kobject_action_type(buf, count, &action, &action_args); 199 if (r) { 200 msg = "unknown uevent action string\n"; 201 goto out; 202 } 203 204 if (!action_args) { 205 r = kobject_uevent_env(kobj, action, no_uuid_envp); 206 goto out; 207 } 208 209 r = kobject_action_args(action_args, 210 count - (action_args - buf), &env); 211 if (r == -EINVAL) { 212 msg = "incorrect uevent action arguments\n"; 213 goto out; 214 } 215 216 if (r) 217 goto out; 218 219 r = kobject_uevent_env(kobj, action, env->envp); 220 kfree(env); 221 out: 222 if (r) { 223 devpath = kobject_get_path(kobj, GFP_KERNEL); 224 printk(KERN_WARNING "synth uevent: %s: %s", 225 devpath ?: "unknown device", 226 msg ?: "failed to send uevent"); 227 kfree(devpath); 228 } 229 return r; 230 } 231 232 #ifdef CONFIG_NET 233 static int kobj_bcast_filter(struct sock *dsk, struct sk_buff *skb, void *data) 234 { 235 struct kobject *kobj = data, *ksobj; 236 const struct kobj_ns_type_operations *ops; 237 238 ops = kobj_ns_ops(kobj); 239 if (!ops && kobj->kset) { 240 ksobj = &kobj->kset->kobj; 241 if (ksobj->parent != NULL) 242 ops = kobj_ns_ops(ksobj->parent); 243 } 244 245 if (ops && ops->netlink_ns && kobj->ktype->namespace) { 246 const void *sock_ns, *ns; 247 ns = kobj->ktype->namespace(kobj); 248 sock_ns = ops->netlink_ns(dsk); 249 return sock_ns != ns; 250 } 251 252 return 0; 253 } 254 #endif 255 256 #ifdef CONFIG_UEVENT_HELPER 257 static int kobj_usermode_filter(struct kobject *kobj) 258 { 259 const struct kobj_ns_type_operations *ops; 260 261 ops = kobj_ns_ops(kobj); 262 if (ops) { 263 const void *init_ns, *ns; 264 ns = kobj->ktype->namespace(kobj); 265 init_ns = ops->initial_ns(); 266 return ns != init_ns; 267 } 268 269 return 0; 270 } 271 272 static int init_uevent_argv(struct kobj_uevent_env *env, const char *subsystem) 273 { 274 int len; 275 276 len = strlcpy(&env->buf[env->buflen], subsystem, 277 sizeof(env->buf) - env->buflen); 278 if (len >= (sizeof(env->buf) - env->buflen)) { 279 WARN(1, KERN_ERR "init_uevent_argv: buffer size too small\n"); 280 return -ENOMEM; 281 } 282 283 env->argv[0] = uevent_helper; 284 env->argv[1] = &env->buf[env->buflen]; 285 env->argv[2] = NULL; 286 287 env->buflen += len + 1; 288 return 0; 289 } 290 291 static void cleanup_uevent_env(struct subprocess_info *info) 292 { 293 kfree(info->data); 294 } 295 #endif 296 297 /** 298 * kobject_uevent_env - send an uevent with environmental data 299 * 300 * @kobj: struct kobject that the action is happening to 301 * @action: action that is happening 302 * @envp_ext: pointer to environmental data 303 * 304 * Returns 0 if kobject_uevent_env() is completed with success or the 305 * corresponding error when it fails. 306 */ 307 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, 308 char *envp_ext[]) 309 { 310 struct kobj_uevent_env *env; 311 const char *action_string = kobject_actions[action]; 312 const char *devpath = NULL; 313 const char *subsystem; 314 struct kobject *top_kobj; 315 struct kset *kset; 316 const struct kset_uevent_ops *uevent_ops; 317 int i = 0; 318 int retval = 0; 319 #ifdef CONFIG_NET 320 struct uevent_sock *ue_sk; 321 #endif 322 323 pr_debug("kobject: '%s' (%p): %s\n", 324 kobject_name(kobj), kobj, __func__); 325 326 /* search the kset we belong to */ 327 top_kobj = kobj; 328 while (!top_kobj->kset && top_kobj->parent) 329 top_kobj = top_kobj->parent; 330 331 if (!top_kobj->kset) { 332 pr_debug("kobject: '%s' (%p): %s: attempted to send uevent " 333 "without kset!\n", kobject_name(kobj), kobj, 334 __func__); 335 return -EINVAL; 336 } 337 338 kset = top_kobj->kset; 339 uevent_ops = kset->uevent_ops; 340 341 /* skip the event, if uevent_suppress is set*/ 342 if (kobj->uevent_suppress) { 343 pr_debug("kobject: '%s' (%p): %s: uevent_suppress " 344 "caused the event to drop!\n", 345 kobject_name(kobj), kobj, __func__); 346 return 0; 347 } 348 /* skip the event, if the filter returns zero. */ 349 if (uevent_ops && uevent_ops->filter) 350 if (!uevent_ops->filter(kset, kobj)) { 351 pr_debug("kobject: '%s' (%p): %s: filter function " 352 "caused the event to drop!\n", 353 kobject_name(kobj), kobj, __func__); 354 return 0; 355 } 356 357 /* originating subsystem */ 358 if (uevent_ops && uevent_ops->name) 359 subsystem = uevent_ops->name(kset, kobj); 360 else 361 subsystem = kobject_name(&kset->kobj); 362 if (!subsystem) { 363 pr_debug("kobject: '%s' (%p): %s: unset subsystem caused the " 364 "event to drop!\n", kobject_name(kobj), kobj, 365 __func__); 366 return 0; 367 } 368 369 /* environment buffer */ 370 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL); 371 if (!env) 372 return -ENOMEM; 373 374 /* complete object path */ 375 devpath = kobject_get_path(kobj, GFP_KERNEL); 376 if (!devpath) { 377 retval = -ENOENT; 378 goto exit; 379 } 380 381 /* default keys */ 382 retval = add_uevent_var(env, "ACTION=%s", action_string); 383 if (retval) 384 goto exit; 385 retval = add_uevent_var(env, "DEVPATH=%s", devpath); 386 if (retval) 387 goto exit; 388 retval = add_uevent_var(env, "SUBSYSTEM=%s", subsystem); 389 if (retval) 390 goto exit; 391 392 /* keys passed in from the caller */ 393 if (envp_ext) { 394 for (i = 0; envp_ext[i]; i++) { 395 retval = add_uevent_var(env, "%s", envp_ext[i]); 396 if (retval) 397 goto exit; 398 } 399 } 400 401 /* let the kset specific function add its stuff */ 402 if (uevent_ops && uevent_ops->uevent) { 403 retval = uevent_ops->uevent(kset, kobj, env); 404 if (retval) { 405 pr_debug("kobject: '%s' (%p): %s: uevent() returned " 406 "%d\n", kobject_name(kobj), kobj, 407 __func__, retval); 408 goto exit; 409 } 410 } 411 412 /* 413 * Mark "add" and "remove" events in the object to ensure proper 414 * events to userspace during automatic cleanup. If the object did 415 * send an "add" event, "remove" will automatically generated by 416 * the core, if not already done by the caller. 417 */ 418 if (action == KOBJ_ADD) 419 kobj->state_add_uevent_sent = 1; 420 else if (action == KOBJ_REMOVE) 421 kobj->state_remove_uevent_sent = 1; 422 423 mutex_lock(&uevent_sock_mutex); 424 /* we will send an event, so request a new sequence number */ 425 retval = add_uevent_var(env, "SEQNUM=%llu", (unsigned long long)++uevent_seqnum); 426 if (retval) { 427 mutex_unlock(&uevent_sock_mutex); 428 goto exit; 429 } 430 431 #if defined(CONFIG_NET) 432 /* send netlink message */ 433 list_for_each_entry(ue_sk, &uevent_sock_list, list) { 434 struct sock *uevent_sock = ue_sk->sk; 435 struct sk_buff *skb; 436 size_t len; 437 438 if (!netlink_has_listeners(uevent_sock, 1)) 439 continue; 440 441 /* allocate message with the maximum possible size */ 442 len = strlen(action_string) + strlen(devpath) + 2; 443 skb = alloc_skb(len + env->buflen, GFP_KERNEL); 444 if (skb) { 445 char *scratch; 446 447 /* add header */ 448 scratch = skb_put(skb, len); 449 sprintf(scratch, "%s@%s", action_string, devpath); 450 451 /* copy keys to our continuous event payload buffer */ 452 for (i = 0; i < env->envp_idx; i++) { 453 len = strlen(env->envp[i]) + 1; 454 scratch = skb_put(skb, len); 455 strcpy(scratch, env->envp[i]); 456 } 457 458 NETLINK_CB(skb).dst_group = 1; 459 retval = netlink_broadcast_filtered(uevent_sock, skb, 460 0, 1, GFP_KERNEL, 461 kobj_bcast_filter, 462 kobj); 463 /* ENOBUFS should be handled in userspace */ 464 if (retval == -ENOBUFS || retval == -ESRCH) 465 retval = 0; 466 } else 467 retval = -ENOMEM; 468 } 469 #endif 470 mutex_unlock(&uevent_sock_mutex); 471 472 #ifdef CONFIG_UEVENT_HELPER 473 /* call uevent_helper, usually only enabled during early boot */ 474 if (uevent_helper[0] && !kobj_usermode_filter(kobj)) { 475 struct subprocess_info *info; 476 477 retval = add_uevent_var(env, "HOME=/"); 478 if (retval) 479 goto exit; 480 retval = add_uevent_var(env, 481 "PATH=/sbin:/bin:/usr/sbin:/usr/bin"); 482 if (retval) 483 goto exit; 484 retval = init_uevent_argv(env, subsystem); 485 if (retval) 486 goto exit; 487 488 retval = -ENOMEM; 489 info = call_usermodehelper_setup(env->argv[0], env->argv, 490 env->envp, GFP_KERNEL, 491 NULL, cleanup_uevent_env, env); 492 if (info) { 493 retval = call_usermodehelper_exec(info, UMH_NO_WAIT); 494 env = NULL; /* freed by cleanup_uevent_env */ 495 } 496 } 497 #endif 498 499 exit: 500 kfree(devpath); 501 kfree(env); 502 return retval; 503 } 504 EXPORT_SYMBOL_GPL(kobject_uevent_env); 505 506 /** 507 * kobject_uevent - notify userspace by sending an uevent 508 * 509 * @kobj: struct kobject that the action is happening to 510 * @action: action that is happening 511 * 512 * Returns 0 if kobject_uevent() is completed with success or the 513 * corresponding error when it fails. 514 */ 515 int kobject_uevent(struct kobject *kobj, enum kobject_action action) 516 { 517 return kobject_uevent_env(kobj, action, NULL); 518 } 519 EXPORT_SYMBOL_GPL(kobject_uevent); 520 521 /** 522 * add_uevent_var - add key value string to the environment buffer 523 * @env: environment buffer structure 524 * @format: printf format for the key=value pair 525 * 526 * Returns 0 if environment variable was added successfully or -ENOMEM 527 * if no space was available. 528 */ 529 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...) 530 { 531 va_list args; 532 int len; 533 534 if (env->envp_idx >= ARRAY_SIZE(env->envp)) { 535 WARN(1, KERN_ERR "add_uevent_var: too many keys\n"); 536 return -ENOMEM; 537 } 538 539 va_start(args, format); 540 len = vsnprintf(&env->buf[env->buflen], 541 sizeof(env->buf) - env->buflen, 542 format, args); 543 va_end(args); 544 545 if (len >= (sizeof(env->buf) - env->buflen)) { 546 WARN(1, KERN_ERR "add_uevent_var: buffer size too small\n"); 547 return -ENOMEM; 548 } 549 550 env->envp[env->envp_idx++] = &env->buf[env->buflen]; 551 env->buflen += len + 1; 552 return 0; 553 } 554 EXPORT_SYMBOL_GPL(add_uevent_var); 555 556 #if defined(CONFIG_NET) 557 static int uevent_net_init(struct net *net) 558 { 559 struct uevent_sock *ue_sk; 560 struct netlink_kernel_cfg cfg = { 561 .groups = 1, 562 .flags = NL_CFG_F_NONROOT_RECV, 563 }; 564 565 ue_sk = kzalloc(sizeof(*ue_sk), GFP_KERNEL); 566 if (!ue_sk) 567 return -ENOMEM; 568 569 ue_sk->sk = netlink_kernel_create(net, NETLINK_KOBJECT_UEVENT, &cfg); 570 if (!ue_sk->sk) { 571 printk(KERN_ERR 572 "kobject_uevent: unable to create netlink socket!\n"); 573 kfree(ue_sk); 574 return -ENODEV; 575 } 576 mutex_lock(&uevent_sock_mutex); 577 list_add_tail(&ue_sk->list, &uevent_sock_list); 578 mutex_unlock(&uevent_sock_mutex); 579 return 0; 580 } 581 582 static void uevent_net_exit(struct net *net) 583 { 584 struct uevent_sock *ue_sk; 585 586 mutex_lock(&uevent_sock_mutex); 587 list_for_each_entry(ue_sk, &uevent_sock_list, list) { 588 if (sock_net(ue_sk->sk) == net) 589 goto found; 590 } 591 mutex_unlock(&uevent_sock_mutex); 592 return; 593 594 found: 595 list_del(&ue_sk->list); 596 mutex_unlock(&uevent_sock_mutex); 597 598 netlink_kernel_release(ue_sk->sk); 599 kfree(ue_sk); 600 } 601 602 static struct pernet_operations uevent_net_ops = { 603 .init = uevent_net_init, 604 .exit = uevent_net_exit, 605 }; 606 607 static int __init kobject_uevent_init(void) 608 { 609 return register_pernet_subsys(&uevent_net_ops); 610 } 611 612 613 postcore_initcall(kobject_uevent_init); 614 #endif 615