Merging tag sysfsutils-1_3_0 with main trunk.HEADoriginmaster

2 files changed, 396 insertions, 37 deletions

diff --git a/include/dlist.h b/include/dlist.h
new file mode 100644
index 0000000..9e3a6c9
--- /dev/null
+++ b/include/dlist.h
@@ -0,0 +1,205 @@
+/*
+ * dlist.h
+ *
+ * Copyright (C) 2003 Eric J Bohm
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 2.1 of the License, or (at your option) any later version.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ */
+#ifndef _DLIST_H_
+#define _DLIST_H_
+
+/* Double linked list header.
+   
+* navigate your list with DLIST_PREV and DLIST_NEXT.  These are macros
+* so function call overhead is minimized.
+
+* Supports perl style push, pop, shift, unshift list semantics.
+
+* You allocate the data and give dlist the pointer.  If your data is
+* complex set the dlist->del_func to a an appropriate delete using
+* dlist_new_with_delete.  Your delete function must match 
+(void * )(del(void *)
+*Otherwise dlist will just use free.
+
+* NOTE: The small amount of pain involved in doing that allows us to
+* avoid copy in copy out semantics.
+
+* Dlist uses an internal mark pointer to keep track of where you are
+* in the list.
+
+* insert and delete take a directional parameter. Where direction
+* corresponds to the direction in which you want the list to go.
+* true direction corresponded to progressing forward in the last
+* false to regressing in the list.
+* so a dlist_insert(yourlist,item,1) will insert it after the mark
+* so a dlist_insert(yourlist,item,0) will insert it before the mark
+* any insert will move the mark to the new node regardless of the direction.
+
+* Just use the dlist_(insert|delete)_(before|after) macros if you do not want
+* to think about it.
+
+*/
+#include <malloc.h>
+typedef struct dl_node {
+  struct dl_node *prev;
+  struct dl_node *next;
+  void *data;
+} DL_node;
+
+typedef struct dlist {
+  DL_node *marker;
+  unsigned long count;
+  size_t data_size;
+  void (*del_func)(void *);
+  DL_node headnode;
+  DL_node *head;
+} Dlist;
+
+Dlist *dlist_new(size_t datasize);
+Dlist *dlist_new_with_delete(size_t datasize,void (*del_func)(void*));
+void *_dlist_mark_move(Dlist *list,int direction);
+void *dlist_mark(Dlist *);
+void dlist_start(Dlist *);
+void dlist_end(Dlist *);
+void dlist_move(struct dlist *source, struct dlist *dest, struct dl_node *target,int direction);
+void *dlist_insert(Dlist *,void *,int) ;
+
+void *dlist_insert_sorted(struct dlist *list, void *new_elem, int (*sorter)(void *, void *));
+
+void dlist_delete(Dlist *,int);
+
+void dlist_push(Dlist *,void *);
+
+void dlist_unshift(Dlist *,void *);
+void dlist_unshift_sorted(Dlist *,void *,int (*sorter)(void *, void *));
+
+void *dlist_pop(Dlist *);
+
+void *dlist_shift(Dlist *);
+
+void dlist_destroy(Dlist *);
+
+int _dlist_merge(struct dlist *listsource, struct dlist *listdest, unsigned int passcount, int (*compare)(void *, void *));
+
+void *dlist_find_custom(struct dlist *list, void *target, int (*comp)(void *, void *));
+
+void dlist_sort_custom(struct dlist *list, int (*compare)(void *, void *));
+
+
+void _dlist_swap(struct dlist *list, struct dl_node *a, struct dl_node *b);
+
+void dlist_transform(struct dlist *list, void (*node_operation)(void *));
+
+
+/* 
+ * _dlist_remove is for internal use only
+ * _dlist_mark_move is for internal use only
+ */
+void *_dlist_remove(struct dlist *,struct dl_node *,int );
+void *_dlist_insert_dlnode(struct dlist *list,struct dl_node *new_node,int direction);
+
+#define dlist_prev(A) _dlist_mark_move((A),0)
+#define dlist_next(A) _dlist_mark_move((A),1)
+
+#define dlist_insert_before(A,B) dlist_insert((A),(B),0)
+#define dlist_insert_after(A,B) dlist_insert((A),(B),1)
+
+#define dlist_delete_before(A) dlist_delete((A),0)
+#define dlist_delete_after(A) dlist_delete((A),1)
+
+/**
+ * provide for loop header which iterates the mark from start to end
+ * list: the dlist pointer, use dlist_mark(list) to get iterator
+ */
+#define dlist_for_each(list) \
+	for(dlist_start(list),dlist_next(list); \
+		(list)->marker!=(list)->head;dlist_next(list))
+
+/**
+ * provide for loop header which iterates the mark from end to start
+ * list: the dlist pointer, use dlist_mark(list) to get iterator
+ */
+#define dlist_for_each_rev(list) \
+	for(dlist_end(list),dlist_prev(list); \
+		(list)->marker!=(list)->head;dlist_prev(list))
+
+/**
+ * provide for loop header which iterates through the list without moving mark
+ * list: the dlist_pointer
+ * iterator: dl_node pointer to iterate
+ */
+#define dlist_for_each_nomark(list,iterator) \
+	for((iterator)=(list)->head->next; (iterator)!=(list)->head; \
+		(iterator)=(iterator)->next)
+
+/**
+ * provide for loop header which iterates through the list without moving mark
+ * in reverse
+ * list: the dlist_pointer
+ * iterator: dl_node pointer to iterate
+ */
+#define dlist_for_each_nomark_rev(list,iterator) \
+	for((iterator)=(list)->head->prev; (iterator)!=(list)->head; \
+		(iterator)=(iterator)->prev)
+/**
+ * provide for loop header which iterates through the list providing a
+ * data iterator
+ * list: the dlist pointer
+ * data_iterator: the pointer of type datatype to iterate
+ * datatype:  actual type of the contents in the dl_node->data
+ */
+
+#define dlist_for_each_data(list,data_iterator,datatype) \
+	for(dlist_start(list), (data_iterator)=(datatype *) dlist_next(list); \
+	(list)->marker!=(list)->head;(data_iterator)=(datatype *) dlist_next(list))
+
+/**
+ * provide for loop header which iterates through the list providing a
+ * data iterator in reverse
+ * list: the dlist pointer
+ * data_iterator: the pointer of type datatype to iterate
+ * datatype:  actual type of the contents in the dl_node->data
+ */
+#define dlist_for_each_data_rev(list,data_iterator,datatype) \
+	for(dlist_end(list), (data_iterator)=(datatype *) dlist_prev(list); \
+	(list)->marker!=(list)->head;(data_iterator)=(datatype *) dlist_prev(list))
+
+/**
+ * provide for loop header which iterates through the list providing a
+ * data iterator without moving the mark
+ * list: the dlist pointer
+ * iterator: the dl_node pointer to iterate
+ * data_iterator: the pointer of type datatype to iterate
+ * datatype:  actual type of the contents in the dl_node->data
+ */
+
+#define dlist_for_each_data_nomark(list,iterator,data_iterator,datatype) \
+	for((iterator)=(list)->head->next, (data_iterator)=(datatype *) (iterator)->data; \
+	(iterator)!=(list)->head;(iterator)=(iterator)->next,(data_iterator)=(datatype *) (iterator))
+
+/**
+ * provide for loop header which iterates through the list providing a
+ * data iterator in reverse without moving the mark
+ * list: the dlist pointer
+ * iterator: the dl_node pointer to iterate
+ * data_iterator: the pointer of type datatype to iterate
+ * datatype:  actual type of the contents in the dl_node->data
+ */
+#define dlist_for_each_data_nomark_rev(list,iterator, data_iterator,datatype) \
+	for((iterator)=(list)->head->prev, (data_iterator)=(datatype *) (iterator)->data; \
+	(iterator)!=(list)->head;(iterator)=(iterator)->prev,(data_iterator)=(datatype *) (iterator))
+
+#endif /* _DLIST_H_ */
diff --git a/include/libsysfs.h b/include/libsysfs.h
index 06c5f3a..29194f6 100644
--- a/include/libsysfs.h
+++ b/include/libsysfs.h
@@ -3,7 +3,7 @@
  *
  * Header Definitions 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
