chiark / gitweb /
[PATCH] libsysfs changes for sysfsutils 0.3.0
[elogind.git] / libsysfs / sysfs_class.c
index 9d7d8b2..a027356 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Generic class utility functions for libsysfs
  *
  *
  * Generic class utility functions for libsysfs
  *
- * Copyright (C) 2003 International Business Machines, Inc.
+ * Copyright (C) IBM Corp. 2003
  *
  *  This library is free software; you can redistribute it and/or
  *  modify it under the terms of the GNU Lesser General Public
  *
  *  This library is free software; you can redistribute it and/or
  *  modify it under the terms of the GNU Lesser General Public
 #include "libsysfs.h"
 #include "sysfs.h"
 
 #include "libsysfs.h"
 #include "sysfs.h"
 
+static void sysfs_close_cls_dev(void *dev)
+{
+       sysfs_close_class_device((struct sysfs_class_device *)dev);
+}
+
+/**
+ * class_name_equal: compares class_devices' name
+ * @a: class_name looking for
+ * @b: sysfs_class_device being compared
+ */
+static int class_name_equal(void *a, void *b)
+{
+       if (a == NULL || b == NULL)
+               return 0;
+
+       if (strcmp(((unsigned char *)a), ((struct sysfs_class_device *)b)->name)
+               == 0)
+               return 1;
+
+       return 0;
+}
+
 /**
  * sysfs_close_class_device: closes a single class device.
  * @dev: class device to close.
 /**
  * sysfs_close_class_device: closes a single class device.
  * @dev: class device to close.
@@ -46,15 +68,11 @@ void sysfs_close_class_device(struct sysfs_class_device *dev)
  */
 void sysfs_close_class(struct sysfs_class *cls)
 {
  */
 void sysfs_close_class(struct sysfs_class *cls)
 {
-       struct sysfs_class_device *cur = NULL, *next = NULL;
-
        if (cls != NULL) {
                if (cls->directory != NULL)
                        sysfs_close_directory(cls->directory);
        if (cls != NULL) {
                if (cls->directory != NULL)
                        sysfs_close_directory(cls->directory);
-               for (cur = cls->devices; cur != NULL; cur = next) {
-                       next = cur->next;
-                       sysfs_close_class_device(cur);
-               }
+               if (cls->devices != NULL) 
+                       dlist_destroy(cls->devices);
                free(cls);
        }
 }
                free(cls);
        }
 }
@@ -82,10 +100,10 @@ static struct sysfs_class *alloc_class(void)
  * open_class_dir: opens up sysfs class directory
  * returns sysfs_directory struct with success and NULL with error
  */
  * open_class_dir: opens up sysfs class directory
  * returns sysfs_directory struct with success and NULL with error
  */
