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