X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev%2Flib%2Flibudev-monitor.c;h=09845576d9951f003be7530e401827e6273a21de;hp=fbb21d04eaeb849c7c3c2f71814c203a79ca4f05;hb=7d563a17f3967890331daf08d43f2f005418139b;hpb=ba6929f6690a72485ac3c6b7610ffbd5ab319be7;ds=sidebyside

diff --git a/udev/lib/libudev-monitor.c b/udev/lib/libudev-monitor.c
index fbb21d04e..09845576d 100644
--- a/udev/lib/libudev-monitor.c
+++ b/udev/lib/libudev-monitor.c
@@ -40,6 +40,23 @@ struct udev_monitor {
 	int socket;
 };
 
+/**
+ * udev_monitor_new_from_socket:
+ * @udev: udev library context
+ * @socket_path: unix socket path
+ *
+ * Create new udev monitor, setup and connect to a specified socket. The
+ * path to a socket can point to an existing socket file, or it will be
+ * created if needed. If neccessary, the permissions adjustment as well as
+ * the later cleanup of the socket file, needs to be done by the caller.
+ * If the socket path starts with a '@' character, an abstract namespace
+ * socket will be used.
+ *
+ * The initial refcount is 1, and needs to be decremented to
+ * release the ressources of the udev monitor.
+ *
+ * Returns: a new udev monitor, or #NULL, in case of an error
+ **/
 struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path)
 {
 	struct udev_monitor *udev_monitor;
@@ -69,13 +86,13 @@ struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char
 
 	udev_monitor->socket = socket(AF_LOCAL, SOCK_DGRAM, 0);
 	if (udev_monitor->socket == -1) {
-		log_err(udev, "error getting socket: %s\n", strerror(errno));
+		err(udev, "error getting socket: %s\n", strerror(errno));
 		free(udev_monitor);
 		return NULL;
 	}
 
 	if (bind(udev_monitor->socket, (struct sockaddr *) &saddr, addrlen) < 0) {
-		log_err(udev, "bind failed: %s\n", strerror(errno));
+		err(udev, "bind failed: %s\n", strerror(errno));
 		close(udev_monitor->socket);
 		free(udev_monitor);
 		return NULL;
@@ -83,11 +100,19 @@ struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char
 
 	/* enable receiving of the sender credentials */
 	setsockopt(udev_monitor->socket, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on));
-	log_info(udev_monitor->udev, "udev_monitor: %p created\n", udev_monitor);
+	info(udev_monitor->udev, "udev_monitor: %p created\n", udev_monitor);
 
 	return udev_monitor;
 }
 
+/**
+ * udev_monitor_ref:
+ * @udev_monitor: udev monitor
+ *
+ * Take a reference of a udev monitor.
+ *
+ * Returns: the passed udev monitor
+ **/
 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor)
 {
 	if (udev_monitor == NULL)
@@ -96,6 +121,15 @@ struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor)
 	return udev_monitor;
 }
 
+/**
+ * udev_monitor_unref:
+ * @udev_monitor: udev monitor
+ *
+ * Drop a reference of a udev monitor. If the refcount reaches zero,
+ * the bound socket will be closed, and the ressources of the monitor
+ * will be released.
+ *
+ **/
 void udev_monitor_unref(struct udev_monitor *udev_monitor)
 {
 	if (udev_monitor == NULL)
@@ -104,10 +138,18 @@ void udev_monitor_unref(struct udev_monitor *udev_monitor)
 	if (udev_monitor->refcount > 0)
 		return;
 	close(udev_monitor->socket);
-	log_info(udev_monitor->udev, "udev_monitor: %p released\n", udev_monitor);
+	info(udev_monitor->udev, "udev_monitor: %p released\n", udev_monitor);
 	free(udev_monitor);
 }
 
+/**
+ * udev_monitor_get_udev:
+ * @udev_monitor: udev monitor
+ *
+ * Retrieve the udev library context the monitor was created with.
+ *
+ * Returns: the udev library context
+ **/
 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor)
 {
 	if (udev_monitor == NULL)
@@ -115,6 +157,14 @@ struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor)
 	return udev_monitor->udev;
 }
 