-static struct sysfs_directory *open_class_dir(const char *name)
+static struct sysfs_directory *open_class_dir(const unsigned char *name)
 {
        struct sysfs_directory *classdir = NULL;
 {
        struct sysfs_directory *classdir = NULL;
-       char classpath[SYSFS_PATH_MAX];
+       unsigned char classpath[SYSFS_PATH_MAX];
 
        if (name == NULL) {
                errno = EINVAL;
 
        if (name == NULL) {
                errno = EINVAL;
@@ -94,23 +112,29 @@ static struct sysfs_directory *open_class_dir(const char *name)
 
        memset(classpath, 0, SYSFS_PATH_MAX);
        if ((sysfs_get_mnt_path(classpath, SYSFS_PATH_MAX)) != 0) {
 
        memset(classpath, 0, SYSFS_PATH_MAX);
        if ((sysfs_get_mnt_path(classpath, SYSFS_PATH_MAX)) != 0) {
-               dprintf(stderr, "Sysfs not supported on this system\n");
+               dprintf("Sysfs not supported on this system\n");
                return NULL;
        }
 
                return NULL;
        }
 
-       strcat(classpath, SYSFS_CLASS_DIR);
-       strcat(classpath, "/");
-       strcat(classpath, name);
+       /* 
+        * We shall now treat "block" also as a class. Hence, check here
+        * if "name" is "block" and proceed accordingly
+        */
+       if (strcmp(name, SYSFS_BLOCK_NAME) == 0) {
+               strcat(classpath, SYSFS_BLOCK_DIR);
+       } else {
+               strcat(classpath, SYSFS_CLASS_DIR);
+               strcat(classpath, "/");
+               strcat(classpath, name);
+       }
        classdir = sysfs_open_directory(classpath);
        if (classdir == NULL) {
                errno = EINVAL;
        classdir = sysfs_open_directory(classpath);
        if (classdir == NULL) {
                errno = EINVAL;
-               dprintf(stderr,"Class %s not supported on this system\n",
-                       name);
+               dprintf("Class %s not supported on this system\n", name);
                return NULL;
        }
        if ((sysfs_read_directory(classdir)) != 0) {
                return NULL;
        }
        if ((sysfs_read_directory(classdir)) != 0) {
-               dprintf(stderr, "Error reading %s class dir %s\n", name, 
-                       classpath);
+               dprintf("Error reading %s class dir %s\n", name, classpath);
                sysfs_close_directory(classdir);
                return NULL;
        }
                sysfs_close_directory(classdir);
                return NULL;
        }
@@ -118,19 +142,51 @@ static struct sysfs_directory *open_class_dir(const char *name)
        return classdir;
 }
 
        return classdir;
 }
 
+/** 
+ * set_classdev_classname: Grabs classname from path
+ * @cdev: class device to set
+ * Returns nothing
+ */
+static void set_classdev_classname(struct sysfs_class_device *cdev)
+{
+       unsigned char *c = NULL, *e = NULL;
+       int count = 0;
+
+       c = strstr(cdev->path, SYSFS_CLASS_DIR);
+       if (c == NULL) 
+               c = strstr(cdev->path, SYSFS_BLOCK_DIR);
+       else {
+               c++;
+               while (c != NULL && *c != '/') 
+                       c++;
+       }
+
+       if (c == NULL) 
+               strcpy(cdev->classname, SYSFS_UNKNOWN);
+
+       else {
+               c++;
+               e = c;
+               while (e != NULL && *e != '/' && *e != '\0') {
+                       e++;
+                       count++;
+               }
+               strncpy(cdev->classname, c, count);
+       }
+}
+
 /**
  * sysfs_open_class_device: Opens and populates class device
  * @path: path to class device.
  * returns struct sysfs_class_device with success and NULL with error.
  */
 /**
  * sysfs_open_class_device: Opens and populates class device
  * @path: path to class device.
  * returns struct sysfs_class_device with success and NULL with error.
  */
-struct sysfs_class_device *sysfs_open_class_device(const char *path)
+struct sysfs_class_device *sysfs_open_class_device(const unsigned char *path)
 {
        struct sysfs_class_device *cdev = NULL;
 {
        struct sysfs_class_device *cdev = NULL;
-       struct sysfs_directory *dir = NULL, *cur = NULL;
-       struct sysfs_dlink *curl = NULL;
+       struct sysfs_directory *dir = NULL;
+       struct sysfs_link *curl = NULL;
        struct sysfs_device *sdev = NULL;
        struct sysfs_driver *drv = NULL;
        struct sysfs_device *sdev = NULL;
        struct sysfs_driver *drv = NULL;
-       char temp[SYSFS_NAME_LEN];
 
        if (path == NULL) {
                errno = EINVAL;
 
        if (path == NULL) {
                errno = EINVAL;
@@ -138,75 +194,71 @@ struct sysfs_class_device *sysfs_open_class_device(const char *path)
        }
        cdev = alloc_class_device();
        if (cdev == NULL) {
        }
        cdev = alloc_class_device();
        if (cdev == NULL) {
-               perror("malloc");
+               dprintf("calloc failed\n");
                return NULL;
        }
                return NULL;
        }
-       memset(temp, 0, SYSFS_NAME_LEN);
-       if ((sysfs_get_name_from_path(path, temp, SYSFS_NAME_LEN)) != 0) {
+       if ((sysfs_get_name_from_path(path, cdev->name, SYSFS_NAME_LEN)) != 0) {
                errno = EINVAL;
                errno = EINVAL;
-               dprintf(stderr, "Invalid class device path %s\n", path);
+               dprintf("Invalid class device path %s\n", path);
                sysfs_close_class_device(cdev);
                return NULL;
        }
                sysfs_close_class_device(cdev);
                return NULL;
        }
-       strcpy(cdev->name, temp);
 
        dir = sysfs_open_directory(path);
        if (dir == NULL) {
 
        dir = sysfs_open_directory(path);
        if (dir == NULL) {
-               dprintf(stderr, "Error opening class device at %s\n", path);
+               dprintf("Error opening class device at %s\n", path);
                sysfs_close_class_device(cdev);
                return NULL;
        }
        if ((sysfs_read_directory(dir)) != 0) {
                sysfs_close_class_device(cdev);
                return NULL;
        }
        if ((sysfs_read_directory(dir)) != 0) {
-               dprintf(stderr, "Error reading class device at %s\n", path);
+               dprintf("Error reading class device at %s\n", path);
                sysfs_close_directory(dir);
                sysfs_close_class_device(cdev);
                return NULL;
        }
                sysfs_close_directory(dir);
                sysfs_close_class_device(cdev);
                return NULL;
        }
+       sysfs_read_all_subdirs(dir);
        cdev->directory = dir;
        cdev->directory = dir;
+       strcpy(cdev->path, dir->path);
+       set_classdev_classname(cdev);
 
 
-       cur = cdev->directory->subdirs;
-       while(cur != NULL) {
-               sysfs_read_directory(cur);
-               cur = cur->next;
-       }
        /* get driver and device, if implemented */
        /* get driver and device, if implemented */
-       curl = cdev->directory->links;
-       while (curl != NULL) {
-               if (strncmp(curl->name, SYSFS_DEVICES_NAME, 6) == 0) {
-                       sdev = sysfs_open_device(curl->target->path);
-                       if (sdev != NULL) {
-                               cdev->sysdevice = sdev;
-                               if (cdev->driver != NULL) 
-                                       sdev->driver = cdev->driver;
-                       }
-               } else if (strncmp(curl->name, SYSFS_DRIVERS_NAME, 6) == 0) {
-                       drv = sysfs_open_driver(curl->target->path);
-                       if (drv != NULL) {
-                               cdev->driver = drv;
-                               if (cdev->sysdevice != NULL) 
-                                       drv->device = cdev->sysdevice;
+       if (cdev->directory->links != NULL) {
+               dlist_for_each_data(cdev->directory->links, curl,
+                               struct sysfs_link) {
+                       if (strncmp(curl->name, SYSFS_DEVICES_NAME, 6) == 0) {
+                               sdev = sysfs_open_device(curl->target);
+                               if (sdev != NULL) {
+                                       cdev->sysdevice = sdev;
+                                       if (cdev->driver != NULL) 
+                                               strncpy(sdev->driver_name,
+                                                       cdev->driver->name, 
+                                                       SYSFS_NAME_LEN);
+                               }
+                       } else if (strncmp(curl->name, 
+                                               SYSFS_DRIVERS_NAME, 6) == 0) {
+                               drv = sysfs_open_driver(curl->target);
+                               if (drv != NULL) {
+                                       cdev->driver = drv;
+                                       if (cdev->sysdevice != NULL) {
+                                               strncpy(cdev->sysdevice->name,
+                                                               drv->name, 
+                                                               SYSFS_NAME_LEN);
+                                               if (drv->devices == NULL)
+                                                       drv->devices = 
+                                                               dlist_new
+                                                               (sizeof(struct 
+                                                               sysfs_device));
+                                               dlist_unshift(drv->devices, 
+                                                       cdev->sysdevice);
+                                       }
+                               }
                        }
                }
                        }
                }
-               curl = curl->next;
        }
        return cdev;
 }
 
 /**
        }
        return cdev;
 }
 
 /**
- * add_dev_to_class: adds a class device to class list
- * @class: class to add the device
- * @dev: device to add
- */
-static void add_dev_to_class(struct sysfs_class *cls, 
-                                       struct sysfs_class_device *dev)
-{
-       if (cls != NULL && dev != NULL) {
-               dev->next = cls->devices;
-               cls->devices = dev;
-       }
-}
-
-/**
  * get_all_class_devices: gets all devices for class
  * @class: class to get devices for
  * returns 0 with success and -1 with failure
  * get_all_class_devices: gets all devices for class
  * @class: class to get devices for
  * returns 0 with success and -1 with failure
@@ -214,23 +266,27 @@ static void add_dev_to_class(struct sysfs_class *cls,
 static int get_all_class_devices(struct sysfs_class *cls)
 {
        struct sysfs_class_device *dev = NULL;
 static int get_all_class_devices(struct sysfs_class *cls)
 {
        struct sysfs_class_device *dev = NULL;
-       struct sysfs_directory *cur = NULL, *next = NULL;
+       struct sysfs_directory *cur = NULL;
 
        if (cls == NULL || cls->directory == NULL) {
                errno = EINVAL;
                return -1;
        }
 
        if (cls == NULL || cls->directory == NULL) {
                errno = EINVAL;
                return -1;
        }
-       for (cur = cls->directory->subdirs; cur != NULL; cur = next) {
-               next = cur->next;
+       if (cls->directory->subdirs == NULL)
+               return 0;
+       dlist_for_each_data(cls->directory->subdirs, cur, 
+                       struct sysfs_directory) {
                dev = sysfs_open_class_device(cur->path);
                if (dev == NULL) {
                dev = sysfs_open_class_device(cur->path);
                if (dev == NULL) {
-                       dprintf(stderr, "Error opening device at %s\n",
-                               cur->path);
+                       dprintf("Error opening device at %s\n", cur->path);
                        continue;
                }
                        continue;
                }
-               add_dev_to_class(cls, dev);
+               if (cls->devices == NULL)
+                       cls->devices = dlist_new_with_delete
+                                       (sizeof(struct sysfs_class_device),
+                                                       sysfs_close_cls_dev);
+               dlist_unshift(cls->devices, dev);
        }
        }
-                       
        return 0;
 }
 
        return 0;
 }
 
@@ -238,7 +294,7 @@ static int get_all_class_devices(struct sysfs_class *cls)
  * sysfs_open_class: opens specific class and all its devices on system
  * returns sysfs_class structure with success or NULL with error.
  */
  * sysfs_open_class: opens specific class and all its devices on system
  * returns sysfs_class structure with success or NULL with error.
  */
-struct sysfs_class *sysfs_open_class(const char *name)
+struct sysfs_class *sysfs_open_class(const unsigned char *name)
 {
        struct sysfs_class *cls = NULL;
        struct sysfs_directory *classdir = NULL;
 {
        struct sysfs_class *cls = NULL;
        struct sysfs_directory *classdir = NULL;
@@ -250,24 +306,193 @@ struct sysfs_class *sysfs_open_class(const char *name)
 
        cls = alloc_class();
        if (cls == NULL) {
 
        cls = alloc_class();
        if (cls == NULL) {
-               perror("malloc");
+               dprintf("calloc failed\n");
                return NULL;
        }
        strcpy(cls->name, name);        
        classdir = open_class_dir(name);
        if (classdir == NULL) {
                return NULL;
        }
        strcpy(cls->name, name);        
        classdir = open_class_dir(name);
        if (classdir == NULL) {
-               dprintf(stderr,
-                       "Invalid class, %s not supported on this system\n",
+               dprintf("Invalid class, %s not supported on this system\n",
                        name);
                sysfs_close_class(cls);
                return NULL;
        }
        cls->directory = classdir;
                        name);
                sysfs_close_class(cls);
                return NULL;
        }
        cls->directory = classdir;
+       strcpy(cls->path, classdir->path);
        if ((get_all_class_devices(cls)) != 0) {
        if ((get_all_class_devices(cls)) != 0) {
-               dprintf(stderr, "Error reading %s class devices\n", name);
+               dprintf("Error reading %s class devices\n", name);
                sysfs_close_class(cls);
                return NULL;
        }
 
        return cls;
 }
                sysfs_close_class(cls);
                return NULL;
        }
 
        return cls;
 }
+
+/**
+ * sysfs_get_class_device: Get specific class device using the device's id
+ * @class: class to find device on
+ * @name: class name of the device
+ */ 
+struct sysfs_class_device *sysfs_get_class_device(struct sysfs_class *class,
+                                       unsigned char *name)
+{
+       if (class == NULL || name == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+
+       return (struct sysfs_class_device *)dlist_find_custom(class->devices,
+                       name, class_name_equal);
+}
+
+/**
+ * get_classdev_path: given the class and a device in the class, return the
+ *             absolute path to the device
+ * @classname: name of the class
+ * @clsdev: the class device
+ * @path: buffer to return path
+ * @psize: size of "path"
+ * Returns 0 on SUCCESS or -1 on error
+ */
+static int get_classdev_path(const unsigned char *classname, 
+               const unsigned char *clsdev, unsigned char *path, size_t len)
+{
+       if (classname == NULL || clsdev == NULL || path == NULL) {
+               errno = EINVAL;
+               return -1;
+       }
+        if (sysfs_get_mnt_path(path, len) != 0) {
+                dprintf("Error getting sysfs mount path\n");
+                return -1;
+       }
+       if (strcmp(classname, SYSFS_BLOCK_NAME) == 0) {
+               strcat(path, SYSFS_BLOCK_DIR);
+       } else {
+               strcat(path, SYSFS_CLASS_DIR);
+               strcat(path, "/");
+               strcat(path, classname);
+       }
+       strcat(path, "/");
+       strcat(path, clsdev);
+       return 0;
+}
+
+/**
+ * sysfs_open_class_device_by_name: Locates a specific class_device and returns it.
+ * Class_device must be closed using sysfs_close_class_device
+ * @classname: Class to search
+ * @name: name of the class_device
+ * 
+ * NOTE:
+ *     Call sysfs_close_class_device() to close the class device
+ */
+struct sysfs_class_device *sysfs_open_class_device_by_name
+               (const unsigned char *classname, const unsigned char *name)
+{
+       unsigned char devpath[SYSFS_PATH_MAX];
+       struct sysfs_class_device *cdev = NULL;
+
+       if (classname == NULL || name == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+       
+       memset(devpath, 0, SYSFS_PATH_MAX);
+       if ((get_classdev_path(classname, name, devpath, 
+                                       SYSFS_PATH_MAX)) != 0) {
+               dprintf("Error getting to device %s on class %s\n",
+                                                       name, classname);
+               return NULL;
+       }
+       
+       cdev = sysfs_open_class_device(devpath);
+       if (cdev == NULL) {
+               dprintf("Error getting class device %s from class %s\n",
+                               name, classname);
+               return NULL;
+       }
+       return cdev;
+}
+
+/**
+ * sysfs_get_classdev_attributes: returns a dlist of attributes for
+ *     the requested class_device
+ * @cdev: sysfs_class_dev for which attributes are needed
+ * returns a dlist of attributes if exists, NULL otherwise
+ */
+struct dlist *sysfs_get_classdev_attributes(struct sysfs_class_device *cdev)
+{
+       if (cdev == NULL || cdev->directory == NULL)
+               return NULL;
+
+       return (cdev->directory->attributes);
+}
+
+/**
+ * sysfs_get_classdev_attr: searches class device's attributes by name
+ * @clsdev: class device to look through
+ * @name: attribute name to get
+ * returns sysfs_attribute reference with success or NULL with error
+ */
+struct sysfs_attribute *sysfs_get_classdev_attr
+               (struct sysfs_class_device *clsdev, const unsigned char *name)
+{
+       struct sysfs_attribute *cur = NULL;
+
+       if (clsdev == NULL || clsdev->directory == NULL ||
+               clsdev->directory->attributes == NULL || name == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+
+       cur = sysfs_get_directory_attribute(clsdev->directory,
+                                               (unsigned char *)name);
+       if (cur != NULL)
+               return cur;
+
+       return NULL;
+}
+
+/**
+ * sysfs_open_classdev_attr: read an attribute for a given class device
+ * @classname: name of the class on which to look
+ * @dev: class device name for which the attribute has to be read
+ * @attrib: attribute to read
+ * Returns sysfs_attribute * on SUCCESS and NULL on error
+ * 
+ * NOTE:
+ *     A call to sysfs_close_attribute() is required to close the
+ *     attribute returned and to free memory
+ */
+struct sysfs_attribute *sysfs_open_classdev_attr(const unsigned char *classname,
+               const unsigned char *dev, const unsigned char *attrib)
+{
+       struct sysfs_attribute *attribute = NULL;
+       unsigned char path[SYSFS_PATH_MAX];
+
+       if (classname == NULL || dev == NULL || attrib == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+       memset(path, 0, SYSFS_PATH_MAX);
+       if ((get_classdev_path(classname, dev, path, SYSFS_PATH_MAX)) != 0) {
+               dprintf("Error getting to device %s on class %s\n",
+                                               dev, classname);
+               return NULL;
+       }
+       strcat(path, "/");
+       strcat(path, attrib);
+       attribute = sysfs_open_attribute(path);
+       if (attribute == NULL) {
+               dprintf("Error opening attribute %s on class device %s\n",
+                               attrib, dev);
+               return NULL;
+       }
+       if ((sysfs_read_attribute(attribute)) != 0) {
+               dprintf("Error reading attribute %s for class device %s\n",
+                               attrib, dev);
+               sysfs_close_attribute(attribute);
+               return NULL;
+       }
+       return attribute;
+}