include/fstab.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1980, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _FSTAB_H_
  33 #define _FSTAB_H_
  34
  35 /*
  36  * File system table, see fstab(5).
  37  *
  38  * Used by dump, mount, umount, swapon, fsck, df, ...
  39  *
  40  * For ufs fs_spec field is the block special name.  Programs that want to
  41  * use the character special name must create that name by prepending a 'r'
  42  * after the right most slash.  Quota files are always named "quotas", so
  43  * if type is "rq", then use concatenation of fs_file and "quotas" to locate
  44  * quota file.
  45  */
  46 #define _PATH_FSTAB     "/etc/fstab"
  47 #define FSTAB           "/etc/fstab"    /* deprecated */
  48
  49 #define FSTAB_RW        "rw"            /* read/write device */
  50 #define FSTAB_RQ        "rq"            /* read/write with quotas */
  51 #define FSTAB_RO        "ro"            /* read-only device */
  52 #define FSTAB_SW        "sw"            /* swap device */
  53 #define FSTAB_XX        "xx"            /* ignore totally */
  54
  55 struct fstab {
  56         char    *fs_spec;               /* block special device name */
  57         char    *fs_file;               /* file system path prefix */
  58         char    *fs_vfstype;            /* File system type, ufs, nfs */
  59         char    *fs_mntops;             /* Mount options ala -o */
  60         char    *fs_type;               /* FSTAB_* from fs_mntops */
  61         int     fs_freq;                /* dump frequency, in days */
  62         int     fs_passno;              /* pass number on parallel fsck */
  63 };
  64
  65 #include <sys/cdefs.h>
  66
  67 __BEGIN_DECLS
  68 struct fstab *getfsent(void);
  69 struct fstab *getfsspec(const char *);
  70 struct fstab *getfsfile(const char *);
  71 int setfsent(void);
  72 void endfsent(void);
  73 void setfstab(const char *);
  74 const char *getfstab(void);
  75 __END_DECLS
  76
  77 #endif /* !_FSTAB_H_ */