blob: a936b834c961ca3c1173315ddd3d00ed6dfa1006 [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/* Utilities for reading/writing fstab, mtab, etc.
2 Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
19
20#ifndef _MNTENT_H
21#define _MNTENT_H 1
22
23#include <features.h>
24#define __need_FILE
25#include <stdio.h>
26#include <paths.h>
27
28
29/* File listing canonical interesting mount points. */
30#define MNTTAB _PATH_MNTTAB /* Deprecated alias. */
31
32/* File listing currently active mount points. */
33#define MOUNTED _PATH_MOUNTED /* Deprecated alias. */
34
35
36/* General filesystem types. */
37#define MNTTYPE_IGNORE "ignore" /* Ignore this entry. */
38#define MNTTYPE_NFS "nfs" /* Network file system. */
39#define MNTTYPE_SWAP "swap" /* Swap device. */
40
41
42/* Generic mount options. */
43#define MNTOPT_DEFAULTS "defaults" /* Use all default options. */
44#define MNTOPT_RO "ro" /* Read only. */
45#define MNTOPT_RW "rw" /* Read/write. */
46#define MNTOPT_SUID "suid" /* Set uid allowed. */
47#define MNTOPT_NOSUID "nosuid" /* No set uid allowed. */
48#define MNTOPT_NOAUTO "noauto" /* Do not auto mount. */
49
50
51__BEGIN_DECLS
52
53/* Structure describing a mount table entry. */
54struct mntent
55 {
56 char *mnt_fsname; /* Device or server for filesystem. */
57 char *mnt_dir; /* Directory mounted on. */
58 char *mnt_type; /* Type of filesystem: ufs, nfs, etc. */
59 char *mnt_opts; /* Comma-separated options for fs. */
60 int mnt_freq; /* Dump frequency (in days). */
61 int mnt_passno; /* Pass number for `fsck'. */
62 };
63
64
65/* Prepare to begin reading and/or writing mount table entries from the
66 beginning of FILE. MODE is as for `fopen'. */
67extern FILE *setmntent (__const char *__file, __const char *__mode) __THROW;
68libc_hidden_proto(setmntent)
69
70/* Read one mount table entry from STREAM. Returns a pointer to storage
71 reused on the next call, or null for EOF or error (use feof/ferror to
72 check). */
73extern struct mntent *getmntent (FILE *__stream) __THROW;
74
75#ifdef __USE_MISC
76/* Reentrant version of the above function. */
77extern struct mntent *getmntent_r (FILE *__restrict __stream,
78 struct mntent *__restrict __result,
79 char *__restrict __buffer,
80 int __bufsize) __THROW;
81libc_hidden_proto(getmntent_r)
82#endif
83
84/* Write the mount table entry described by MNT to STREAM.
85 Return zero on success, nonzero on failure. */
86extern int addmntent (FILE *__restrict __stream,
87 __const struct mntent *__restrict __mnt) __THROW;
88
89/* Close a stream opened with `setmntent'. */
90extern int endmntent (FILE *__stream) __THROW;
91libc_hidden_proto(endmntent)
92
93/* Search MNT->mnt_opts for an option matching OPT.
94 Returns the address of the substring, or null if none found. */
95extern char *hasmntopt (__const struct mntent *__mnt,
96 __const char *__opt) __THROW;
97
98
99__END_DECLS
100
101#endif /* mntent.h */