udev/lib/libudev-monitor.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 #include <dirent.h>
  19 #include <sys/stat.h>
  20 #include <sys/socket.h>
  21 #include <sys/un.h>
  22 #include <linux/netlink.h>
  23
  24 #include "libudev.h"
  25 #include "libudev-private.h"
  26
  27 struct udev_monitor {
  28         struct udev *udev;
  29         int refcount;
  30         int sock;
  31         struct sockaddr_nl snl;
  32         struct sockaddr_nl snl_peer;
  33         struct sockaddr_un sun;
  34         socklen_t addrlen;
  35 };
  36
  37 enum udev_monitor_netlink_group {
  38         UDEV_MONITOR_KERNEL     = 1,
  39         UDEV_MONITOR_UDEV       = 2,
  40 };
  41
  42 /**
  43  * udev_monitor_new_from_socket:
  44  * @udev: udev library context
  45  * @socket_path: unix socket path
  46  *
  47  * Create new udev monitor, setup and connect to a specified socket. The
  48  * path to a socket can point to an existing socket file, or it will be
  49  * created if needed. If neccessary, the permissions adjustment as well as
  50  * the later cleanup of the socket file, needs to be done by the caller.
  51  * If the socket path starts with a '@' character, an abstract namespace
  52  * socket will be used.
  53  *
  54  * The initial refcount is 1, and needs to be decremented to
  55  * release the resources of the udev monitor.
  56  *
  57  * Returns: a new udev monitor, or #NULL, in case of an error
  58  **/
  59 struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path)
  60 {
  61         struct udev_monitor *udev_monitor;
  62         struct stat statbuf;
  63
  64         if (udev == NULL)
  65                 return NULL;
  66         if (socket_path == NULL)
  67                 return NULL;
  68         udev_monitor = calloc(1, sizeof(struct udev_monitor));
  69         if (udev_monitor == NULL)
  70                 return NULL;
  71         udev_monitor->refcount = 1;
  72         udev_monitor->udev = udev;
  73
  74         udev_monitor->sun.sun_family = AF_LOCAL;
  75         if (socket_path[0] == '@') {
  76                 /* translate leading '@' to abstract namespace */
  77                 util_strlcpy(udev_monitor->sun.sun_path, socket_path, sizeof(udev_monitor->sun.sun_path));
  78                 udev_monitor->sun.sun_path[0] = '\0';
  79                 udev_monitor->addrlen = offsetof(struct sockaddr_un, sun_path) + strlen(socket_path);
  80         } else if (stat(socket_path, &statbuf) == 0 && S_ISSOCK(statbuf.st_mode)) {
  81                 /* existing socket file */
  82                 util_strlcpy(udev_monitor->sun.sun_path, socket_path, sizeof(udev_monitor->sun.sun_path));
  83                 udev_monitor->addrlen = offsetof(struct sockaddr_un, sun_path) + strlen(socket_path);
  84         } else {
  85                 /* no socket file, assume abstract namespace socket */
  86                 util_strlcpy(&udev_monitor->sun.sun_path[1], socket_path, sizeof(udev_monitor->sun.sun_path)-1);
  87                 udev_monitor->addrlen = offsetof(struct sockaddr_un, sun_path) + strlen(socket_path)+1;
  88         }
  89         udev_monitor->sock = socket(AF_LOCAL, SOCK_DGRAM, 0);
  90         if (udev_monitor->sock == -1) {
  91                 err(udev, "error getting socket: %m\n");
  92                 free(udev_monitor);
  93                 return NULL;
  94         }
  95         util_set_fd_cloexec(udev_monitor->sock);
  96
  97         dbg(udev, "monitor %p created with '%s'\n", udev_monitor, socket_path);
  98         return udev_monitor;
  99 }
 100
 101 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name)
 102 {
 103         struct udev_monitor *udev_monitor;
 104         unsigned int group;
 105
 106         if (udev == NULL)
 107                 return NULL;
 108
 109         if (name == NULL)
 110                 return NULL;
 111         if (strcmp(name, "kernel") == 0)
 112                 group = UDEV_MONITOR_KERNEL;
 113         else if (strcmp(name, "udev") == 0)
 114                 group = UDEV_MONITOR_UDEV;
 115         else
 116                 return NULL;
 117
 118         udev_monitor = calloc(1, sizeof(struct udev_monitor));
 119         if (udev_monitor == NULL)
 120                 return NULL;
 121         udev_monitor->refcount = 1;
 122         udev_monitor->udev = udev;
 123
 124         udev_monitor->sock = socket(PF_NETLINK, SOCK_DGRAM, NETLINK_KOBJECT_UEVENT);
 125         if (udev_monitor->sock == -1) {
 126                 err(udev, "error getting socket: %m\n");
 127                 free(udev_monitor);
 128                 return NULL;
 129         }
 130         util_set_fd_cloexec(udev_monitor->sock);
 131
 132         udev_monitor->snl.nl_family = AF_NETLINK;
 133         udev_monitor->snl.nl_groups = group;
 134         udev_monitor->snl_peer.nl_family = AF_NETLINK;
 135         udev_monitor->snl_peer.nl_groups = UDEV_MONITOR_UDEV;
 136
 137         dbg(udev, "monitor %p created with NETLINK_KOBJECT_UEVENT (%u)\n", udev_monitor, group);
 138         return udev_monitor;
 139 }
 140
 141 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor)
 142 {
 143         int err;
 144         const int on = 1;
 145
 146         if (udev_monitor->snl.nl_family != 0) {
 147                 err = bind(udev_monitor->sock,
 148                            (struct sockaddr *)&udev_monitor->snl, sizeof(struct sockaddr_nl));
 149                 if (err < 0) {
 150                         err(udev_monitor->udev, "bind failed: %m\n");
 151                         return err;
 152                 }
 153                 dbg(udev_monitor->udev, "monitor %p listening on netlink\n", udev_monitor);
 154         } else if (udev_monitor->sun.sun_family != 0) {
 155                 err = bind(udev_monitor->sock,
 156                            (struct sockaddr *)&udev_monitor->sun, udev_monitor->addrlen);
 157                 if (err < 0) {
 158                         err(udev_monitor->udev, "bind failed: %m\n");
 159                         return err;
 160                 }
 161                 /* enable receiving of the sender credentials */
 162                 setsockopt(udev_monitor->sock, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on));
 163                 dbg(udev_monitor->udev, "monitor %p listening on socket\n", udev_monitor);
 164         }
 165         return 0;
 166 }
 167
 168 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size)
 169 {
 170         if (udev_monitor == NULL)
 171                 return -1;
 172         return setsockopt(udev_monitor->sock, SOL_SOCKET, SO_RCVBUFFORCE, &size, sizeof(size));
 173 }
 174
 175 /**
 176  * udev_monitor_ref:
 177  * @udev_monitor: udev monitor
 178  *
 179  * Take a reference of a udev monitor.
 180  *
 181  * Returns: the passed udev monitor
 182  **/
 183 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor)
 184 {
 185         if (udev_monitor == NULL)
 186                 return NULL;
 187         udev_monitor->refcount++;
 188         return udev_monitor;
 189 }
 190
 191 /**
 192  * udev_monitor_unref:
 193  * @udev_monitor: udev monitor
 194  *
 195  * Drop a reference ofa udev monitor. If the refcount reaches zero,
 196  * the bound socket will be closed, and the resources of the monitor
 197  * will be released.
 198  *
 199  **/
 200 void udev_monitor_unref(struct udev_monitor *udev_monitor)
 201 {
 202         if (udev_monitor == NULL)
 203                 return;
 204         udev_monitor->refcount--;
 205         if (udev_monitor->refcount > 0)
 206                 return;
 207         if (udev_monitor->sock >= 0)
 208                 close(udev_monitor->sock);
 209         dbg(udev_monitor->udev, "monitor %p released\n", udev_monitor);
 210         free(udev_monitor);
 211 }
 212
 213 /**
 214  * udev_monitor_get_udev:
 215  * @udev_monitor: udev monitor
 216  *
 217  * Retrieve the udev library context the monitor was created with.
 218  *
 219  * Returns: the udev library context
 220  **/
 221 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor)
 222 {
 223         if (udev_monitor == NULL)
 224                 return NULL;
 225         return udev_monitor->udev;
 226 }
 227
 228 /**
 229  * udev_monitor_get_fd:
 230  * @udev_monitor: udev monitor
 231  *
 232  * Retrieve the socket file descriptor associated with the monitor.
 233  *
 234  * Returns: the socket file descriptor
 235  **/
 236 int udev_monitor_get_fd(struct udev_monitor *udev_monitor)
 237 {
 238         if (udev_monitor == NULL)
 239                 return -1;
 240         return udev_monitor->sock;
 241 }
 242
 243 /**
 244  * udev_monitor_receive_device:
 245  * @udev_monitor: udev monitor
 246  *
 247  * Receive data from the udev monitor socket, allocate a new udev
 248  * device, fill in the received data, and return the device.
 249  *
 250  * Only socket connections with uid=0 are accepted. The caller
 251  * needs to make sure that there is data to read from the socket.
 252  * The call will block until the socket becomes readable.
 253  *
 254  * The initial refcount is 1, and needs to be decremented to
 255  * release the resources of the udev device.
 256  *
 257  * Returns: a new udev device, or #NULL, in case of an error
 258  **/
 259 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor)
 260 {
 261         struct udev_device *udev_device;
 262         struct msghdr smsg;
 263         struct iovec iov;
 264         char cred_msg[CMSG_SPACE(sizeof(struct ucred))];
 265         char buf[4096];
 266         size_t bufpos;
 267         int devpath_set = 0;
 268         int subsystem_set = 0;
 269         int action_set = 0;
 270         int maj = 0;
 271         int min = 0;
 272
 273         if (udev_monitor == NULL)
 274                 return NULL;
 275         memset(buf, 0x00, sizeof(buf));
 276         iov.iov_base = &buf;
 277         iov.iov_len = sizeof(buf);
 278         memset (&smsg, 0x00, sizeof(struct msghdr));
 279         smsg.msg_iov = &iov;
 280         smsg.msg_iovlen = 1;
 281         smsg.msg_control = cred_msg;
 282         smsg.msg_controllen = sizeof(cred_msg);
 283
 284         if (recvmsg(udev_monitor->sock, &smsg, 0) < 0) {
 285                 if (errno != EINTR)
 286                         info(udev_monitor->udev, "unable to receive message");
 287                 return NULL;
 288         }
 289
 290         if (udev_monitor->sun.sun_family != 0) {
 291                 struct cmsghdr *cmsg = CMSG_FIRSTHDR(&smsg);
 292                 struct ucred *cred = (struct ucred *)CMSG_DATA (cmsg);
 293
 294                 if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
 295                         info(udev_monitor->udev, "no sender credentials received, message ignored");
 296                         return NULL;
 297                 }
 298
 299                 if (cred->uid != 0) {
 300                         info(udev_monitor->udev, "sender uid=%d, message ignored", cred->uid);
 301                         return NULL;
 302                 }
 303         }
 304
 305         /* skip header */
 306         bufpos = strlen(buf) + 1;
 307         if (bufpos < sizeof("a@/d") || bufpos >= sizeof(buf)) {
 308                 info(udev_monitor->udev, "invalid message length");
 309                 return NULL;
 310         }
 311
 312         /* check message header */
 313         if (strstr(buf, "@/") == NULL) {
 314                 info(udev_monitor->udev, "unrecognized message header");
 315                 return NULL;
 316         }
 317
 318         udev_device = device_new(udev_monitor->udev);
 319         if (udev_device == NULL) {
 320                 return NULL;
 321         }
 322
 323         while (bufpos < sizeof(buf)) {
 324                 char *key;
 325                 size_t keylen;
 326
 327                 key = &buf[bufpos];
 328                 keylen = strlen(key);
 329                 if (keylen == 0)
 330                         break;
 331                 bufpos += keylen + 1;
 332
 333                 if (strncmp(key, "DEVPATH=", 8) == 0) {
 334                         char path[UTIL_PATH_SIZE];
 335
 336                         util_strlcpy(path, udev_get_sys_path(udev_monitor->udev), sizeof(path));
 337                         util_strlcat(path, &key[8], sizeof(path));
 338                         udev_device_set_syspath(udev_device, path);
 339                         devpath_set = 1;
 340                 } else if (strncmp(key, "SUBSYSTEM=", 10) == 0) {
 341                         udev_device_set_subsystem(udev_device, &key[10]);
 342                         subsystem_set = 1;
 343                 } else if (strncmp(key, "DEVTYPE=", 8) == 0) {
 344                         udev_device_set_devtype(udev_device, &key[8]);
 345                 } else if (strncmp(key, "DEVNAME=", 8) == 0) {
 346                         udev_device_set_devnode(udev_device, &key[8]);
 347                 } else if (strncmp(key, "DEVLINKS=", 9) == 0) {
 348                         char devlinks[UTIL_PATH_SIZE];
 349                         char *slink;
 350                         char *next;
 351
 352                         util_strlcpy(devlinks, &key[9], sizeof(devlinks));
 353                         slink = devlinks;
 354                         next = strchr(slink, ' ');
 355                         while (next != NULL) {
 356                                 next[0] = '\0';
 357                                 udev_device_add_devlink(udev_device, slink);
 358                                 slink = &next[1];
 359                                 next = strchr(slink, ' ');
 360                         }
 361                         if (slink[0] != '\0')
 362                                 udev_device_add_devlink(udev_device, slink);
 363                 } else if (strncmp(key, "DRIVER=", 7) == 0) {
 364                         udev_device_set_driver(udev_device, &key[7]);
 365                 } else if (strncmp(key, "ACTION=", 7) == 0) {
 366                         udev_device_set_action(udev_device, &key[7]);
 367                         action_set = 1;
 368                 } else if (strncmp(key, "MAJOR=", 6) == 0) {
 369                         maj = strtoull(&key[6], NULL, 10);
 370                 } else if (strncmp(key, "MINOR=", 6) == 0) {
 371                         min = strtoull(&key[6], NULL, 10);
 372                 } else if (strncmp(key, "DEVPATH_OLD=", 12) == 0) {
 373                         udev_device_set_devpath_old(udev_device, &key[12]);
 374                 } else if (strncmp(key, "PHYSDEVPATH=", 12) == 0) {
 375                         udev_device_set_physdevpath(udev_device, &key[12]);
 376                 } else if (strncmp(key, "SEQNUM=", 7) == 0) {
 377                         udev_device_set_seqnum(udev_device, strtoull(&key[7], NULL, 10));
 378                 } else if (strncmp(key, "TIMEOUT=", 8) == 0) {
 379                         udev_device_set_timeout(udev_device, strtoull(&key[8], NULL, 10));
 380                 } else if (strncmp(key, "PHYSDEV", 7) == 0) {
 381                         /* skip deprecated values */
 382                         continue;
 383                 } else {
 384                         udev_device_add_property_from_string(udev_device, key);
 385                 }
 386         }
 387         if (!devpath_set || !subsystem_set || !action_set) {
 388                 info(udev_monitor->udev, "missing values, skip\n");
 389                 udev_device_unref(udev_device);
 390                 return NULL;
 391         }
 392         if (maj > 0)
 393                 udev_device_set_devnum(udev_device, makedev(maj, min));
 394         udev_device_set_info_loaded(udev_device);
 395         return udev_device;
 396 }
 397
 398 int udev_monitor_send_device(struct udev_monitor *udev_monitor, struct udev_device *udev_device)
 399 {
 400         const char *buf;
 401         ssize_t len;
 402         ssize_t count;
 403
 404         len = udev_device_get_properties_monitor_buf(udev_device, &buf);
 405         if (len < 32)
 406                 return -1;
 407         if (udev_monitor->sun.sun_family != 0) {
 408                 count = sendto(udev_monitor->sock,
 409                                buf, len, 0,
 410                                (struct sockaddr *)&udev_monitor->sun,
 411                                udev_monitor->addrlen);
 412         } else {
 413                 /* no destination besides the muticast group, we will always get -1 ECONNREFUSED */
 414                 count = sendto(udev_monitor->sock,
 415                                buf, len, 0,
 416                                (struct sockaddr *)&udev_monitor->snl_peer,
 417                                sizeof(struct sockaddr_nl));
 418         }
 419         info(udev_monitor->udev, "passed %zi bytes to monitor %p, \n", count, udev_monitor);
 420         return count;
 421 }