include/sys/statvfs.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSAPISystemLibrary
0007  *
0008  * @brief This header file provides the statvfs() and fstatvfs() interfaces.
0009  *
0010  * The statvfs() is defined by the SUS:
0011  *
0012  * - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
0013  */
0014
0015 /*
0016  *  COPYRIGHT (c) 2009 Chris Johns <chrisj@rtems.org>
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0037  * POSSIBILITY OF SUCH DAMAGE.
0038  */
0039
0040 /*
0041  */
0042
0043 #ifndef _SYS_STATVFS_H_
0044 #define _SYS_STATVFS_H_
0045
0046 #include <stdint.h>
0047
0048 #ifdef __cplusplus
0049 extern "C" {
0050 #endif
0051
0052 typedef uint64_t fsblkcnt_t;
0053 typedef uint32_t fsfilcnt_t;
0054
0055 struct statvfs
0056 {
0057   unsigned long f_bsize;   /**< File system block size. */
0058   unsigned long f_frsize;  /**< Fundamental file system block size. */
0059   fsblkcnt_t    f_blocks;  /**< Total number of blocks on file system in units
0060                             * of f_frsize. */
0061   fsblkcnt_t    f_bfree;   /**< Total number of free blocks. */
0062   fsblkcnt_t    f_bavail;  /**< Number of free blocks available to
0063                             * non-privileged process. */
0064   fsfilcnt_t    f_files;   /**< Total number of file serial numbers. */
0065   fsfilcnt_t    f_ffree;   /**< Total number of free file serial numbers. */
0066   fsfilcnt_t    f_favail;  /**< Number of file serial numbers available to
0067                             * non-privileged process. */
0068   unsigned long f_fsid;    /**< File system ID. */
0069   unsigned long f_flag;    /**< Bit mask of f_flag values. */
0070   unsigned long f_namemax; /**< Maximum filename length. */
0071 };
0072
0073 extern int statvfs(const char *__restrict , struct statvfs *__restrict);
0074 extern int fstatvfs(int, struct statvfs *);
0075
0076 #ifdef __cplusplus
0077 }
0078 #endif
0079
0080 #endif