@@ -24,19 +24,40 @@
 #define _LIBSYSFS_H_
 
 #include <sys/types.h>
+#include <string.h>
+#include "dlist.h"
+
+/* 
+ * Defines to prevent buffer overruns
+ */
+#define safestrcpy(to, from)	strncpy(to, from, sizeof(to)-1)
+#define safestrcat(to, from)	strncat(to, from, sizeof(to) - strlen(to)-1)
+
+#define safestrcpymax(to, from, max) \
+do { \
+	to[max-1] = '\0'; \
+	strncpy(to, from, max-1); \
+} while (0)
+
+#define safestrcatmax(to, from, max) \
+do { \
+	to[max-1] = '\0'; \
+	strncat(to, from, max - strlen(to)-1); \
+} while (0)
 
 /*
  * Generic #defines go here..
  */ 
 #define SYSFS_FSTYPE_NAME	"sysfs"
 #define SYSFS_PROC_MNTS		"/proc/mounts"
-#define SYSFS_BUS_DIR		"/bus"
-#define SYSFS_CLASS_DIR		"/class"
-#define SYSFS_DEVICES_DIR	"/devices"
+#define SYSFS_BUS_NAME		"bus"
+#define SYSFS_CLASS_NAME	"class"
+#define SYSFS_BLOCK_NAME	"block"
 #define SYSFS_DEVICES_NAME	"devices"
