incubator-nuttx/fs/mount/mount.h

91 lines
3.5 KiB
C

/****************************************************************************
* fs/mount/mount.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __FS_MOUNT_MOUNT_H
#define __FS_MOUNT_MOUNT_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#ifndef CONFIG_DISABLE_MOUNTPOINT
/****************************************************************************
* Public Types
****************************************************************************/
struct statfs; /* Forward reference */
/* Callback used by foreach_mountpoints to traverse all mountpoints in the
* pseudo-file system.
*/
typedef int (*foreach_mountpoint_t)(FAR const char *mountpoint,
FAR struct statfs *statbuf,
FAR void *arg);
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: foreach_mountpoint
*
* Description:
* Visit each mountpoint in the pseudo-file system. The traversal is
* terminated when the callback 'handler' returns a non-zero value, or when
* all of the mountpoints have been visited.
*
* This is just a front end "filter" to foreach_inode() that forwards only
* mountpoint inodes. It is intended to support the mount() command to
* when the mount command is used to enumerate mounts.
*
* NOTE 1: Use with caution... The pseudo-file system is locked throughout
* the traversal.
* NOTE 2: The search algorithm is recursive and could, in principle, use
* an indeterminant amount of stack space. This will not usually be a
* real work issue.
*
****************************************************************************/
int foreach_mountpoint(foreach_mountpoint_t handler, FAR void *arg);
/****************************************************************************
* Name: fs_gettype
*
* Description:
* Given the result of statfs(), return a string representing the type of
* the file system.
*
* Input Parameters:
* statbuf - The result of a previouis statbuf statfs on the file system.
*
* Returned Value:
* A reference to a string representing the type of the file system.
*
****************************************************************************/
FAR const char *fs_gettype(FAR struct statfs *statbuf);
#endif /* CONFIG_DISABLE_MOUNTPOINT */
#endif /* __FS_MOUNT_MOUNT_H */