123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316 |
- /****************************************************************************
- * fs/procfs/fs_procfsversion.c
- *
- * Copyright (C) 2018-2019 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/stat.h>
- #include <sys/utsname.h>
- #include <stdint.h>
- #include <stdbool.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <string.h>
- #include <fcntl.h>
- #include <assert.h>
- #include <errno.h>
- #include <debug.h>
- #include <nuttx/kmalloc.h>
- #include <nuttx/version.h>
- #include <nuttx/fs/fs.h>
- #include <nuttx/fs/procfs.h>
- #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_PROCFS)
- #ifndef CONFIG_FS_PROCFS_EXCLUDE_PROCESS
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* Determines the size of an intermediate buffer that must be large enough
- * to handle the longest line generated by this logic.
- */
- #define VERSION_LINELEN 128
- /****************************************************************************
- * Private Types
- ****************************************************************************/
- /* This structure describes one open "file" */
- struct version_file_s
- {
- struct procfs_file_s base; /* Base open file structure */
- unsigned int linesize; /* Number of valid characters in line[] */
- char line[VERSION_LINELEN]; /* Pre-allocated buffer for formatted lines */
- };
- /****************************************************************************
- * Private Function Prototypes
- ****************************************************************************/
- /* File system methods */
- static int version_open(FAR struct file *filep, FAR const char *relpath,
- int oflags, mode_t mode);
- static int version_close(FAR struct file *filep);
- static ssize_t version_read(FAR struct file *filep, FAR char *buffer,
- size_t buflen);
- static int version_dup(FAR const struct file *oldp,
- FAR struct file *newp);
- static int version_stat(FAR const char *relpath, FAR struct stat *buf);
- /****************************************************************************
- * Public Data
- ****************************************************************************/
- /* See fs_mount.c -- this structure is explicitly externed there.
- * We use the old-fashioned kind of initializers so that this will compile
- * with any compiler.
- */
- const struct procfs_operations version_operations =
- {
- version_open, /* open */
- version_close, /* close */
- version_read, /* read */
- NULL, /* write */
- version_dup, /* dup */
- NULL, /* opendir */
- NULL, /* closedir */
- NULL, /* readdir */
- NULL, /* rewinddir */
- version_stat /* stat */
- };
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: version_open
- ****************************************************************************/
- static int version_open(FAR struct file *filep, FAR const char *relpath,
- int oflags, mode_t mode)
- {
- FAR struct version_file_s *attr;
- 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)
- {
- ferr("ERROR: Only O_RDONLY supported\n");
- return -EACCES;
- }
- /* "version" is the only acceptable value for the relpath */
- if (strcmp(relpath, "version") != 0)
- {
- ferr("ERROR: relpath is '%s'\n", relpath);
- return -ENOENT;
- }
- /* Allocate a container to hold the file attributes */
- attr = (FAR struct version_file_s *)
- kmm_zalloc(sizeof(struct version_file_s));
- if (attr == NULL)
- {
- ferr("ERROR: Failed to allocate file attributes\n");
- return -ENOMEM;
- }
- /* Save the attributes as the open-specific state in filep->f_priv */
- filep->f_priv = (FAR void *)attr;
- return OK;
- }
- /****************************************************************************
- * Name: version_close
- ****************************************************************************/
- static int version_close(FAR struct file *filep)
- {
- FAR struct version_file_s *attr;
- /* Recover our private data from the struct file instance */
- attr = (FAR struct version_file_s *)filep->f_priv;
- DEBUGASSERT(attr);
- /* Release the file attributes structure */
- kmm_free(attr);
- filep->f_priv = NULL;
- return OK;
- }
- /****************************************************************************
- * Name: version_read
- ****************************************************************************/
- static ssize_t version_read(FAR struct file *filep, FAR char *buffer,
- size_t buflen)
- {
- FAR struct version_file_s *attr;
- struct utsname name;
- size_t linesize;
- off_t offset;
- ssize_t ret;
- finfo("buffer=%p buflen=%d\n", buffer, (int)buflen);
- /* Recover our private data from the struct file instance */
- attr = (FAR struct version_file_s *)filep->f_priv;
- DEBUGASSERT(attr);
- if (filep->f_pos == 0)
- {
- uname(&name);
- linesize = snprintf(attr->line, VERSION_LINELEN, "%s version %s %s\n",
- name.sysname, name.release, name.version);
- /* Save the linesize in case we are re-entered with f_pos > 0 */
- attr->linesize = linesize;
- }
- offset = filep->f_pos;
- ret = procfs_memcpy(attr->line, attr->linesize, buffer, buflen, &offset);
- /* Update the file offset */
- if (ret > 0)
- {
- filep->f_pos += ret;
- }
- return ret;
- }
- /****************************************************************************
- * Name: version_dup
- *
- * Description:
- * Duplicate open file data in the new file structure.
- *
- ****************************************************************************/
- static int version_dup(FAR const struct file *oldp, FAR struct file *newp)
- {
- FAR struct version_file_s *oldattr;
- FAR struct version_file_s *newattr;
- finfo("Dup %p->%p\n", oldp, newp);
- /* Recover our private data from the old struct file instance */
- oldattr = (FAR struct version_file_s *)oldp->f_priv;
- DEBUGASSERT(oldattr);
- /* Allocate a new container to hold the task and attribute selection */
- newattr = (FAR struct version_file_s *)
- kmm_malloc(sizeof(struct version_file_s));
- if (!newattr)
- {
- ferr("ERROR: Failed to allocate file attributes\n");
- return -ENOMEM;
- }
- /* The copy the file attributes from the old attributes to the new */
- memcpy(newattr, oldattr, sizeof(struct version_file_s));
- /* Save the new attributes in the new file structure */
- newp->f_priv = (FAR void *)newattr;
- return OK;
- }
- /****************************************************************************
- * Name: version_stat
- *
- * Description: Return information about a file or directory
- *
- ****************************************************************************/
- static int version_stat(FAR const char *relpath, FAR struct stat *buf)
- {
- /* "version" is the only acceptable value for the relpath */
- if (strcmp(relpath, "version") != 0)
- {
- ferr("ERROR: relpath is '%s'\n", relpath);
- return -ENOENT;
- }
- /* "version" is the name for a read-only file */
- memset(buf, 0, sizeof(struct stat));
- buf->st_mode = S_IFREG | S_IROTH | S_IRGRP | S_IRUSR;
- return OK;
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- #endif /* CONFIG_FS_PROCFS_EXCLUDE_PROCESS */
- #endif /* !CONFIG_DISABLE_MOUNTPOINT && CONFIG_FS_PROCFS */
|