]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - src/udev/udev-ctrl.c
Merge pull request #10901 from poettering/startswith-list
[thirdparty/systemd.git] / src / udev / udev-ctrl.c
index f68a09d7a8cc28ef3a52248ae960f27881e5d42b..6ea74c7bf70e66bc9d229185d5739433718f1313 100644 (file)
@@ -1,7 +1,6 @@
-/*
- * libudev - interface to udev device information
+/* SPDX-License-Identifier: LGPL-2.1+
  *
- * Copyright (C) 2008 Kay Sievers <kay@vrfy.org>
+ * libudev - interface to udev device information
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
 
 #include "alloc-util.h"
 #include "fd-util.h"
-#include "formats-util.h"
+#include "format-util.h"
 #include "socket-util.h"
-#include "udev.h"
+#include "strxcpyx.h"
+#include "udev-ctrl.h"
 
 /* wire protocol magic must match */
 #define UDEV_CTRL_MAGIC                                0xdead1dea
@@ -41,7 +41,7 @@ enum udev_ctrl_msg_type {
 
 struct udev_ctrl_msg_wire {
         char version[16];
-        unsigned int magic;
+        unsigned magic;
         enum udev_ctrl_msg_type type;
         union {
                 int intval;
@@ -50,14 +50,13 @@ struct udev_ctrl_msg_wire {
 };
 
 struct udev_ctrl_msg {
-        int refcount;
+        unsigned n_ref;
         struct udev_ctrl_connection *conn;
         struct udev_ctrl_msg_wire ctrl_msg_wire;
 };
 
 struct udev_ctrl {
-        int refcount;
-        struct udev *udev;
+        unsigned n_ref;
         int sock;
         union sockaddr_union saddr;
         socklen_t addrlen;
@@ -67,26 +66,24 @@ struct udev_ctrl {
 };
 
 struct udev_ctrl_connection {
-        int refcount;
+        unsigned n_ref;
         struct udev_ctrl *uctrl;
         int sock;
 };
 
-struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd) {
+struct udev_ctrl *udev_ctrl_new_from_fd(int fd) {
         struct udev_ctrl *uctrl;
-        const int on = 1;
         int r;
 
         uctrl = new0(struct udev_ctrl, 1);
-        if (uctrl == NULL)
+        if (!uctrl)
                 return NULL;
-        uctrl->refcount = 1;
-        uctrl->udev = udev;
+        uctrl->n_ref = 1;
 
         if (fd < 0) {
                 uctrl->sock = socket(AF_LOCAL, SOCK_SEQPACKET|SOCK_NONBLOCK|SOCK_CLOEXEC, 0);
                 if (uctrl->sock < 0) {
-                        log_error_errno(errno, "error getting socket: %m");
+                        log_error_errno(errno, "Failed to create socket: %m");
                         udev_ctrl_unref(uctrl);
                         return NULL;
                 }
@@ -99,18 +96,21 @@ struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd) {
          * FIXME: remove it as soon as we can depend on this:
          *   http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=90c6bd34f884cd9cee21f1d152baf6c18bcac949
          */
-        r = setsockopt(uctrl->sock, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on));
+        r = setsockopt_int(uctrl->sock, SOL_SOCKET, SO_PASSCRED, true);
         if (r < 0)
-                log_warning_errno(errno, "could not set SO_PASSCRED: %m");
+                log_warning_errno(r, "Failed to set SO_PASSCRED: %m");
+
+        uctrl->saddr.un = (struct sockaddr_un) {
+                .sun_family = AF_UNIX,
+                .sun_path = "/run/udev/control",
+        };
 
-        uctrl->saddr.un.sun_family = AF_LOCAL;
-        strscpy(uctrl->saddr.un.sun_path, sizeof(uctrl->saddr.un.sun_path), "/run/udev/control");
         uctrl->addrlen = SOCKADDR_UN_LEN(uctrl->saddr.un);
         return uctrl;
 }
 
-struct udev_ctrl *udev_ctrl_new(struct udev *udev) {
-        return udev_ctrl_new_from_fd(udev, -1);
+struct udev_ctrl *udev_ctrl_new(void) {
+        return udev_ctrl_new_from_fd(-1);
 }
 
 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl) {
@@ -119,16 +119,16 @@ int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl) {
         if (!uctrl->bound) {
                 err = bind(uctrl->sock, &uctrl->saddr.sa, uctrl->addrlen);
                 if (err < 0 && errno == EADDRINUSE) {
-                        unlink(uctrl->saddr.un.sun_path);
+                        (void) sockaddr_un_unlink(&uctrl->saddr.un);
                         err = bind(uctrl->sock, &uctrl->saddr.sa, uctrl->addrlen);
                 }
 
                 if (err < 0)
-                        return log_error_errno(errno, "bind failed: %m");
+                        return log_error_errno(errno, "Failed to bind socket: %m");
 
                 err = listen(uctrl->sock, 0);
                 if (err < 0)
-                        return log_error_errno(errno, "listen failed: %m");
+                        return log_error_errno(errno, "Failed to listen: %m");
 
                 uctrl->bound = true;
                 uctrl->cleanup_socket = true;
@@ -136,37 +136,26 @@ int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl) {
         return 0;
 }
 
-struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl) {
-        return uctrl->udev;
-}
-
-static struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl) {
-        if (uctrl)
-                uctrl->refcount++;
+static struct udev_ctrl *udev_ctrl_free(struct udev_ctrl *uctrl) {
+        assert(uctrl);
 
-        return uctrl;
+        safe_close(uctrl->sock);
+        return mfree(uctrl);
 }
 
-struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl) {
-        if (uctrl && -- uctrl->refcount == 0) {
-                if (uctrl->sock >= 0)
-                        close(uctrl->sock);
-                free(uctrl);
-        }
-
-        return NULL;
-}
+DEFINE_PRIVATE_TRIVIAL_REF_FUNC(struct udev_ctrl, udev_ctrl);
+DEFINE_TRIVIAL_UNREF_FUNC(struct udev_ctrl, udev_ctrl, udev_ctrl_free);
 
 int udev_ctrl_cleanup(struct udev_ctrl *uctrl) {
-        if (uctrl == NULL)
+        if (!uctrl)
                 return 0;
         if (uctrl->cleanup_socket)
-                unlink(uctrl->saddr.un.sun_path);
+                sockaddr_un_unlink(&uctrl->saddr.un);
         return 0;
 }
 
 int udev_ctrl_get_fd(struct udev_ctrl *uctrl) {
-        if (uctrl == NULL)
+        if (!uctrl)
                 return -EINVAL;
         return uctrl->sock;
 }
@@ -174,77 +163,64 @@ int udev_ctrl_get_fd(struct udev_ctrl *uctrl) {
 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl) {
         struct udev_ctrl_connection *conn;
         struct ucred ucred = {};
-        const int on = 1;
         int r;
 
         conn = new(struct udev_ctrl_connection, 1);
-        if (conn == NULL)
+        if (!conn)
                 return NULL;
-        conn->refcount = 1;
+        conn->n_ref = 1;
         conn->uctrl = uctrl;
 
         conn->sock = accept4(uctrl->sock, NULL, NULL, SOCK_CLOEXEC|SOCK_NONBLOCK);
         if (conn->sock < 0) {
                 if (errno != EINTR)
-                        log_error_errno(errno, "unable to receive ctrl connection: %m");
+                        log_error_errno(errno, "Failed to receive ctrl connection: %m");
                 goto err;
         }
 
         /* check peer credential of connection */
         r = getpeercred(conn->sock, &ucred);
         if (r < 0) {
-                log_error_errno(r, "unable to receive credentials of ctrl connection: %m");
+                log_error_errno(r, "Failed to receive credentials of ctrl connection: %m");
                 goto err;
         }
         if (ucred.uid > 0) {
-                log_error("sender uid="UID_FMT", message ignored", ucred.uid);
+                log_error("Sender uid="UID_FMT", message ignored", ucred.uid);
                 goto err;
         }
 
         /* enable receiving of the sender credentials in the messages */
-        r = setsockopt(conn->sock, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on));
+        r = setsockopt_int(conn->sock, SOL_SOCKET, SO_PASSCRED, true);
         if (r < 0)
-                log_warning_errno(errno, "could not set SO_PASSCRED: %m");
+                log_warning_errno(r, "Failed to set SO_PASSCRED: %m");
 
         udev_ctrl_ref(uctrl);
         return conn;
 err:
-        if (conn->sock >= 0)
-                close(conn->sock);
-        free(conn);
-        return NULL;
+        safe_close(conn->sock);
+        return mfree(conn);
 }
 
-struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn) {
-        if (conn == NULL)
-                return NULL;
-        conn->refcount++;
-        return conn;
-}
-
-struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn) {
-        if (conn && -- conn->refcount == 0) {
-                if (conn->sock >= 0)
-                        close(conn->sock);
-
-                udev_ctrl_unref(conn->uctrl);
-
-                free(conn);
-        }
+static struct udev_ctrl_connection *udev_ctrl_connection_free(struct udev_ctrl_connection *conn) {
+        assert(conn);
 
-        return NULL;
+        safe_close(conn->sock);
+        udev_ctrl_unref(conn->uctrl);
+        return mfree(conn);
 }
 
+DEFINE_TRIVIAL_REF_UNREF_FUNC(struct udev_ctrl_connection, udev_ctrl_connection, udev_ctrl_connection_free);
+
 static int ctrl_send(struct udev_ctrl *uctrl, enum udev_ctrl_msg_type type, int intval, const char *buf, int timeout) {
         struct udev_ctrl_msg_wire ctrl_msg_wire;
         int err = 0;
 
         memzero(&ctrl_msg_wire, sizeof(struct udev_ctrl_msg_wire));
-        strcpy(ctrl_msg_wire.version, "udev-" VERSION);
+        strcpy(ctrl_msg_wire.version, "udev-" PACKAGE_VERSION);
         ctrl_msg_wire.magic = UDEV_CTRL_MAGIC;
         ctrl_msg_wire.type = type;
 
-        if (buf != NULL)
+        if (buf)
                 strscpy(ctrl_msg_wire.buf, sizeof(ctrl_msg_wire.buf), buf);
         else
                 ctrl_msg_wire.intval = intval;
@@ -269,7 +245,7 @@ static int ctrl_send(struct udev_ctrl *uctrl, enum udev_ctrl_msg_type type, int
                 pfd[0].fd = uctrl->sock;
                 pfd[0].events = POLLIN;
                 r = poll(pfd, 1, timeout * MSEC_PER_SEC);
-                if (r  < 0) {
+                if (r < 0) {
                         if (errno == EINTR)
                                 continue;
                         err = -errno;
@@ -336,9 +312,9 @@ struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn) {
         struct ucred *cred;
 
         uctrl_msg = new0(struct udev_ctrl_msg, 1);
-        if (uctrl_msg == NULL)
+        if (!uctrl_msg)
                 return NULL;
-        uctrl_msg->refcount = 1;
+        uctrl_msg->n_ref = 1;
         uctrl_msg->conn = conn;
         udev_ctrl_connection_ref(conn);
 
@@ -351,16 +327,16 @@ struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn) {
                 pfd[0].events = POLLIN;
 
                 r = poll(pfd, 1, 10000);
-                if (r  < 0) {
+                if (r < 0) {
                         if (errno == EINTR)
                                 continue;
                         goto err;
                 } else if (r == 0) {
-                        log_error("timeout waiting for ctrl message");
+                        log_error("Timeout waiting for ctrl message");
                         goto err;
                 } else {
                         if (!(pfd[0].revents & POLLIN)) {
-                                log_error_errno(errno, "ctrl connection error: %m");
+                                log_error("Invalid ctrl connection: %m");
                                 goto err;
                         }
                 }
@@ -372,8 +348,8 @@ struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn) {
         iov.iov_len = sizeof(struct udev_ctrl_msg_wire);
 
         size = recvmsg(conn->sock, &smsg, 0);
-        if (size <  0) {
-                log_error_errno(errno, "unable to receive ctrl message: %m");
+        if (size < 0) {
+                log_error_errno(errno, "Failed to receive ctrl message: %m");
                 goto err;
         }
 
@@ -381,20 +357,20 @@ struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn) {
 
         cmsg = CMSG_FIRSTHDR(&smsg);
 
-        if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
-                log_error("no sender credentials received, message ignored");
+        if (!cmsg || cmsg->cmsg_type != SCM_CREDENTIALS) {
+                log_error("No sender credentials received, ignoring message");
                 goto err;
         }
 
         cred = (struct ucred *) CMSG_DATA(cmsg);
 
         if (cred->uid != 0) {
-                log_error("sender uid="UID_FMT", message ignored", cred->uid);
+                log_error("Sender uid="UID_FMT", ignoring message", cred->uid);
                 goto err;
         }
 
         if (uctrl_msg->ctrl_msg_wire.magic != UDEV_CTRL_MAGIC) {
-                log_error("message magic 0x%08x doesn't match, ignore it", uctrl_msg->ctrl_msg_wire.magic);
+                log_error("Message magic 0x%08x doesn't match, ignoring", uctrl_msg->ctrl_msg_wire.magic);
                 goto err;
         }
 
@@ -404,15 +380,15 @@ err:
         return NULL;
 }
 
-struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg) {
-        if (ctrl_msg && -- ctrl_msg->refcount == 0) {
-                udev_ctrl_connection_unref(ctrl_msg->conn);
-                free(ctrl_msg);
-        }
+static struct udev_ctrl_msg *udev_ctrl_msg_free(struct udev_ctrl_msg *ctrl_msg) {
+        assert(ctrl_msg);
 
-        return NULL;
+        udev_ctrl_connection_unref(ctrl_msg->conn);
+        return mfree(ctrl_msg);
 }
 
+DEFINE_TRIVIAL_UNREF_FUNC(struct udev_ctrl_msg, udev_ctrl_msg, udev_ctrl_msg_free);
+
 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg) {
         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_SET_LOG_LEVEL)
                 return ctrl_msg->ctrl_msg_wire.intval;