397 lines
11 KiB
C
397 lines
11 KiB
C
/****************************************************************************
|
|
* fs/inode/fs_files.c
|
|
*
|
|
* Copyright (C) 2007-2009, 2011-2013 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 <string.h>
|
|
#include <semaphore.h>
|
|
#include <assert.h>
|
|
#include <sched.h>
|
|
#include <errno.h>
|
|
|
|
#include <nuttx/fs/fs.h>
|
|
#include <nuttx/kmalloc.h>
|
|
|
|
#include "inode/inode.h"
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Private Types
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Private Variables
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Private Variables
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Private Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: _files_semtake
|
|
****************************************************************************/
|
|
|
|
static void _files_semtake(FAR struct filelist *list)
|
|
{
|
|
/* Take the semaphore (perhaps waiting) */
|
|
|
|
while (sem_wait(&list->fl_sem) != 0)
|
|
{
|
|
/* The only case that an error should occr here is if
|
|
* the wait was awakened by a signal.
|
|
*/
|
|
|
|
ASSERT(get_errno() == EINTR);
|
|
}
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: _files_semgive
|
|
****************************************************************************/
|
|
|
|
#define _files_semgive(list) sem_post(&list->fl_sem)
|
|
|
|
/****************************************************************************
|
|
* Name: _files_close
|
|
*
|
|
* Description:
|
|
* Close an inode (if open)
|
|
*
|
|
* Assumuptions:
|
|
* Caller holds the list semaphore because the file descriptor will be freed.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int _files_close(FAR struct file *filep)
|
|
{
|
|
struct inode *inode = filep->f_inode;
|
|
int ret = OK;
|
|
|
|
/* Check if the struct file is open (i.e., assigned an inode) */
|
|
|
|
if (inode)
|
|
{
|
|
/* Close the file, driver, or mountpoint. */
|
|
|
|
if (inode->u.i_ops && inode->u.i_ops->close)
|
|
{
|
|
/* Perform the close operation */
|
|
|
|
ret = inode->u.i_ops->close(filep);
|
|
}
|
|
|
|
/* And release the inode */
|
|
|
|
inode_release(inode);
|
|
|
|
/* Release the file descriptor */
|
|
|
|
filep->f_oflags = 0;
|
|
filep->f_pos = 0;
|
|
filep->f_inode = NULL;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: files_initialize
|
|
*
|
|
* Description:
|
|
* This is called from the FS initialization logic to configure the files.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void files_initialize(void)
|
|
{
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: files_initlist
|
|
*
|
|
* Description: Initializes the list of files for a new task
|
|
*
|
|
****************************************************************************/
|
|
|
|
void files_initlist(FAR struct filelist *list)
|
|
{
|
|
DEBUGASSERT(list);
|
|
|
|
/* Initialize the list access mutex */
|
|
|
|
(void)sem_init(&list->fl_sem, 0, 1);
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: files_releaselist
|
|
*
|
|
* Description:
|
|
* Release a reference to the file list
|
|
*
|
|
****************************************************************************/
|
|
|
|
void files_releaselist(FAR struct filelist *list)
|
|
{
|
|
int i;
|
|
|
|
DEBUGASSERT(list);
|
|
|
|
/* Close each file descriptor .. Normally, you would need take the list
|
|
* semaphore, but it is safe to ignore the semaphore in this context because
|
|
* there should not be any references in this context.
|
|
*/
|
|
|
|
for (i = 0; i < CONFIG_NFILE_DESCRIPTORS; i++)
|
|
{
|
|
(void)_files_close(&list->fl_files[i]);
|
|
}
|
|
|
|
/* Destroy the semaphore */
|
|
|
|
(void)sem_destroy(&list->fl_sem);
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: file_dup2
|
|
*
|
|
* Description:
|
|
* Assign an inode to a specific files structure. This is the heart of
|
|
* dup2.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int file_dup2(FAR struct file *filep1, FAR struct file *filep2)
|
|
{
|
|
FAR struct filelist *list;
|
|
FAR struct inode *inode;
|
|
int err;
|
|
int ret;
|
|
|
|
if (!filep1 || !filep1->f_inode || !filep2)
|
|
{
|
|
err = EBADF;
|
|
goto errout;
|
|
}
|
|
|
|
list = sched_getfiles();
|
|
DEBUGASSERT(list);
|
|
|
|
_files_semtake(list);
|
|
|
|
/* If there is already an inode contained in the new file structure,
|
|
* close the file and release the inode.
|
|
*/
|
|
|
|
ret = _files_close(filep2);
|
|
if (ret < 0)
|
|
{
|
|
/* An error occurred while closing the driver */
|
|
|
|
goto errout_with_ret;
|
|
}
|
|
|
|
/* Increment the reference count on the contained inode */
|
|
|
|
inode = filep1->f_inode;
|
|
inode_addref(inode);
|
|
|
|
/* Then clone the file structure */
|
|
|
|
filep2->f_oflags = filep1->f_oflags;
|
|
filep2->f_pos = filep1->f_pos;
|
|
filep2->f_inode = inode;
|
|
|
|
/* Call the open method on the file, driver, mountpoint so that it
|
|
* can maintain the correct open counts.
|
|
*/
|
|
|
|
if (inode->u.i_ops && inode->u.i_ops->open)
|
|
{
|
|
#ifndef CONFIG_DISABLE_MOUNTPOINT
|
|
if (INODE_IS_MOUNTPT(inode))
|
|
{
|
|
/* Dup the open file on the in the new file structure */
|
|
|
|
ret = inode->u.i_mops->dup(filep1, filep2);
|
|
}
|
|
else
|
|
#endif
|
|
{
|
|
/* (Re-)open the pseudo file or device driver */
|
|
|
|
ret = inode->u.i_ops->open(filep2);
|
|
}
|
|
|
|
/* Handle open failures */
|
|
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_inode;
|
|
}
|
|
}
|
|
|
|
_files_semgive(list);
|
|
return OK;
|
|
|
|
/* Handler various error conditions */
|
|
|
|
errout_with_inode:
|
|
inode_release(filep2->f_inode);
|
|
filep2->f_oflags = 0;
|
|
filep2->f_pos = 0;
|
|
filep2->f_inode = NULL;
|
|
|
|
errout_with_ret:
|
|
err = -ret;
|
|
_files_semgive(list);
|
|
|
|
errout:
|
|
set_errno(err);
|
|
return ERROR;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: files_allocate
|
|
*
|
|
* Description:
|
|
* Allocate a struct files instance and associate it with an inode instance.
|
|
* Returns the file descriptor == index into the files array.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int files_allocate(FAR struct inode *inode, int oflags, off_t pos, int minfd)
|
|
{
|
|
FAR struct filelist *list;
|
|
int i;
|
|
|
|
list = sched_getfiles();
|
|
DEBUGASSERT(list);
|
|
|
|
_files_semtake(list);
|
|
for (i = minfd; i < CONFIG_NFILE_DESCRIPTORS; i++)
|
|
{
|
|
if (!list->fl_files[i].f_inode)
|
|
{
|
|
list->fl_files[i].f_oflags = oflags;
|
|
list->fl_files[i].f_pos = pos;
|
|
list->fl_files[i].f_inode = inode;
|
|
list->fl_files[i].f_priv = NULL;
|
|
_files_semgive(list);
|
|
return i;
|
|
}
|
|
}
|
|
|
|
_files_semgive(list);
|
|
return ERROR;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: files_close
|
|
*
|
|
* Description:
|
|
* Close an inode (if open)
|
|
*
|
|
* Assumuptions:
|
|
* Caller holds the list semaphore because the file descriptor will be freed.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int files_close(int fd)
|
|
{
|
|
FAR struct filelist *list;
|
|
int ret;
|
|
|
|
/* Get the thread-specific file list */
|
|
|
|
list = sched_getfiles();
|
|
DEBUGASSERT(list);
|
|
|
|
/* If the file was properly opened, there should be an inode assigned */
|
|
|
|
if (fd < 0 || fd >= CONFIG_NFILE_DESCRIPTORS || !list->fl_files[fd].f_inode)
|
|
{
|
|
return -EBADF;
|
|
}
|
|
|
|
/* Perform the protected close operation */
|
|
|
|
_files_semtake(list);
|
|
ret = _files_close(&list->fl_files[fd]);
|
|
_files_semgive(list);
|
|
return ret;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: files_release
|
|
*
|
|
* Assumuptions:
|
|
* Similar to files_close(). Called only from open() logic on error
|
|
* conditions.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void files_release(int fd)
|
|
{
|
|
FAR struct filelist *list;
|
|
|
|
list = sched_getfiles();
|
|
DEBUGASSERT(list);
|
|
|
|
if (fd >=0 && fd < CONFIG_NFILE_DESCRIPTORS)
|
|
{
|
|
_files_semtake(list);
|
|
list->fl_files[fd].f_oflags = 0;
|
|
list->fl_files[fd].f_pos = 0;
|
|
list->fl_files[fd].f_inode = NULL;
|
|
_files_semgive(list);
|
|
}
|
|
}
|