2011-04-05 01:02:00 +02:00
|
|
|
/****************************************************************************
|
2014-09-28 19:46:11 +02:00
|
|
|
* fs/vfs/fs_fdopen.c
|
2011-04-05 01:02:00 +02:00
|
|
|
*
|
2017-02-09 16:24:44 +01:00
|
|
|
* Copyright (C) 2007-2014, 2017 Gregory Nutt. All rights reserved.
|
2012-03-04 00:18:34 +01:00
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
2011-04-05 01:02:00 +02:00
|
|
|
*
|
|
|
|
* 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 <stdio.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <fcntl.h>
|
|
|
|
#include <errno.h>
|
|
|
|
|
2011-04-05 22:54:00 +02:00
|
|
|
#include <nuttx/kmalloc.h>
|
2020-02-01 08:17:32 +01:00
|
|
|
#include <nuttx/semaphore.h>
|
2012-03-21 19:01:07 +01:00
|
|
|
#include <nuttx/fs/fs.h>
|
2012-03-04 00:18:34 +01:00
|
|
|
#include <nuttx/net/net.h>
|
2011-04-05 01:02:00 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: fs_checkfd
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Check if the file descriptor is valid for the provided TCB and if it
|
|
|
|
* supports the requested access.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2013-02-04 19:46:28 +01:00
|
|
|
static inline int fs_checkfd(FAR struct tcb_s *tcb, int fd, int oflags)
|
2011-06-02 17:05:48 +02:00
|
|
|
{
|
2014-10-06 18:53:25 +02:00
|
|
|
FAR struct file *filep;
|
|
|
|
FAR struct inode *inode;
|
2017-10-11 16:39:19 +02:00
|
|
|
int ret;
|
2011-06-02 17:05:48 +02:00
|
|
|
|
2013-01-26 21:17:29 +01:00
|
|
|
DEBUGASSERT(tcb && tcb->group);
|
2011-06-02 17:05:48 +02:00
|
|
|
|
2014-10-06 18:53:25 +02:00
|
|
|
/* Get the file structure corresponding to the file descriptor. */
|
2013-01-26 21:17:29 +01:00
|
|
|
|
2017-10-11 16:39:19 +02:00
|
|
|
ret = fs_getfilep(fd, &filep);
|
|
|
|
if (ret < 0)
|
2014-10-06 18:53:25 +02:00
|
|
|
{
|
2017-10-11 16:39:19 +02:00
|
|
|
return ret;
|
2014-10-06 18:53:25 +02:00
|
|
|
}
|
2011-06-02 17:05:48 +02:00
|
|
|
|
|
|
|
/* Get the inode associated with the file descriptor. This should
|
|
|
|
* normally be the case if fd >= 0. But not in the case where the
|
2014-10-06 18:53:25 +02:00
|
|
|
* called attempts to explicitly stdin with fdopen(0) but stdin has
|
2011-06-02 17:05:48 +02:00
|
|
|
* been closed.
|
|
|
|
*/
|
2014-04-14 00:22:22 +02:00
|
|
|
|
2014-10-06 18:53:25 +02:00
|
|
|
inode = filep->f_inode;
|
2011-06-02 17:05:48 +02:00
|
|
|
if (!inode)
|
|
|
|
{
|
|
|
|
/* No inode -- descriptor does not correspond to an open file */
|
|
|
|
|
|
|
|
return -ENOENT;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Make sure that the inode supports the requested access. In
|
|
|
|
* the case of fdopen, we are not actually creating the file -- in
|
|
|
|
* particular w and w+ do not truncate the file and any files have
|
|
|
|
* already been created.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (inode_checkflags(inode, oflags) != OK)
|
|
|
|
{
|
|
|
|
/* Cannot support the requested access */
|
|
|
|
|
|
|
|
return -EACCES;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Looks good to me */
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
2011-04-05 01:02:00 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: fs_fdopen
|
2011-06-02 17:05:48 +02:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This function does the core operations for fopen and fdopen.
|
|
|
|
*
|
2011-04-05 01:02:00 +02:00
|
|
|
****************************************************************************/
|
|
|
|
|
2013-02-04 19:46:28 +01:00
|
|
|
FAR struct file_struct *fs_fdopen(int fd, int oflags, FAR struct tcb_s *tcb)
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
|
|
|
FAR struct streamlist *slist;
|
|
|
|
FAR FILE *stream;
|
2016-06-11 22:40:07 +02:00
|
|
|
int errcode = OK;
|
2011-04-05 01:02:00 +02:00
|
|
|
int ret;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
/* Check input parameters */
|
|
|
|
|
|
|
|
if (fd < 0)
|
|
|
|
{
|
2016-06-11 22:40:07 +02:00
|
|
|
errcode = EBADF;
|
2011-04-05 01:02:00 +02:00
|
|
|
goto errout;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* A NULL TCB pointer means to use this threads TCB. This is a little
|
|
|
|
* hack the let's this function be called from user-space (via a syscall)
|
|
|
|
* without having access to the TCB.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (!tcb)
|
|
|
|
{
|
|
|
|
tcb = sched_self();
|
|
|
|
}
|
2013-03-12 22:53:18 +01:00
|
|
|
|
2013-01-26 23:25:21 +01:00
|
|
|
DEBUGASSERT(tcb && tcb->group);
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
/* Verify that this is a valid file/socket descriptor and that the
|
|
|
|
* requested access can be support.
|
|
|
|
*
|
|
|
|
* Is this fd in the range of valid file descriptors? Socket descriptors
|
|
|
|
* lie in a different range.
|
|
|
|
*/
|
2014-04-14 00:22:22 +02:00
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
if ((unsigned int)fd >= CONFIG_NFILE_DESCRIPTORS)
|
|
|
|
{
|
|
|
|
/* No.. If networking is enabled then this might be a socket
|
|
|
|
* descriptor.
|
|
|
|
*/
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2019-02-11 22:47:25 +01:00
|
|
|
#ifdef CONFIG_NET
|
2011-06-22 17:22:56 +02:00
|
|
|
ret = net_checksd(fd, oflags);
|
2011-06-02 17:05:48 +02:00
|
|
|
#else
|
|
|
|
/* No networking... it is just a bad descriptor */
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2016-06-11 22:40:07 +02:00
|
|
|
errcode = EBADF;
|
2011-06-04 22:13:03 +02:00
|
|
|
goto errout;
|
2011-06-02 17:05:48 +02:00
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2019-02-11 19:09:26 +01:00
|
|
|
/* The descriptor is in a valid range to file descriptor... perform some
|
|
|
|
* more checks.
|
|
|
|
*/
|
2011-06-02 17:05:48 +02:00
|
|
|
|
|
|
|
else
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
2011-06-02 17:05:48 +02:00
|
|
|
ret = fs_checkfd(tcb, fd, oflags);
|
2011-04-05 01:02:00 +02:00
|
|
|
}
|
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
/* Do we have a good descriptor of some sort? */
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
if (ret < 0)
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
2011-06-02 17:05:48 +02:00
|
|
|
/* No... return the reported error */
|
|
|
|
|
2016-06-11 22:40:07 +02:00
|
|
|
errcode = -ret;
|
2011-04-05 01:02:00 +02:00
|
|
|
goto errout;
|
|
|
|
}
|
|
|
|
|
2011-06-02 17:05:48 +02:00
|
|
|
/* Get the stream list from the TCB */
|
|
|
|
|
2014-08-29 22:47:22 +02:00
|
|
|
#if (defined(CONFIG_BUILD_PROTECTED) || defined(CONFIG_BUILD_KERNEL)) && \
|
|
|
|
defined(CONFIG_MM_KERNEL_HEAP)
|
2013-03-12 22:53:18 +01:00
|
|
|
slist = tcb->group->tg_streamlist;
|
|
|
|
#else
|
2013-01-26 23:25:21 +01:00
|
|
|
slist = &tcb->group->tg_streamlist;
|
2013-03-12 22:53:18 +01:00
|
|
|
#endif
|
2011-06-02 17:05:48 +02:00
|
|
|
|
2013-01-26 23:25:21 +01:00
|
|
|
/* Find an unallocated FILE structure in the stream list */
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2017-10-04 23:22:27 +02:00
|
|
|
ret = nxsem_wait(&slist->sl_sem);
|
|
|
|
if (ret < 0)
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
2017-10-04 23:22:27 +02:00
|
|
|
errcode = -ret;
|
|
|
|
goto errout;
|
2011-04-05 01:02:00 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
for (i = 0 ; i < CONFIG_NFILE_STREAMS; i++)
|
|
|
|
{
|
|
|
|
stream = &slist->sl_streams[i];
|
2013-09-29 00:50:07 +02:00
|
|
|
if (stream->fs_fd < 0)
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
|
|
|
/* Zero the structure */
|
2012-07-14 23:05:40 +02:00
|
|
|
|
2011-04-05 01:02:00 +02:00
|
|
|
memset(stream, 0, sizeof(FILE));
|
|
|
|
|
2017-02-09 16:24:44 +01:00
|
|
|
#ifndef CONFIG_STDIO_DISABLE_BUFFERING
|
2011-04-05 01:02:00 +02:00
|
|
|
/* Initialize the semaphore the manages access to the buffer */
|
|
|
|
|
2020-01-02 17:49:34 +01:00
|
|
|
nxsem_init(&stream->fs_sem, 0, 1);
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2017-02-09 16:24:44 +01:00
|
|
|
#if CONFIG_STDIO_BUFFER_SIZE > 0
|
2014-09-03 22:58:24 +02:00
|
|
|
/* Allocate the IO buffer at the appropriate privilege level for
|
|
|
|
* the group.
|
|
|
|
*/
|
|
|
|
|
|
|
|
stream->fs_bufstart =
|
|
|
|
group_malloc(tcb->group, CONFIG_STDIO_BUFFER_SIZE);
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2012-09-10 00:24:52 +02:00
|
|
|
if (!stream->fs_bufstart)
|
2011-04-05 01:02:00 +02:00
|
|
|
{
|
2016-06-11 22:40:07 +02:00
|
|
|
errcode = ENOMEM;
|
2011-04-05 01:02:00 +02:00
|
|
|
goto errout_with_sem;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set up pointers */
|
|
|
|
|
|
|
|
stream->fs_bufend = &stream->fs_bufstart[CONFIG_STDIO_BUFFER_SIZE];
|
|
|
|
stream->fs_bufpos = stream->fs_bufstart;
|
|
|
|
stream->fs_bufread = stream->fs_bufstart;
|
2017-02-08 18:28:24 +01:00
|
|
|
|
2017-02-09 16:24:44 +01:00
|
|
|
#ifdef CONFIG_STDIO_LINEBUFFER
|
2017-02-08 18:28:24 +01:00
|
|
|
/* Setup buffer flags */
|
|
|
|
|
|
|
|
stream->fs_flags |= __FS_FLAG_LBF; /* Line buffering */
|
2017-02-09 16:24:44 +01:00
|
|
|
|
|
|
|
#endif /* CONFIG_STDIO_LINEBUFFER */
|
|
|
|
#endif /* CONFIG_STDIO_BUFFER_SIZE > 0 */
|
|
|
|
#endif /* !CONFIG_STDIO_DISABLE_BUFFERING */
|
|
|
|
|
2011-04-05 01:02:00 +02:00
|
|
|
/* Save the file description and open flags. Setting the
|
|
|
|
* file descriptor locks this stream.
|
|
|
|
*/
|
|
|
|
|
2013-09-29 00:50:07 +02:00
|
|
|
stream->fs_fd = fd;
|
2012-04-18 17:57:45 +02:00
|
|
|
stream->fs_oflags = (uint16_t)oflags;
|
2011-04-05 01:02:00 +02:00
|
|
|
|
2017-10-03 23:35:24 +02:00
|
|
|
nxsem_post(&slist->sl_sem);
|
2011-04-05 01:02:00 +02:00
|
|
|
return stream;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-06-04 22:13:03 +02:00
|
|
|
/* No free stream available.. report ENFILE */
|
|
|
|
|
2016-06-11 22:40:07 +02:00
|
|
|
errcode = ENFILE;
|
2011-06-04 22:13:03 +02:00
|
|
|
|
2017-02-27 18:06:13 +01:00
|
|
|
#if !defined(CONFIG_STDIO_DISABLE_BUFFERING) && CONFIG_STDIO_BUFFER_SIZE > 0
|
2011-04-05 01:02:00 +02:00
|
|
|
errout_with_sem:
|
|
|
|
#endif
|
2017-10-03 23:35:24 +02:00
|
|
|
nxsem_post(&slist->sl_sem);
|
2011-04-05 01:02:00 +02:00
|
|
|
|
|
|
|
errout:
|
2016-06-11 22:40:07 +02:00
|
|
|
set_errno(errcode);
|
2011-04-05 01:02:00 +02:00
|
|
|
return NULL;
|
|
|
|
}
|