+/**
+ * udev_monitor_get_fd:
+ * @udev_monitor: udev monitor
+ *
+ * Retrieve the socket file descriptor associated with the monitor.
+ *
+ * Returns: the socket file descriptor
+ **/
 int udev_monitor_get_fd(struct udev_monitor *udev_monitor)
 {
 	if (udev_monitor == NULL)
@@ -122,6 +172,22 @@ int udev_monitor_get_fd(struct udev_monitor *udev_monitor)
 	return udev_monitor->socket;
 }
 
+/**
+ * udev_monitor_get_device:
+ * @udev_monitor: udev monitor
+ *
+ * Retrieve data from the udev monitor socket, allocate a new udev
+ * device, fill in the received data, and return the device.
+ *
+ * Only socket connections with uid=0 are accepted. The caller
+ * needs to make sure, that there is data to read from the socket,
+ * the call will block until the socket becomes readable.
+ *
+ * The initial refcount is 1, and needs to be decremented to
+ * release the ressources of the udev device.
+ *
+ * Returns: a new udev device, or #NULL, in case of an error
+ **/
 struct udev_device *udev_monitor_get_device(struct udev_monitor *udev_monitor)
 {
 	struct udev_device *udev_device;
@@ -146,32 +212,32 @@ struct udev_device *udev_monitor_get_device(struct udev_monitor *udev_monitor)
 
 	if (recvmsg(udev_monitor->socket, &smsg, 0) < 0) {
 		if (errno != EINTR)
-			log_info(udev_monitor->udev, "unable to receive message");
+			info(udev_monitor->udev, "unable to receive message");
 		return NULL;
 	}
 	cmsg = CMSG_FIRSTHDR(&smsg);
 	cred = (struct ucred *)CMSG_DATA (cmsg);
 
 	if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
-		log_info(udev_monitor->udev, "no sender credentials received, message ignored");
+		info(udev_monitor->udev, "no sender credentials received, message ignored");
 		return NULL;
 	}
 
 	if (cred->uid != 0) {
-		log_info(udev_monitor->udev, "sender uid=%d, message ignored", cred->uid);
+		info(udev_monitor->udev, "sender uid=%d, message ignored", cred->uid);
 		return NULL;
 	}
 
 	/* skip header */
 	bufpos = strlen(buf) + 1;
 	if (bufpos < sizeof("a@/d") || bufpos >= sizeof(buf)) {
-		log_info(udev_monitor->udev, "invalid message length");
+		info(udev_monitor->udev, "invalid message length");
 		return NULL;
 	}
 
 	/* check message header */
 	if (strstr(buf, "@/") == NULL) {
-		log_info(udev_monitor->udev, "unrecognized message header");
+		info(udev_monitor->udev, "unrecognized message header");
 		return NULL;
 	}
 
@@ -191,25 +257,25 @@ struct udev_device *udev_monitor_get_device(struct udev_monitor *udev_monitor)
 		bufpos += keylen + 1;
 
 		if (strncmp(key, "DEVPATH=", 8) == 0) {
-			udev_device->devpath = strdup(&key[8]);
+			device_set_devpath(udev_device, &key[8]);
 		} else if (strncmp(key, "SUBSYSTEM=", 10) == 0) {
-			udev_device->subsystem = strdup(&key[10]);
+			device_set_subsystem(udev_device, &key[10]);
 		} else if (strncmp(key, "DEVNAME=", 8) == 0) {
-			udev_device->devname = strdup(&key[8]);
+			device_set_devname(udev_device, &key[8]);
 		} else if (strncmp(key, "DEVLINKS=", 9) == 0) {
 			char *slink = &key[9];
 			char *next = strchr(slink, ' ');
 
 			while (next != NULL) {
 				next[0] = '\0';
-				name_list_add(&udev_device->link_list, slink, 0);
+				device_add_devlink(udev_device, slink);
 				slink = &next[1];
 				next = strchr(slink, ' ');
 			}
 			if (slink[0] != '\0')
-				name_list_add(&udev_device->link_list, slink, 0);
+				device_add_devlink(udev_device, slink);
 		}
-		name_list_add(&udev_device->env_list, key, 0);
+		device_add_property(udev_device, key);
 	}
 
 	return udev_device;