123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833 |
- /****************************************************************************
- * net/procfs/net_procfs.c
- *
- * Copyright (C) 2015 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <sys/types.h>
- #include <sys/statfs.h>
- #include <sys/stat.h>
- #include <stdint.h>
- #include <stdbool.h>
- #include <string.h>
- #include <fcntl.h>
- #include <libgen.h>
- #include <assert.h>
- #include <errno.h>
- #include <debug.h>
- #include <nuttx/kmalloc.h>
- #include <nuttx/fs/fs.h>
- #include <nuttx/fs/procfs.h>
- #include <nuttx/fs/dirent.h>
- #include <nuttx/lib/regex.h>
- #include <nuttx/net/netdev.h>
- #include "netdev/netdev.h"
- #include "procfs/procfs.h"
- #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_PROCFS) && \
- !defined(CONFIG_FS_PROCFS_EXCLUDE_NET)
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* Directory entry indices */
- #ifdef CONFIG_NET_STATISTICS
- # define STAT_INDEX 0
- # ifdef CONFIG_NET_MLD
- # define MLD_INDEX 1
- # define _ROUTE_INDEX 2
- # else
- # define _ROUTE_INDEX 1
- # endif
- #else
- # define _ROUTE_INDEX 0
- #endif
- #ifdef CONFIG_NET_ROUTE
- # define ROUTE_INDEX _ROUTE_INDEX
- # define DEV_INDEX (_ROUTE_INDEX + 1)
- #else
- # define DEV_INDEX _ROUTE_INDEX
- #endif
- /****************************************************************************
- * Private Function Prototypes
- ****************************************************************************/
- /* File system methods */
- static int netprocfs_open(FAR struct file *filep, FAR const char *relpath,
- int oflags, mode_t mode);
- static int netprocfs_close(FAR struct file *filep);
- static ssize_t netprocfs_read(FAR struct file *filep, FAR char *buffer,
- size_t buflen);
- static int netprocfs_dup(FAR const struct file *oldp,
- FAR struct file *newp);
- static int netprocfs_opendir(FAR const char *relpath,
- FAR struct fs_dirent_s *dir);
- static int netprocfs_closedir(FAR struct fs_dirent_s *dir);
- static int netprocfs_readdir(FAR struct fs_dirent_s *dir);
- static int netprocfs_rewinddir(FAR struct fs_dirent_s *dir);
- static int netprocfs_stat(FAR const char *relpath, FAR struct stat *buf);
- /****************************************************************************
- * Public Data
- ****************************************************************************/
- /* See include/nutts/fs/procfs.h
- * We use the old-fashioned kind of initializers so that this will compile
- * with any compiler.
- */
- const struct procfs_operations net_procfsoperations =
- {
- netprocfs_open, /* open */
- netprocfs_close, /* close */
- netprocfs_read, /* read */
- NULL, /* write */
- netprocfs_dup, /* dup */
- netprocfs_opendir, /* opendir */
- netprocfs_closedir, /* closedir */
- netprocfs_readdir, /* readdir */
- netprocfs_rewinddir, /* rewinddir */
- netprocfs_stat /* stat */
- };
- extern const struct procfs_operations net_procfs_routeoperations;
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: netprocfs_open
- ****************************************************************************/
- static int netprocfs_open(FAR struct file *filep, FAR const char *relpath,
- int oflags, mode_t mode)
- {
- FAR struct netprocfs_file_s *priv;
- FAR struct net_driver_s *dev;
- enum netprocfs_entry_e entry;
- finfo("Open '%s'\n", relpath);
- /* PROCFS is read-only. Any attempt to open with any kind of write
- * access is not permitted.
- *
- * REVISIT: Write-able proc files could be quite useful.
- */
- if (((oflags & O_WRONLY) != 0 || (oflags & O_RDONLY) == 0) &&
- (net_procfsoperations.write == NULL))
- {
- ferr("ERROR: Only O_RDONLY supported\n");
- return -EACCES;
- }
- #ifdef CONFIG_NET_STATISTICS
- /* "net/stat" is an acceptable value for the relpath only if network layer
- * statistics are enabled.
- */
- if (strcmp(relpath, "net/stat") == 0)
- {
- entry = NETPROCFS_SUBDIR_STAT;
- dev = NULL;
- }
- else
- #ifdef CONFIG_NET_MLD
- /* "net/mld" is an acceptable value for the relpath only if MLD is enabled. */
- if (strcmp(relpath, "net/mld") == 0)
- {
- entry = NETPROCFS_SUBDIR_MLD;
- dev = NULL;
- }
- else
- #endif
- #endif
- #ifdef CONFIG_NET_ROUTE
- /* "net/route" is an acceptable value for the relpath only if routing
- * table support is initialized.
- */
- if (match("net/route/**", relpath))
- {
- /* Use the /net/route directory */
- return net_procfs_routeoperations.open(filep, relpath, oflags, mode);
- }
- else
- #endif
- {
- FAR char *devname;
- FAR char *copy;
- /* Otherwise, we need to search the list of registered network devices
- * to determine if the name corresponds to a network device.
- */
- copy = strdup(relpath);
- if (copy == NULL)
- {
- ferr("ERROR: strdup failed\n");
- return -ENOMEM;
- }
- devname = basename(copy);
- dev = netdev_findbyname(devname);
- kmm_free(copy);
- if (dev == NULL)
- {
- ferr("ERROR: relpath is '%s'\n", relpath);
- return -ENOENT;
- }
- entry = NETPROCFS_SUBDIR_DEV;
- }
- /* Allocate the open file structure */
- priv = (FAR struct netprocfs_file_s *)
- kmm_zalloc(sizeof(struct netprocfs_file_s));
- if (!priv)
- {
- ferr("ERROR: Failed to allocate file attributes\n");
- return -ENOMEM;
- }
- /* Initialize the open-file structure */
- priv->dev = dev;
- priv->entry = entry;
- /* Save the open file structure as the open-specific state in
- * filep->f_priv.
- */
- filep->f_priv = (FAR void *)priv;
- return OK;
- }
- /****************************************************************************
- * Name: netprocfs_close
- ****************************************************************************/
- static int netprocfs_close(FAR struct file *filep)
- {
- FAR struct netprocfs_file_s *priv;
- /* Recover our private data from the struct file instance */
- priv = (FAR struct netprocfs_file_s *)filep->f_priv;
- DEBUGASSERT(priv);
- /* Release the file attributes structure */
- kmm_free(priv);
- filep->f_priv = NULL;
- return OK;
- }
- /****************************************************************************
- * Name: netprocfs_read
- ****************************************************************************/
- static ssize_t netprocfs_read(FAR struct file *filep, FAR char *buffer,
- size_t buflen)
- {
- FAR struct netprocfs_file_s *priv;
- ssize_t nreturned;
- finfo("buffer=%p buflen=%lu\n", buffer, (unsigned long)buflen);
- /* Recover our private data from the struct file instance */
- priv = (FAR struct netprocfs_file_s *)filep->f_priv;
- DEBUGASSERT(priv);
- /* Read according to the sub-directory */
- switch (priv->entry)
- {
- case NETPROCFS_SUBDIR_DEV:
- /* Show device-specific statistics */
- nreturned = netprocfs_read_devstats(priv, buffer, buflen);
- break;
- #ifdef CONFIG_NET_STATISTICS
- case NETPROCFS_SUBDIR_STAT:
- /* Show the network layer statistics */
- nreturned = netprocfs_read_netstats(priv, buffer, buflen);
- break;
- #ifdef CONFIG_NET_MLD
- case NETPROCFS_SUBDIR_MLD:
- /* Show the MLD statistics */
- nreturned = netprocfs_read_mldstats(priv, buffer, buflen);
- break;
- #endif
- #endif
- #ifdef CONFIG_NET_ROUTE
- case NETPROCFS_SUBDIR_ROUTE:
- nerr("ERROR: Cannot read from directory net/route\n");
- #endif
- default:
- nerr("ERROR: Invalid entry for reading: %u\n", priv->entry);
- nreturned = -EINVAL;
- }
- /* Update the file offset */
- if (nreturned > 0)
- {
- filep->f_pos += nreturned;
- }
- return nreturned;
- }
- /****************************************************************************
- * Name: netprocfs_dup
- *
- * Description:
- * Duplicate open file data in the new file structure.
- *
- ****************************************************************************/
- static int netprocfs_dup(FAR const struct file *oldp, FAR struct file *newp)
- {
- FAR struct netprocfs_file_s *oldpriv;
- FAR struct netprocfs_file_s *newpriv;
- finfo("Dup %p->%p\n", oldp, newp);
- /* Recover our private data from the old struct file instance */
- oldpriv = (FAR struct netprocfs_file_s *)oldp->f_priv;
- DEBUGASSERT(oldpriv);
- /* Allocate a new container to hold the task and attribute selection */
- newpriv = (FAR struct netprocfs_file_s *)kmm_zalloc(sizeof(struct netprocfs_file_s));
- if (!newpriv)
- {
- ferr("ERROR: Failed to allocate file attributes\n");
- return -ENOMEM;
- }
- /* The copy the file attribtes from the old attributes to the new */
- memcpy(newpriv, oldpriv, sizeof(struct netprocfs_file_s));
- /* Save the new attributes in the new file structure */
- newp->f_priv = (FAR void *)newpriv;
- return OK;
- }
- /****************************************************************************
- * Name: netprocfs_opendir
- *
- * Description:
- * Open a directory for read access
- *
- ****************************************************************************/
- static int netprocfs_opendir(FAR const char *relpath,
- FAR struct fs_dirent_s *dir)
- {
- FAR struct netprocfs_level1_s *level1;
- int ndevs;
- int ret;
- finfo("relpath: \"%s\"\n", relpath ? relpath : "NULL");
- DEBUGASSERT(relpath && dir && !dir->u.procfs);
- /* "net" and "net/route" are the only values of relpath that are
- * directories.
- */
- #ifdef CONFIG_NET_ROUTE
- if (match("net/route", relpath) || match("net/route/**", relpath))
- {
- /* Use the /net/route directory */
- return net_procfs_routeoperations.opendir(relpath, dir);
- }
- #endif
- /* Assume that path refers to the 1st level subdirectory. Allocate the
- * level1 the dirent structure before checking.
- */
- level1 = (FAR struct netprocfs_level1_s *)
- kmm_zalloc(sizeof(struct netprocfs_level1_s));
- if (level1 == NULL)
- {
- ferr("ERROR: Failed to allocate the level1 directory structure\n");
- return -ENOMEM;
- }
- level1->base.level = 1;
- if (strcmp(relpath, "net") == 0)
- {
- /* Count the number of network devices */
- ndevs = netdev_count();
- /* Initialize base structure components */
- level1->base.nentries = ndevs;
- #ifdef CONFIG_NET_STATISTICS
- level1->base.nentries++;
- #ifdef CONFIG_NET_MLD
- level1->base.nentries++;
- #endif
- #endif
- #ifdef CONFIG_NET_ROUTE
- level1->base.nentries++;
- #endif
- }
- else
- {
- /* REVISIT: We really need to check if the relpath refers to a network
- * device. In that case, we need to return -ENOTDIR. Otherwise, we
- * should return -ENOENT.
- */
- ferr("ERROR: Bad relpath: %s\n", relpath);
- ret = -ENOTDIR;
- goto errout_with_alloc;
- }
- dir->u.procfs = (FAR void *)level1;
- return OK;
- errout_with_alloc:
- kmm_free(level1);
- return ret;
- }
- /****************************************************************************
- * Name: netprocfs_closedir
- *
- * Description: Close the directory listing
- *
- ****************************************************************************/
- static int netprocfs_closedir(FAR struct fs_dirent_s *dir)
- {
- FAR struct netprocfs_level1_s *priv;
- DEBUGASSERT(dir && dir->u.procfs);
- priv = dir->u.procfs;
- if (priv)
- {
- kmm_free(priv);
- }
- dir->u.procfs = NULL;
- return OK;
- }
- /****************************************************************************
- * Name: netprocfs_readdir
- *
- * Description: Read the next directory entry
- *
- ****************************************************************************/
- static int netprocfs_readdir(FAR struct fs_dirent_s *dir)
- {
- FAR struct netprocfs_level1_s *level1;
- FAR struct net_driver_s *dev;
- int index;
- int ret;
- DEBUGASSERT(dir && dir->u.procfs);
- level1 = dir->u.procfs;
- DEBUGASSERT(level1->base.level > 0);
- /* Are we searching this directory? Or is it just an intermediate on the
- * way to a sub-directory?
- */
- if (level1->base.level == 1)
- {
- /* This directory.. Have we reached the end of the directory? */
- index = level1->base.index;
- DEBUGASSERT(index <= level1->base.nentries);
- if (index >= level1->base.nentries)
- {
- /* We signal the end of the directory by returning the special
- * error -ENOENT.
- */
- finfo("Entry %d: End of directory\n", index);
- return -ENOENT;
- }
- #ifdef CONFIG_NET_STATISTICS
- if (index == STAT_INDEX)
- {
- /* Copy the network statistics directory entry */
- dir->fd_dir.d_type = DTYPE_FILE;
- strncpy(dir->fd_dir.d_name, "stat", NAME_MAX + 1);
- }
- else
- #ifdef CONFIG_NET_MLD
- if (index == MLD_INDEX)
- {
- /* Copy the MLD directory entry */
- dir->fd_dir.d_type = DTYPE_FILE;
- strncpy(dir->fd_dir.d_name, "mld", NAME_MAX + 1);
- }
- else
- #endif
- #endif
- #ifdef CONFIG_NET_ROUTE
- if (index == ROUTE_INDEX)
- {
- /* Copy the network statistics directory entry */
- dir->fd_dir.d_type = DTYPE_DIRECTORY;
- strncpy(dir->fd_dir.d_name, "route", NAME_MAX + 1);
- }
- else
- #endif
- {
- int ifindex;
- #ifdef CONFIG_NETDEV_IFINDEX
- /* For the first network device, ifindex will be zero. We have
- * to take some special action to get the correct starting
- * ifindex.
- */
- if (level1->ifindex == 0)
- {
- ifindex = netdev_nextindex(1);
- }
- else
- {
- ifindex = netdev_nextindex(level1->ifindex);
- }
- if (ifindex < 0)
- {
- /* There are no more... one must have been unregistered */
- return -ENOENT;
- }
- level1->ifindex = ifindex + 1;
- #else
- /* Get the raw index, accounting for 1 based indexing */
- ifindex = index - DEV_INDEX + 1;
- #endif
- /* Find the device corresponding to this device index */
- dev = netdev_findbyindex(ifindex);
- if (dev == NULL)
- {
- /* What happened? */
- return -ENOENT;
- }
- /* Copy the device statistics file entry */
- dir->fd_dir.d_type = DTYPE_FILE;
- strncpy(dir->fd_dir.d_name, dev->d_ifname, NAME_MAX + 1);
- }
- /* Set up the next directory entry offset. NOTE that we could use the
- * standard f_pos instead of our own private index.
- */
- level1->base.index = index + 1;
- ret = OK;
- }
- else
- {
- /* We are performing a directory search of one of the subdirectories
- * and we must let the handler perform the read.
- */
- DEBUGASSERT(level1->base.procfsentry != NULL &&
- level1->base.procfsentry->ops->readdir != NULL);
- ret = level1->base.procfsentry->ops->readdir(dir);
- }
- return ret;
- }
- /****************************************************************************
- * Name: netprocfs_rewindir
- *
- * Description: Reset directory read to the first entry
- *
- ****************************************************************************/
- static int netprocfs_rewinddir(FAR struct fs_dirent_s *dir)
- {
- FAR struct netprocfs_level1_s *priv;
- DEBUGASSERT(dir && dir->u.procfs);
- priv = dir->u.procfs;
- priv->base.index = 0;
- return OK;
- }
- /****************************************************************************
- * Name: netprocfs_stat
- *
- * Description: Return information about a file or directory
- *
- ****************************************************************************/
- static int netprocfs_stat(FAR const char *relpath, FAR struct stat *buf)
- {
- /* Check for the directory "net" */
- if (strcmp(relpath, "net") == 0)
- {
- buf->st_mode = S_IFDIR | S_IROTH | S_IRGRP | S_IRUSR;
- }
- else
- #ifdef CONFIG_NET_STATISTICS
- /* Check for network statistics "net/stat" */
- if (strcmp(relpath, "net/stat") == 0)
- {
- buf->st_mode = S_IFREG | S_IROTH | S_IRGRP | S_IRUSR;
- }
- else
- #ifdef CONFIG_NET_MLD
- /* Check for MLD statistics "net/mld" */
- if (strcmp(relpath, "net/mld") == 0)
- {
- buf->st_mode = S_IFREG | S_IROTH | S_IRGRP | S_IRUSR;
- }
- else
- #endif
- #endif
- #ifdef CONFIG_NET_ROUTE
- /* Check for network statistics "net/stat" */
- if (strcmp(relpath, "net/route") == 0)
- {
- buf->st_mode = S_IFDIR | S_IROTH | S_IRGRP | S_IRUSR;
- }
- else
- #endif
- {
- FAR struct net_driver_s *dev;
- FAR char *devname;
- FAR char *copy;
- /* Otherwise, we need to search the list of registered network devices
- * to determine if the name corresponds to a network device.
- */
- copy = strdup(relpath);
- if (copy == NULL)
- {
- ferr("ERROR: strdup failed\n");
- return -ENOMEM;
- }
- devname = basename(copy);
- dev = netdev_findbyname(devname);
- kmm_free(copy);
- if (dev == NULL)
- {
- ferr("ERROR: relpath is '%s'\n", relpath);
- return -ENOENT;
- }
- buf->st_mode = S_IFREG | S_IROTH | S_IRGRP | S_IRUSR;
- }
- /* File/directory size, access block size */
- buf->st_size = 0;
- buf->st_blksize = 0;
- buf->st_blocks = 0;
- return OK;
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: netprocfs_read_linegen
- *
- * Description:
- * Read and format procfs data using a line generation table.
- *
- * Input Parameters:
- * priv - A reference to the network procfs file structure
- * buffer - The user-provided buffer into which device status will be
- * returned.
- * buflen - The size in bytes of the user provided buffer.
- * gentab - Table of line generation functions
- * nelems - The number of elements in the table
- *
- * Returned Value:
- * Zero (OK) is returned on success; a negated errno value is returned
- * on failure.
- *
- ****************************************************************************/
- ssize_t netprocfs_read_linegen(FAR struct netprocfs_file_s *priv,
- FAR char *buffer, size_t buflen,
- FAR const linegen_t *gentab, int nelems)
- {
- size_t xfrsize;
- ssize_t nreturned;
- finfo("buffer=%p buflen=%lu\n", buffer, (unsigned long)buflen);
- /* Is there line data already buffered? */
- nreturned = 0;
- if (priv->linesize > 0)
- {
- /* Yes, how much can we transfer now? */
- xfrsize = priv->linesize;
- if (xfrsize > buflen)
- {
- xfrsize = buflen;
- }
- /* Transfer the data to the user buffer */
- memcpy(buffer, &priv->line[priv->offset], xfrsize);
- /* Update pointers, sizes, and offsets */
- buffer += xfrsize;
- buflen -= xfrsize;
- priv->linesize -= xfrsize;
- priv->offset += xfrsize;
- nreturned = xfrsize;
- }
- /* Loop until the user buffer is full or until all of the network
- * statistics have been transferred. At this point we know that
- * either:
- *
- * 1. The user buffer is full, and/or
- * 2. All of the current line data has been transferred.
- */
- while (buflen > 0 && priv->lineno < nelems)
- {
- int len;
- /* Read the next line into the working buffer */
- len = gentab[priv->lineno](priv);
- /* Update line-related information */
- priv->lineno++;
- priv->linesize = len;
- priv->offset = 0;
- /* Transfer data to the user buffer */
- xfrsize = priv->linesize;
- if (xfrsize > buflen)
- {
- xfrsize = buflen;
- }
- memcpy(buffer, &priv->line[priv->offset], xfrsize);
- /* Update pointers, sizes, and offsets */
- buffer += xfrsize;
- buflen -= xfrsize;
- priv->linesize -= xfrsize;
- priv->offset += xfrsize;
- nreturned += xfrsize;
- }
- return nreturned;
- }
- #endif /* !CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_PROCFS &&
- * !CONFIG_FS_PROCFS_EXCLUDE_NET */
|