]> Erik (J.A.K.) Mouw Universidad de Tecnología Delft Facultad de Sistemas y Tecnología de la Información

J.A.K.Mouw@its.tudelft.nl PO BOX 5031 2600 GA Delft Holanda

1.0  30 de Mayo, 2001 Revisión Inicial mandada a linux-kernel 1.1  3 de Junio, 2001 Revisada después de los comentarios de linux-kernel 2001 Erik Mouw Esta documentación es software libre; puedes redistrubuirla y/o modificarla bajo los términos de la GNU General Public License tal como ha sido publicada por la Free Software Foundation; por la versión 2 de la licencia, o (a tu elección) por cualquier versión posterior. Este programa es distribuido con la esperanza de que sea útil, pero SIN NINGUNA GARANTIA; sin incluso la garantía implicada de COMERCIABILIDAD o ADECUACCION PARA UN PROPOSITO PARTICULAR. Para más detalles refiérase a la GNU General Public License. Debería de haber recibido una copia de la GNU General Public License con este programa; si no es así, escriba a la Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Para más detalles véase el archivo COPYING en la distribución fuente de Linux. Esta guía describe el uso del sistema de archivos procfs del Núcleo Linux. La idea de escribir esta guía vino del canal de IRC kernelnewbies (ver http://www.kernelnewbies.org/), cuando Jeff Garzik explicó el uso de procfs y me envió un mensaje de Alexander Viro que escribió a la lista de correo linux-kernel. Estuve de acuerdo en escribirla de forma más bonita, por lo tanto aquí está. Me gustaría dar las gracias a Jeff Garzik jgarzik@mandrakesoft.com y Alexander Viro viro@math.psu.edu por su entrada, a Tim Waugh twaugh@redhat.com por su Selfdocbook, y a Marc Joosen marcj@historia.et.tudelft.nl por la profunda lectura. Esta documentación fue escrita mientras trabajaba en el LART computing board (http://www.lart.tudelft.nl/), que es patrocinada por los proyectos Mobile Multi-media Communications (http://www.mmc.tudelft.nl/) y Ubiquitous Communications (http://www.ubicom.tudelft.nl/). Erik El sistema de archivos /proc (procfs) es un sistema de archivos especial en el núcleo Linux. Es un sistema de archivos virtual; no está asociado con un dispositivo de bloque ya que existe sólo en memoria. Los archivos en el procfs están allí para permitir a los programas de usuario acceder a cierta información del núcleo (como información sobre los procesos en /proc/[0-9]+/), y también para propósitos de depuración (como /proc/ksyms). Esta guía describe el uso del sistema de archivos procfs del núcleo Linux. Empieza introduciendo todas las funciones relevantes para administar los archivos en el sistema de archivos. Después de esto muestra cómo se comunica con los programas de usuario, y algunos trucos y propinas serán apuntados. Finalmente, será mostrado un ejemplo completo. Destacar que los archivos en /proc/sys son archivos sysctl: no pertenecen al procfs y son gobernados por una API completamente diferente descrita en el libro de la API del Núcleo. Este capítulo describe las funciones de varios componentes del núcleo usadas para propagar el procfs con archivos, enlaces simbólicos, nodos de dispositivos, y directorios. Una pequeña nota antes de empezar: si quieres usar alguna de las funciones procfs, ¡asegúrate de incluir el archivo de cabeceras correspondiente! Esta debería de ser una de las primeras líneas en tu código: #include <linux/proc_fs.h> struct proc_dir_entry* create_proc_entry const char* name mode_t mode struct proc_dir_entry* parent Esta función crea un archivo normal con el nombre name, el modo del archivo mode en el directorio parent. Para crear un archivo en el directorio raíz, usa NULL como parámetro a parent Cuando tenga éxito, la función retornará un puntero a la nueva struct proc_dir_entry creada; en otro caso retornará NULL. describe cómo hacer algo útil con los archivos normales. Destacar que está específicamente soportado el poder pasarle un camino que se extienda a través de múltiples directorios. Por ejemplo, create_proc_entry("drivers/via0/info") creará el directorio via0 si es necesario, con los permisos estándar 0755. Si sólo quieres ser capaz de leer el archivo, la función create_proc_read_entry descrita en puede ser usada para crear e inicializar la entrada en el procfs con una simple llamada. struct proc_dir_entry* proc_symlink const char* name struct proc_dir_entry* parent const char* dest Esto crea un enlace simbólico en el directorio procfs parent que apunta a name en dest. Esto se traduce en los programas de usuario en ln -s dest name. struct proc_dir_entry* proc_mknod const char* name mode_t mode struct proc_dir_entry* parent kdev_t rdev Crea un archivo de dispositivo name con el modo mode en el directorio procfs parent. El archivo del dispositivo trabajará en el dispositivo rdev, que puede ser generado usando la macro MKDEV desde linux/kdev_t.h. El parámetro mode debe de contener S_IFBLK o S_IFCHR para crear un nodo de dispositivo. Compáralo con el programa de usuario mknod --mode=mode name rdev. struct proc_dir_entry* proc_mkdir const char* name struct proc_dir_entry* parent Crea un directorio name en el directorio procfs parent. void remove_proc_entry const char* name struct proc_dir_entry* parent Borra la entrada name en el directorio parent del procfs. Las entradas son quitadas por su name, no por la struct proc_dir_entry retornada por las diversas funciones de creación. Destacar que esta función no borra recursivamente las entradas. Asegúrate de liberar la entrada data de struct proc_dir_entry antes de que sea llamado remove_proc_entry (esto es: si había alguna data asignada, por supuesto). Ver para más información sobre el uso de la entrada data. En vez de leer (o escribir) información directamente desde la memoria del núcleo, procfs trabaja con funciones de retrollamada para los archivos: funciones que son llamadas cuando un archivo específico está siendo leído o escrito. Tales funciones tienen que ser inicializadas después de que el archivo procfs sea creado estableciendo los campos read_proc y/o write_proc en la struct proc_dir_entry* que retorna la función create_proc_entry: struct proc_dir_entry* entry; entry->read_proc = read_proc_foo; entry->write_proc = write_proc_foo; Si sólo quieres usar la read_proc, la función create_proc_read_entry descrita en puede ser utilizada para crear e inicializar la entrada procfs con una simple llamada. La función de lectura es una función de retrollamada que permite a los procesos de usuario leer datos del núcleo. La función de lectura debe de tener el siguiente formato: int read_func char* page char** start off_t off int count int* eof void* data La función de lectura debería de escribir su información en page. Para un uso adecuado, la función debería de empezar escribiendo en un desplazamiento de off en page y escribir al menos count bytes, como la mayoría de las funciones de lectura son bastante simples y sólo retornarán una pequeña cantidad de información, estos dos parámetros son usualmente ignorados (y rompe paginadores como more y less, pero cat todavía trabaja). Si los parámetros off y count son usados de una forma adecuada, eof debería de ser utilizado para señalar que el final del archivo ha llegado escribiendo 1 en la localización de memoria a donde apunta eof. El parámetro start no parece ser usado en ningún sitio en el núcleo. El parámetro data puede ser usado para crear una función simple de retrollamada para varios archivos, ver . La función read_func debe de retornar el número de bytes escritos en page. muestra cómo usar la función de retrollamada de lectura. La función de retrollamada de escritura permite a los procesos de usuario escribir datos en el núcleo, por lo tanto tiene cierta clase de control sobre el núcleo. La función de escritura debería de tener el siguiente formato: int write_func struct file* file const char* buffer unsigned long count void* data La función de escritura lee count bytes como máximo del buffer. Destacar que buffer no reside en el espacio de memoria del núcleo, por lo tanto debería de ser primero copiado al espacio del núcleo con copy_from_user. El parámetro file es usualmente ignorado. muestra como usar el parámetro data. Otra vez, muestra cómo usar esta función de retrollamada. Cuando es usado un gran número de archivos casi idénticos, es bastante conveniente usar una función de retrollamada separada para cada archivo. Una mejor aproximación es tener una función simple de retrollamada que distinga entre los archivos usando el campo data en struct proc_dir_entry. Lo primero de todo, el campo data tiene que estar inicializado: struct proc_dir_entry* entry; struct my_file_data *file_data; file_data = kmalloc(sizeof(struct my_file_data), GFP_KERNEL); entry->data = file_data; El campo data es un void *, por lo tanto puede ser inicializado con cualquier cosa. Ahora que el campo data está establecido, read_proc y write_proc pueden utilizarlo para distinguir entre archivos, porque ellos son pasados en sus parámetros data: int foo_read_func(char *page, char **start, off_t off, int count, int *eof, void *data) { int len; if(data == file_data) { /* caso especial para este archivo */ } else { /* procesamiento normal */ } return len; } Asegúrate de liberar el campo de datos data cuando quites la entrada procfs. struct proc_dir_entry* create_proc_read_entry const char* name mode_t mode struct proc_dir_entry* parent read_proc_t* read_proc void* data Esta función crea un archivo normal exactamente de la misma forma que lo hace create_proc_entry desde , pero también permite establecer la función de lectura read_proc en una llamada. Esta función puede establecer también el parámetro data, como ya ha sido explicado en . SI procfs está siendo usado desde un módulo, asegúrate de establecer el campo owner en struct proc_dir_entry a THIS_MODULE. struct proc_dir_entry* entry; entry->owner = THIS_MODULE; Algunas veces es útil cambiar el modo y/o dueño de una entrada procfs. Aquí hay un ejemplo que muestra cómo realizar esto: struct proc_dir_entry* entry; entry->mode = S_IWUSR |S_IRUSR | S_IRGRP | S_IROTH; entry->uid = 0; entry->gid = 100; Para compilar este módulo utiliza: gcc -I/usr/src/linux-2.4/include -Wall -DMODULE -D__KERNEL__ -DLINUX -c ejemplo_procfs.c &procfsexample; Este documento es la traducción de "Linux Kernel Procfs Guide", documento que acompaña al código del núcleo de Linux, versión 2.4.18. Este documento ha sido traducido por Rubén Melcón melkon@terra.es; y es publicado por el Proyecto Lucas Versión de la tradución 0.04 ( Julio de 2002 ). Si tienes comentarios sobre la traducción, ponte en contacto con Rubén Melcón melkon@terra.es