-#define SYSFS_DRIVERS_DIR	"/drivers"
 #define SYSFS_DRIVERS_NAME	"drivers"
 #define SYSFS_NAME_ATTRIBUTE	"name"
+#define SYSFS_UNKNOWN		"unknown"
+#define SYSFS_PATH_ENV		"SYSFS_PATH"
 
 #define SYSFS_PATH_MAX		255
 #define	SYSFS_NAME_LEN		50
@@ -45,8 +66,13 @@
 #define SYSFS_METHOD_SHOW	0x01	/* attr can be read by user */
 #define SYSFS_METHOD_STORE	0x02	/* attr can be changed by user */
 
+/*
+ * NOTE: We have the statically allocated "name" as the first element of all 
+ * the structures. This feature is used in the "sorter" function for dlists
+ */
+
 struct sysfs_attribute {
-	struct sysfs_attribute *next;
+	char name[SYSFS_NAME_LEN];
 	char path[SYSFS_PATH_MAX];
 	char *value;
 	unsigned short len;		/* value length */
@@ -54,57 +80,81 @@ struct sysfs_attribute {
 };
 
 struct sysfs_link {
-	struct sysfs_link *next;
 	char name[SYSFS_NAME_LEN];
+	char path[SYSFS_PATH_MAX];
 	char target[SYSFS_PATH_MAX];
 };
 
 struct sysfs_directory {
-	struct sysfs_directory *next;
+	char name[SYSFS_NAME_LEN];
 	char path[SYSFS_PATH_MAX];
-	struct sysfs_directory *subdirs;
-	struct sysfs_link *links;
-	struct sysfs_attribute *attributes;
+
+	/* Private: for internal use only */
+	struct dlist *subdirs;	
+	struct dlist *links;		
+	struct dlist *attributes;
 };
 
 struct sysfs_driver {
-	struct sysfs_driver *next;
 	char name[SYSFS_NAME_LEN];
-	struct sysfs_directory *directory;
-	struct sysfs_device *device;
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct dlist *devices;
+	struct sysfs_directory *directory;	
 };
 
 struct sysfs_device {
-	struct sysfs_device *next;
 	char name[SYSFS_NAME_LEN];
 	char bus_id[SYSFS_NAME_LEN];
-	struct sysfs_driver *driver;
+	char bus[SYSFS_NAME_LEN];
+	char driver_name[SYSFS_NAME_LEN];
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct sysfs_device *parent;		
+	struct dlist *children;	
+	struct sysfs_directory *directory;	
+};
+
+struct sysfs_root_device {
+	char name[SYSFS_NAME_LEN];
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct dlist *devices;
 	struct sysfs_directory *directory;
-	struct sysfs_device *parent;
-	struct sysfs_device *children;
 };
 
 struct sysfs_bus {
-	struct sysfs_bus *next;
 	char name[SYSFS_NAME_LEN];
-	struct sysfs_directory *directory;
-	struct sysfs_driver *drivers;
-	struct sysfs_device *devices;
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct dlist *drivers;
+	struct dlist *devices;
+	struct sysfs_directory *directory;	
 };
 
 struct sysfs_class_device {
-	struct sysfs_class_device *next;
 	char name[SYSFS_NAME_LEN];
-	struct sysfs_directory *directory;
+	char classname[SYSFS_NAME_LEN];
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct sysfs_class_device *parent;	
 	struct sysfs_device *sysdevice;		/* NULL if virtual */
 	struct sysfs_driver *driver;		/* NULL if not implemented */
+	struct sysfs_directory *directory;	
 };
 
 struct sysfs_class {
-	struct sysfs_class *next;
 	char name[SYSFS_NAME_LEN];
-	struct sysfs_directory *directory;
-	struct sysfs_class_device *devices;
+	char path[SYSFS_PATH_MAX];
+
+	/* Private: for internal use only */
+	struct dlist *devices;
+	struct sysfs_directory *directory;	
 };
 
 #ifdef __cplusplus
@@ -115,44 +165,148 @@ extern "C" {
  * Function Prototypes
  */
 extern int sysfs_get_mnt_path(char *mnt_path, size_t len);
+extern int sysfs_remove_trailing_slash(char *path);
 extern int sysfs_get_name_from_path(const char *path, char *name, size_t len);
+extern int sysfs_path_is_dir(const char *path);
+extern int sysfs_path_is_link(const char *path);
+extern int sysfs_path_is_file(const char *path);
 extern int sysfs_get_link(const char *path, char *target, size_t len);
+extern struct dlist *sysfs_open_subsystem_list(char *name);
+extern struct dlist *sysfs_open_bus_devices_list(char *name);
+extern void sysfs_close_list(struct dlist *list);
 
 /* sysfs directory and file access */
 extern void sysfs_close_attribute(struct sysfs_attribute *sysattr);
 extern struct sysfs_attribute *sysfs_open_attribute(const char *path);
 extern int sysfs_read_attribute(struct sysfs_attribute *sysattr);
-extern int sysfs_read_attribute_value(const char *attrpath, char *value, 
-								size_t vsize);
-extern char *sysfs_get_value_from_attributes(struct sysfs_attribute *attr, 
-							const char * name);
+extern int sysfs_read_attribute_value(const char *attrpath, 
+		char *value, size_t vsize);
+extern int sysfs_write_attribute(struct sysfs_attribute *sysattr,
+		const char *new_value, size_t len);
+extern char *sysfs_get_value_from_attributes(struct dlist *attr, 
+		const char *name);
+extern int sysfs_refresh_dir_attributes(struct sysfs_directory *sysdir);
+extern int sysfs_refresh_dir_links(struct sysfs_directory *sysdir);
+extern int sysfs_refresh_dir_subdirs(struct sysfs_directory *sysdir);
 extern void sysfs_close_directory(struct sysfs_directory *sysdir);
 extern struct sysfs_directory *sysfs_open_directory(const char *path);
+extern int sysfs_read_dir_attributes(struct sysfs_directory *sysdir);
+extern int sysfs_read_dir_links(struct sysfs_directory *sysdir);
+extern int sysfs_read_dir_subdirs(struct sysfs_directory *sysdir);
 extern int sysfs_read_directory(struct sysfs_directory *sysdir);
+extern int sysfs_read_all_subdirs(struct sysfs_directory *sysdir);
+extern struct sysfs_directory *sysfs_get_subdirectory
+	(struct sysfs_directory *dir, char *subname);
 extern void sysfs_close_link(struct sysfs_link *ln);
 extern struct sysfs_link *sysfs_open_link(const char *lnpath);
+extern struct sysfs_link *sysfs_get_directory_link
+	(struct sysfs_directory *dir, char *linkname);
+extern struct sysfs_link *sysfs_get_subdirectory_link
+	(struct sysfs_directory *dir, char *linkname);
+extern struct sysfs_attribute *sysfs_get_directory_attribute
+	(struct sysfs_directory *dir, char *attrname);
+extern struct dlist *sysfs_get_dir_attributes(struct sysfs_directory *dir);
+extern struct dlist *sysfs_get_dir_links(struct sysfs_directory *dir);
+extern struct dlist *sysfs_get_dir_subdirs(struct sysfs_directory *dir);
 
 /* sysfs driver access */
 extern void sysfs_close_driver(struct sysfs_driver *driver);
-extern struct sysfs_driver *sysfs_open_driver(const char *path);
+extern struct sysfs_driver *sysfs_open_driver
+	(const char *bus_name, const char *drv_name);
+extern struct sysfs_driver *sysfs_open_driver_path(const char *path);
+extern struct sysfs_attribute *sysfs_get_driver_attr
+	(struct sysfs_driver *drv, const char *name);
+extern struct dlist *sysfs_get_driver_attributes(struct sysfs_driver *driver);
+extern struct dlist *sysfs_get_driver_devices(struct sysfs_driver *driver);
+extern struct dlist *sysfs_refresh_driver_devices(struct sysfs_driver *driver);
+extern struct dlist *sysfs_get_driver_links(struct sysfs_driver *driver);
+extern struct sysfs_device *sysfs_get_driver_device
+	(struct sysfs_driver *driver, const char *name);
+extern struct dlist *sysfs_refresh_driver_attributes
+	(struct sysfs_driver *driver);
+extern struct sysfs_attribute *sysfs_open_driver_attr
+	(const char *bus, const char *drv, const char *attrib);
 
 /* generic sysfs device access */
-extern void sysfs_close_device(struct sysfs_device *dev);
-extern void sysfs_close_device_tree(struct sysfs_device *dev);
-extern struct sysfs_device *sysfs_open_device(const char *path);
+extern void sysfs_close_root_device(struct sysfs_root_device *root);
+extern struct sysfs_root_device *sysfs_open_root_device(const char *name);
+extern struct dlist *sysfs_get_root_devices(struct sysfs_root_device *root);
+extern void sysfs_close_device_tree(struct sysfs_device *device);
 extern struct sysfs_device *sysfs_open_device_tree(const char *path);
+extern void sysfs_close_device(struct sysfs_device *dev);
+extern struct sysfs_device *sysfs_open_device
+	(const char *bus, const char *bus_id);
+extern struct sysfs_device *sysfs_get_device_parent(struct sysfs_device *dev);
+extern struct sysfs_device *sysfs_open_device_path(const char *path);
+extern int sysfs_get_device_bus(struct sysfs_device *dev);
 extern struct sysfs_attribute *sysfs_get_device_attr
-				(struct sysfs_device *dev, const char *name);
+	(struct sysfs_device *dev, const char *name);
+extern struct dlist *sysfs_get_device_attributes(struct sysfs_device *device);
+extern struct dlist *sysfs_refresh_device_attributes
+	(struct sysfs_device *device);
+extern struct sysfs_attribute *sysfs_open_device_attr(const char *bus, 
+		const char *bus_id, const char *attrib);
 
 /* generic sysfs bus access */
 extern void sysfs_close_bus(struct sysfs_bus *bus);
 extern struct sysfs_bus *sysfs_open_bus(const char *name);
+extern struct sysfs_device *sysfs_get_bus_device(struct sysfs_bus *bus, 
+		char *id);
+extern struct sysfs_driver *sysfs_get_bus_driver(struct sysfs_bus *bus,
+		char *drvname);
+extern struct dlist *sysfs_get_bus_drivers(struct sysfs_bus *bus);
+extern struct dlist *sysfs_get_bus_devices(struct sysfs_bus *bus);
+extern struct dlist *sysfs_get_bus_attributes(struct sysfs_bus *bus);
+extern struct dlist *sysfs_refresh_bus_attributes(struct sysfs_bus *bus);
+extern struct sysfs_attribute *sysfs_get_bus_attribute
+	(struct sysfs_bus *bus,	char *attrname);
+extern int sysfs_find_driver_bus(const char *driver, char *busname, 
+		size_t bsize);
 
 /* generic sysfs class access */
 extern void sysfs_close_class_device(struct sysfs_class_device *dev);
-extern struct sysfs_class_device *sysfs_open_class_device(const char *path);
+extern struct sysfs_class_device *sysfs_open_class_device_path
+	(const char *path);
+extern struct sysfs_class_device *sysfs_open_class_device
+	(const char *classname, const char *name);
+extern struct sysfs_device *sysfs_get_classdev_device
+	(struct sysfs_class_device *clsdev);
+extern struct sysfs_driver *sysfs_get_classdev_driver
+	(struct sysfs_class_device *clsdev);
+extern struct sysfs_class_device *sysfs_get_classdev_parent
+	(struct sysfs_class_device *clsdev);
 extern void sysfs_close_class(struct sysfs_class *cls);
 extern struct sysfs_class *sysfs_open_class(const char *name);
+extern struct dlist *sysfs_get_class_devices(struct sysfs_class *cls);
+extern struct sysfs_class_device *sysfs_get_class_device
+	(struct sysfs_class *cls, char *name);
+extern struct dlist *sysfs_get_classdev_attributes
+	(struct sysfs_class_device *cdev);
+extern struct dlist *sysfs_refresh_classdev_attributes
+	(struct sysfs_class_device *cdev);
+extern struct sysfs_attribute *sysfs_get_classdev_attr
+	(struct sysfs_class_device *clsdev, const char *name);
+extern struct sysfs_attribute *sysfs_open_classdev_attr
+	(const char *classname, const char *dev, 
+	 					const char *attrib); 
+
+/**
+ * sort_list: sorter function to keep list elements sorted in alphabetical 
+ * 	order. Just does a strncmp as you can see :)
+ * 	
+ * Returns 1 if less than 0 otherwise
+ *
+ * NOTE: We take care to have a statically allocated "name" as the first 
+ * 	lement of all libsysfs structures. Hence, this function will work 
+ * 	AS IS for _ALL_ the lists that have to be sorted.
+ */
+static inline int sort_list(void *new_elem, void *old_elem)
+{
+        return ((strncmp(((struct sysfs_attribute *)new_elem)->name,
+		((struct sysfs_attribute *)old_elem)->name,
+		strlen(((struct sysfs_attribute *)new_elem)->name))) < 0 ? 1 : 0);
+}
+
 
 #ifdef __cplusplus
 }