[thirdparty/util-linux.git] / libmount / src / mountP.h

/*
 * mountP.h - private library header file
 *
 * Copyright (C) 2008-2012 Karel Zak <kzak@redhat.com>
 *
 * This file may be redistributed under the terms of the
 * GNU Lesser General Public License.
 */

#ifndef _LIBMOUNT_PRIVATE_H
#define _LIBMOUNT_PRIVATE_H

#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/vfs.h>
#include <unistd.h>
#include <stdio.h>
#include <stdarg.h>

#include "c.h"
#include "list.h"
#include "debug.h"
#include "libmount.h"

/*
 * Debug
 */
#define MNT_DEBUG_HELP		(1 << 0)
#define MNT_DEBUG_INIT		(1 << 1)
#define MNT_DEBUG_CACHE		(1 << 2)
#define MNT_DEBUG_OPTIONS	(1 << 3)
#define MNT_DEBUG_LOCKS		(1 << 4)
#define MNT_DEBUG_TAB		(1 << 5)
#define MNT_DEBUG_FS		(1 << 6)
#define MNT_DEBUG_UPDATE	(1 << 7)
#define MNT_DEBUG_UTILS		(1 << 8)
#define MNT_DEBUG_CXT		(1 << 9)
#define MNT_DEBUG_DIFF		(1 << 10)
#define MNT_DEBUG_MONITOR	(1 << 11)
#define MNT_DEBUG_BTRFS		(1 << 12)

#define MNT_DEBUG_ALL		0xFFFF

UL_DEBUG_DECLARE_MASK(libmount);
#define DBG(m, x)	__UL_DBG(libmount, MNT_DEBUG_, m, x)
#define ON_DBG(m, x)	__UL_DBG_CALL(libmount, MNT_DEBUG_, m, x)
#define DBG_FLUSH	__UL_DBG_FLUSH(libmount, MNT_DEBUG_)

/* extension for files in the directory */
#define MNT_MNTTABDIR_EXT	".fstab"

/* library private paths */
#define MNT_RUNTIME_TOPDIR	"/run"
#define MNT_RUNTIME_TOPDIR_OLD	"/dev"

#define MNT_PATH_UTAB		MNT_RUNTIME_TOPDIR "/mount/utab"
#define MNT_PATH_UTAB_OLD	MNT_RUNTIME_TOPDIR_OLD "/.mount/utab"

#define MNT_UTAB_HEADER	"# libmount utab file\n"

#ifdef TEST_PROGRAM
struct libmnt_test {
	const char	*name;
	int		(*body)(struct libmnt_test *ts, int argc, char *argv[]);
	const char	*usage;
};

/* test.c */
extern int mnt_run_test(struct libmnt_test *tests, int argc, char *argv[]);
#endif

/* utils.c */
extern int mnt_valid_tagname(const char *tagname);
extern int append_string(char **a, const char *b);

extern const char *mnt_statfs_get_fstype(struct statfs *vfs);
extern int is_file_empty(const char *name);

extern int mnt_is_readonly(const char *path)
			__attribute__((nonnull));

extern int mnt_parse_offset(const char *str, size_t len, uintmax_t *res);

extern int mnt_chdir_to_parent(const char *target, char **filename);

extern char *mnt_get_username(const uid_t uid);
extern int mnt_get_uid(const char *username, uid_t *uid);
extern int mnt_get_gid(const char *groupname, gid_t *gid);
extern int mnt_in_group(gid_t gid);

extern int mnt_open_uniq_filename(const char *filename, char **name);

extern int mnt_has_regular_utab(const char **utab, int *writable);
extern const char *mnt_get_utab_path(void);

extern int mnt_get_filesystems(char ***filesystems, const char *pattern);
extern void mnt_free_filesystems(char **filesystems);

extern char *mnt_get_kernel_cmdline_option(const char *name);
extern int mnt_stat_mountpoint(const char *target, struct stat *st);

/* tab.c */
extern int is_mountinfo(struct libmnt_table *tb);
extern int mnt_table_set_parser_fltrcb(	struct libmnt_table *tb,
					int (*cb)(struct libmnt_fs *, void *),
					void *data);

extern int __mnt_table_parse_mtab(struct libmnt_table *tb,
					const char *filename,
					struct libmnt_table *u_tb);

extern struct libmnt_fs *mnt_table_get_fs_root(struct libmnt_table *tb,
					struct libmnt_fs *fs,
					unsigned long mountflags,
					char **fsroot);

/*
 * Generic iterator
 */
struct libmnt_iter {
        struct list_head        *p;		/* current position */
        struct list_head        *head;		/* start position */
	int			direction;	/* MNT_ITER_{FOR,BACK}WARD */
};

#define IS_ITER_FORWARD(_i)	((_i)->direction == MNT_ITER_FORWARD)
#define IS_ITER_BACKWARD(_i)	((_i)->direction == MNT_ITER_BACKWARD)

#define MNT_ITER_INIT(itr, list) \
	do { \
		(itr)->p = IS_ITER_FORWARD(itr) ? \
				(list)->next : (list)->prev; \
		(itr)->head = (list); \
	} while(0)

#define MNT_ITER_ITERATE(itr, res, restype, member) \
	do { \
		res = list_entry((itr)->p, restype, member); \
		(itr)->p = IS_ITER_FORWARD(itr) ? \
				(itr)->p->next : (itr)->p->prev; \
	} while(0)


/*
 * This struct represents one entry in a mtab/fstab/mountinfo file.
 * (note that fstab[1] means the first column from fstab, and so on...)
 */
struct libmnt_fs {
	struct list_head ents;

	int		refcount;	/* reference counter */
	int		id;		/* mountinfo[1]: ID */
	int		parent;		/* mountinfo[2]: parent */
	dev_t		devno;		/* mountinfo[3]: st_dev */

	char		*bindsrc;	/* utab, full path from fstab[1] for bind mounts */

	char		*source;	/* fstab[1], mountinfo[10], swaps[1]:
                                         * source dev, file, dir or TAG */
	char		*tagname;	/* fstab[1]: tag name - "LABEL", "UUID", ..*/
	char		*tagval;	/*           tag value */

	char		*root;		/* mountinfo[4]: root of the mount within the FS */
	char		*target;	/* mountinfo[5], fstab[2]: mountpoint */
	char		*fstype;	/* mountinfo[9], fstab[3]: filesystem type */

	char		*optstr;	/* fstab[4], merged options */
	char		*vfs_optstr;	/* mountinfo[6]: fs-independent (VFS) options */
	char		*opt_fields;	/* mountinfo[7]: optional fields */
	char		*fs_optstr;	/* mountinfo[11]: fs-dependent options */
	char		*user_optstr;	/* userspace mount options */
	char		*attrs;		/* mount attributes */

	int		freq;		/* fstab[5]: dump frequency in days */
	int		passno;		/* fstab[6]: pass number on parallel fsck */

	/* /proc/swaps */
	char		*swaptype;	/* swaps[2]: device type (partition, file, ...) */
	off_t		size;		/* swaps[3]: swaparea size */
	off_t		usedsize;	/* swaps[4]: used size */
	int		priority;	/* swaps[5]: swap priority */

	int		flags;		/* MNT_FS_* flags */
	pid_t		tid;		/* /proc/<tid>/mountinfo otherwise zero */

	char		*comment;	/* fstab comment */

	void		*userdata;	/* library independent data */
};

/*
 * fs flags
 */
#define MNT_FS_PSEUDO	(1 << 1) /* pseudo filesystem */
#define MNT_FS_NET	(1 << 2) /* network filesystem */
#define MNT_FS_SWAP	(1 << 3) /* swap device */
#define MNT_FS_KERNEL	(1 << 4) /* data from /proc/{mounts,self/mountinfo} */
#define MNT_FS_MERGED	(1 << 5) /* already merged data from /run/mount/utab */

#define mnt_fs_is_regular(_f)	(!(mnt_fs_is_pseudofs(_f) \
				   || mnt_fs_is_netfs(_f) \
				   || mnt_fs_is_swaparea(_f)))

/*
 * mtab/fstab/mountinfo file
 */
struct libmnt_table {
	int		fmt;		/* MNT_FMT_* file format */
	int		nents;		/* number of entries */
	int		refcount;	/* reference counter */
	int		comms;		/* enable/disable comment parsing */
	char		*comm_intro;	/* First comment in file */
	char		*comm_tail;	/* Last comment in file */

	struct libmnt_cache *cache;		/* canonicalized paths/tags cache */

        int		(*errcb)(struct libmnt_table *tb,
				 const char *filename, int line);

	int		(*fltrcb)(struct libmnt_fs *fs, void *data);
	void		*fltrcb_data;


	struct list_head	ents;	/* list of entries (libmnt_fs) */
	void		*userdata;
};

extern struct libmnt_table *__mnt_new_table_from_file(const char *filename, int fmt);

/*
 * Tab file format
 */
enum {
	MNT_FMT_GUESS,
	MNT_FMT_FSTAB,			/* /etc/{fs,m}tab */
	MNT_FMT_MTAB = MNT_FMT_FSTAB,	/* alias */
	MNT_FMT_MOUNTINFO,		/* /proc/#/mountinfo */
	MNT_FMT_UTAB,			/* /run/mount/utab */
	MNT_FMT_SWAPS			/* /proc/swaps */
};

/*
 * Additional mounts
 */
struct libmnt_addmount {
	unsigned long mountflags;

	struct list_head	mounts;
};

/*
 * Mount context -- high-level API
 */
struct libmnt_context
{
	int	action;		/* MNT_ACT_{MOUNT,UMOUNT} */
	int	restricted;	/* root or not? */

	char	*fstype_pattern;	/* for mnt_match_fstype() */
	char	*optstr_pattern;	/* for mnt_match_options() */

	struct libmnt_fs *fs;		/* filesystem description (type, mountpoint, device, ...) */

	struct libmnt_table *fstab;	/* fstab (or mtab for some remounts) entries */
	struct libmnt_table *mtab;	/* mtab entries */
	struct libmnt_table *utab;	/* rarely used by umount only */

	int	(*table_errcb)(struct libmnt_table *tb,	/* callback for libmnt_table structs */
			 const char *filename, int line);

	int	(*table_fltrcb)(struct libmnt_fs *fs, void *data);	/* callback for libmnt_table structs */
	void	*table_fltrcb_data;

	char	*(*pwd_get_cb)(struct libmnt_context *);		/* get encryption password */
	void	(*pwd_release_cb)(struct libmnt_context *, char *);	/* release password */

	int	optsmode;	/* fstab optstr mode MNT_OPTSMODE_{AUTO,FORCE,IGNORE} */
	int	loopdev_fd;	/* open loopdev */

	unsigned long	mountflags;	/* final mount(2) flags */
	const void	*mountdata;	/* final mount(2) data, string or binary data */

	unsigned long	user_mountflags;	/* MNT_MS_* (loop=, user=, ...) */

	struct list_head	addmounts;	/* additional mounts */

	struct libmnt_cache	*cache;	/* paths cache */
	struct libmnt_lock	*lock;	/* mtab lock */
	struct libmnt_update	*update;/* mtab/utab update */

	const char	*mtab_path; /* path to mtab */
	int		mtab_writable; /* is mtab writable */

	const char	*utab_path; /* path to utab */
	int		utab_writable; /* is utab writable */

	int	flags;		/* private context flags */

	char	*helper;	/* name of the used /sbin/[u]mount.<type> helper */
	int	helper_status;	/* helper wait(2) status */
	int	helper_exec_status; /* 1: not called yet, 0: success, <0: -errno */

	char	*orig_user;	/* original (non-fixed) user= option */

	pid_t	*children;	/* "mount -a --fork" PIDs */
	int	nchildren;	/* number of children */
	pid_t	pid;		/* 0=parent; PID=child */


	int	syscall_status;	/* 1: not called yet, 0: success, <0: -errno */
};

/* flags */
#define MNT_FL_NOMTAB		(1 << 1)
#define MNT_FL_FAKE		(1 << 2)
#define MNT_FL_SLOPPY		(1 << 3)
#define MNT_FL_VERBOSE		(1 << 4)
#define MNT_FL_NOHELPERS	(1 << 5)
#define MNT_FL_LOOPDEL		(1 << 6)
#define MNT_FL_LAZY		(1 << 7)
#define MNT_FL_FORCE		(1 << 8)
#define MNT_FL_NOCANONICALIZE	(1 << 9)
#define MNT_FL_RDONLY_UMOUNT	(1 << 11)	/* remount,ro after EBUSY umount(2) */
#define MNT_FL_FORK		(1 << 12)
#define MNT_FL_NOSWAPMATCH	(1 << 13)

#define MNT_FL_MOUNTDATA	(1 << 20)
#define MNT_FL_TAB_APPLIED	(1 << 21)	/* mtab/fstab merged to cxt->fs */
#define MNT_FL_MOUNTFLAGS_MERGED (1 << 22)	/* MS_* flags was read from optstr */
#define MNT_FL_SAVED_USER	(1 << 23)
#define MNT_FL_PREPARED		(1 << 24)
#define MNT_FL_HELPER		(1 << 25)	/* [u]mount.<type> */
#define MNT_FL_LOOPDEV_READY	(1 << 26)	/* /dev/loop<N> initialized by the library */
#define MNT_FL_MOUNTOPTS_FIXED  (1 << 27)
#define MNT_FL_TABPATHS_CHECKED	(1 << 28)

/* default flags */
#define MNT_FL_DEFAULT		0

/* lock.c */
extern int mnt_lock_use_simplelock(struct libmnt_lock *ml, int enable);

/* optmap.c */
extern const struct libmnt_optmap *mnt_optmap_get_entry(
			     struct libmnt_optmap const **maps,
                             int nmaps,
			     const char *name,
                             size_t namelen,
			     const struct libmnt_optmap **mapent);

/* optstr.c */
extern int mnt_optstr_remove_option_at(char **optstr, char *begin, char *end);
extern int mnt_optstr_fix_gid(char **optstr, char *value, size_t valsz, char **next);
extern int mnt_optstr_fix_uid(char **optstr, char *value, size_t valsz, char **next);
extern int mnt_optstr_fix_secontext(char **optstr, char *value, size_t valsz, char **next);
extern int mnt_optstr_fix_user(char **optstr);

/* fs.c */
extern struct libmnt_fs *mnt_copy_mtab_fs(const struct libmnt_fs *fs)
			__attribute__((nonnull));
extern int __mnt_fs_set_source_ptr(struct libmnt_fs *fs, char *source)
			__attribute__((nonnull(1)));
extern int __mnt_fs_set_fstype_ptr(struct libmnt_fs *fs, char *fstype)
			__attribute__((nonnull(1)));

/* context.c */
extern int mnt_context_mtab_writable(struct libmnt_context *cxt);
extern int mnt_context_utab_writable(struct libmnt_context *cxt);
extern const char *mnt_context_get_writable_tabpath(struct libmnt_context *cxt);

extern int mnt_context_get_mtab_for_target(struct libmnt_context *cxt,
				    struct libmnt_table **mtab, const char *tgt);

extern int mnt_context_prepare_srcpath(struct libmnt_context *cxt);
extern int mnt_context_prepare_target(struct libmnt_context *cxt);
extern int mnt_context_guess_srcpath_fstype(struct libmnt_context *cxt, char **type);
extern int mnt_context_guess_fstype(struct libmnt_context *cxt);
extern int mnt_context_prepare_helper(struct libmnt_context *cxt,
				      const char *name, const char *type);
extern int mnt_context_prepare_update(struct libmnt_context *cxt);
extern int mnt_context_merge_mflags(struct libmnt_context *cxt);
extern int mnt_context_update_tabs(struct libmnt_context *cxt);

extern int mnt_context_umount_setopt(struct libmnt_context *cxt, int c, char *arg);
extern int mnt_context_mount_setopt(struct libmnt_context *cxt, int c, char *arg);

extern int mnt_context_is_loopdev(struct libmnt_context *cxt)
			__attribute__((nonnull));

extern int mnt_context_propagation_only(struct libmnt_context *cxt)
			__attribute__((nonnull));

extern struct libmnt_addmount *mnt_new_addmount(void);
extern void mnt_free_addmount(struct libmnt_addmount *ad);

extern int mnt_context_setup_loopdev(struct libmnt_context *cxt);
extern int mnt_context_delete_loopdev(struct libmnt_context *cxt);
extern int mnt_context_clear_loopdev(struct libmnt_context *cxt);

extern int mnt_fork_context(struct libmnt_context *cxt);

extern int mnt_context_set_tabfilter(struct libmnt_context *cxt,
				     int (*fltr)(struct libmnt_fs *, void *),
				     void *data);

/* tab_update.c */
extern int mnt_update_set_filename(struct libmnt_update *upd,
				   const char *filename, int userspace_only);
extern int mnt_update_already_done(struct libmnt_update *upd,
				   struct libmnt_lock *lc);

#if __linux__
/* btrfs.c */
extern uint64_t btrfs_get_default_subvol_id(const char *path);
#endif

#endif /* _LIBMOUNT_PRIVATE_H */
Commit	Line	Data
f4ab4ae8 KZ	1	/*
	2	* mountP.h - private library header file
	3	*
90cd46cb	4	* Copyright (C) 2008-2012 Karel Zak <kzak@redhat.com>
f4ab4ae8 KZ	5	*
	6	* This file may be redistributed under the terms of the
	7	* GNU Lesser General Public License.
	8	*/
	9
	10	#ifndef _LIBMOUNT_PRIVATE_H
	11	#define _LIBMOUNT_PRIVATE_H
	12
abc3d154	13	#include <errno.h>
486d3972 KZ	14	#include <stdlib.h>
	15	#include <string.h>
	16	#include <sys/stat.h>
	17	#include <sys/types.h>
6a52473e	18	#include <sys/vfs.h>
486d3972	19	#include <unistd.h>
83a78332 KZ	20	#include <stdio.h>
83a78332 KZ	21	#include <stdarg.h>
cc492b3d	22
486d3972	23	#include "c.h"
efab4b61	24	#include "list.h"
cedd8e5f	25	#include "debug.h"
486d3972	26	#include "libmount.h"
69b7e41e	27
c12cec75 KZ	28	/*
	29	* Debug
	30	*/
35333416	31	#define MNT_DEBUG_HELP (1 << 0)
3f31a959 KZ	32	#define MNT_DEBUG_INIT (1 << 1)
	33	#define MNT_DEBUG_CACHE (1 << 2)
	34	#define MNT_DEBUG_OPTIONS (1 << 3)
	35	#define MNT_DEBUG_LOCKS (1 << 4)
	36	#define MNT_DEBUG_TAB (1 << 5)
4e92d2b0	37	#define MNT_DEBUG_FS (1 << 6)
35333416 KZ	38	#define MNT_DEBUG_UPDATE (1 << 7)
	39	#define MNT_DEBUG_UTILS (1 << 8)
	40	#define MNT_DEBUG_CXT (1 << 9)
	41	#define MNT_DEBUG_DIFF (1 << 10)
372112e9	42	#define MNT_DEBUG_MONITOR (1 << 11)
2cd28fc8	43	#define MNT_DEBUG_BTRFS (1 << 12)
372112e9	44
3f31a959	45	#define MNT_DEBUG_ALL 0xFFFF
c12cec75	46
d7365821	47	UL_DEBUG_DECLARE_MASK(libmount);
83a78332 KZ	48	#define DBG(m, x) __UL_DBG(libmount, MNT_DEBUG_, m, x)
	49	#define ON_DBG(m, x) __UL_DBG_CALL(libmount, MNT_DEBUG_, m, x)
	50	#define DBG_FLUSH __UL_DBG_FLUSH(libmount, MNT_DEBUG_)
3f31a959	51
9354fea3	52	/* extension for files in the directory */
9826a637 KZ	53	#define MNT_MNTTABDIR_EXT ".fstab"
9826a637 KZ	54
0532ba1d	55	/* library private paths */
a362ae60 KZ	56	#define MNT_RUNTIME_TOPDIR "/run"
	57	#define MNT_RUNTIME_TOPDIR_OLD "/dev"
	58
	59	#define MNT_PATH_UTAB MNT_RUNTIME_TOPDIR "/mount/utab"
	60	#define MNT_PATH_UTAB_OLD MNT_RUNTIME_TOPDIR_OLD "/.mount/utab"
0532ba1d	61
dd369652 KZ	62	#define MNT_UTAB_HEADER "# libmount utab file\n"
dd369652 KZ	63
c12cec75	64	#ifdef TEST_PROGRAM
68164f6c	65	struct libmnt_test {
c12cec75	66	const char *name;
68164f6c	67	int (body)(struct libmnt_test ts, int argc, char *argv[]);
c12cec75 KZ	68	const char *usage;
	69	};
	70
77417bc0	71	/* test.c */
ba2bdf41	72	extern int mnt_run_test(struct libmnt_test tests, int argc, char argv[]);
c12cec75 KZ	73	#endif
c12cec75 KZ	74
69b7e41e	75	/* utils.c */
2c6b25f0	76	extern int mnt_valid_tagname(const char *tagname);
40b27864	77	extern int append_string(char *a, const char b);
2c6b25f0	78
6a52473e	79	extern const char mnt_statfs_get_fstype(struct statfs vfs);
dad88cb3 KZ	80	extern int is_file_empty(const char *name);
dad88cb3 KZ	81
90cd46cb OO	82	extern int mnt_is_readonly(const char *path)
90cd46cb OO	83	__attribute__((nonnull));
90cd46cb	84
ba2bdf41 KZ	85	extern int mnt_parse_offset(const char str, size_t len, uintmax_t res);
	86
	87	extern int mnt_chdir_to_parent(const char target, char *filename);
b49103ed	88
69b7e41e	89	extern char *mnt_get_username(const uid_t uid);
ba2bdf41 KZ	90	extern int mnt_get_uid(const char username, uid_t uid);
ba2bdf41 KZ	91	extern int mnt_get_gid(const char groupname, gid_t gid);
188dc15a	92	extern int mnt_in_group(gid_t gid);
a1e8af75	93
ba2bdf41	94	extern int mnt_open_uniq_filename(const char filename, char *name);
90cd46cb	95
77417bc0 KZ	96	extern int mnt_has_regular_utab(const char *utab, int writable);
77417bc0 KZ	97	extern const char *mnt_get_utab_path(void);
0bb44be3	98
ba2bdf41	99	extern int mnt_get_filesystems(char **filesystems, const char pattern);
0f32f1e2 KZ	100	extern void mnt_free_filesystems(char **filesystems);
0f32f1e2 KZ	101
ba2bdf41	102	extern char mnt_get_kernel_cmdline_option(const char name);
6589a163	103	extern int mnt_stat_mountpoint(const char target, struct stat st);
f308ec19	104
c4c66355	105	/* tab.c */
60d29f82	106	extern int is_mountinfo(struct libmnt_table *tb);
4709c9e6 KZ	107	extern int mnt_table_set_parser_fltrcb( struct libmnt_table *tb,
4709c9e6 KZ	108	int (cb)(struct libmnt_fs , void *),
ba2bdf41	109	void *data);
4709c9e6	110
6a52473e KZ	111	extern int __mnt_table_parse_mtab(struct libmnt_table *tb,
	112	const char *filename,
	113	struct libmnt_table *u_tb);
	114
c8b9eceb KZ	115	extern struct libmnt_fs mnt_table_get_fs_root(struct libmnt_table tb,
	116	struct libmnt_fs *fs,
	117	unsigned long mountflags,
	118	char **fsroot);
6a52473e	119
efab4b61 KZ	120	/*
	121	* Generic iterator
	122	*/
68164f6c	123	struct libmnt_iter {
efab4b61 KZ	124	struct list_head p; / current position */
	125	struct list_head head; / start position */
	126	int direction; /* MNT_ITER_{FOR,BACK}WARD */
	127	};
	128
	129	#define IS_ITER_FORWARD(_i) ((_i)->direction == MNT_ITER_FORWARD)
	130	#define IS_ITER_BACKWARD(_i) ((_i)->direction == MNT_ITER_BACKWARD)
	131
	132	#define MNT_ITER_INIT(itr, list) \
	133	do { \
	134	(itr)->p = IS_ITER_FORWARD(itr) ? \
	135	(list)->next : (list)->prev; \
	136	(itr)->head = (list); \
	137	} while(0)
	138
	139	#define MNT_ITER_ITERATE(itr, res, restype, member) \
	140	do { \
	141	res = list_entry((itr)->p, restype, member); \
	142	(itr)->p = IS_ITER_FORWARD(itr) ? \
	143	(itr)->p->next : (itr)->p->prev; \
	144	} while(0)
	145
078edb2d	146
d115ee9b	147	/*
d58b3157	148	* This struct represents one entry in a mtab/fstab/mountinfo file.
dd369652	149	* (note that fstab[1] means the first column from fstab, and so on...)
d115ee9b	150	*/
68164f6c	151	struct libmnt_fs {
d115ee9b KZ	152	struct list_head ents;
d115ee9b KZ	153
26d0c0ae	154	int refcount; /* reference counter */
d115ee9b	155	int id; /* mountinfo[1]: ID */
6ad929bb PU	156	int parent; /* mountinfo[2]: parent */
6ad929bb PU	157	dev_t devno; /* mountinfo[3]: st_dev */
d115ee9b	158
dd369652 KZ	159	char bindsrc; / utab, full path from fstab[1] for bind mounts */
dd369652 KZ	160
ce4dd666	161	char source; / fstab[1], mountinfo[10], swaps[1]:
d115ee9b KZ	162	* source dev, file, dir or TAG */
	163	char tagname; / fstab[1]: tag name - "LABEL", "UUID", ..*/
	164	char tagval; / tag value */
	165
0b3953a3	166	char root; / mountinfo[4]: root of the mount within the FS */
d115ee9b KZ	167	char target; / mountinfo[5], fstab[2]: mountpoint */
	168	char fstype; / mountinfo[9], fstab[3]: filesystem type */
	169
f2b3a3a3	170	char optstr; / fstab[4], merged options */
d115ee9b	171	char vfs_optstr; / mountinfo[6]: fs-independent (VFS) options */
e47a1931	172	char opt_fields; / mountinfo[7]: optional fields */
6ad929bb	173	char fs_optstr; / mountinfo[11]: fs-dependent options */
76a06ca4 KZ	174	char user_optstr; / userspace mount options */
76a06ca4 KZ	175	char attrs; / mount attributes */
d115ee9b	176
6ad929bb	177	int freq; /* fstab[5]: dump frequency in days */
d115ee9b KZ	178	int passno; /* fstab[6]: pass number on parallel fsck */
d115ee9b KZ	179
ce4dd666 KZ	180	/* /proc/swaps */
	181	char swaptype; / swaps[2]: device type (partition, file, ...) */
	182	off_t size; /* swaps[3]: swaparea size */
	183	off_t usedsize; /* swaps[4]: used size */
	184	int priority; /* swaps[5]: swap priority */
	185
3fca8422	186	int flags; /* MNT_FS_* flags */
f7f29b56	187	pid_t tid; /* /proc/<tid>/mountinfo otherwise zero */
26b4f9e4	188
cb90e24e OO	189	char comment; / fstab comment */
cb90e24e OO	190
26b4f9e4	191	void userdata; / library independent data */
d115ee9b KZ	192	};
	193
	194	/*
	195	* fs flags
	196	*/
911238af KZ	197	#define MNT_FS_PSEUDO (1 << 1) /* pseudo filesystem */
911238af KZ	198	#define MNT_FS_NET (1 << 2) /* network filesystem */
9dd75aa6	199	#define MNT_FS_SWAP (1 << 3) /* swap device */
309139c7	200	#define MNT_FS_KERNEL (1 << 4) /* data from /proc/{mounts,self/mountinfo} */
a362ae60	201	#define MNT_FS_MERGED (1 << 5) /* already merged data from /run/mount/utab */
309139c7	202
c70d9d76 KZ	203	#define mnt_fs_is_regular(_f) (!(mnt_fs_is_pseudofs(_f) \
	204	\|\| mnt_fs_is_netfs(_f) \
	205	\|\| mnt_fs_is_swaparea(_f)))
d115ee9b	206
6bd8b7a7 KZ	207	/*
	208	* mtab/fstab/mountinfo file
	209	*/
68164f6c	210	struct libmnt_table {
6bd8b7a7	211	int fmt; /* MNT_FMT_* file format */
26d0c0ae	212	int nents; /* number of entries */
c9f1585e	213	int refcount; /* reference counter */
cb90e24e OO	214	int comms; /* enable/disable comment parsing */
	215	char comm_intro; / First comment in file */
	216	char comm_tail; / Last comment in file */
6bd8b7a7	217
68164f6c	218	struct libmnt_cache cache; / canonicalized paths/tags cache */
6bd8b7a7	219
68164f6c KZ	220	int (errcb)(struct libmnt_table tb,
68164f6c KZ	221	const char *filename, int line);
9fd75d76	222
4709c9e6 KZ	223	int (fltrcb)(struct libmnt_fs fs, void *data);
	224	void *fltrcb_data;
	225
	226
68164f6c	227	struct list_head ents; /* list of entries (libmnt_fs) */
d58b3157	228	void *userdata;
6bd8b7a7 KZ	229	};
6bd8b7a7 KZ	230
ba2bdf41	231	extern struct libmnt_table __mnt_new_table_from_file(const char filename, int fmt);
dd369652 KZ	232
	233	/*
	234	* Tab file format
	235	*/
	236	enum {
	237	MNT_FMT_GUESS,
	238	MNT_FMT_FSTAB, /* /etc/{fs,m}tab */
	239	MNT_FMT_MTAB = MNT_FMT_FSTAB, /* alias */
	240	MNT_FMT_MOUNTINFO, /* /proc/#/mountinfo */
ce4dd666 KZ	241	MNT_FMT_UTAB, /* /run/mount/utab */
ce4dd666 KZ	242	MNT_FMT_SWAPS /* /proc/swaps */
dd369652 KZ	243	};
dd369652 KZ	244
6498ece0 KZ	245	/*
	246	* Additional mounts
	247	*/
	248	struct libmnt_addmount {
	249	unsigned long mountflags;
	250
	251	struct list_head mounts;
	252	};
6bd8b7a7	253
1bb1d80b KZ	254	/*
	255	* Mount context -- high-level API
	256	*/
68164f6c	257	struct libmnt_context
1bb1d80b KZ	258	{
1bb1d80b KZ	259	int action; /* MNT_ACT_{MOUNT,UMOUNT} */
1bb1d80b KZ	260	int restricted; /* root or not? */
	261
	262	char fstype_pattern; / for mnt_match_fstype() */
	263	char optstr_pattern; / for mnt_match_options() */
	264
6ad929bb	265	struct libmnt_fs fs; / filesystem description (type, mountpoint, device, ...) */
68164f6c	266
6ad929bb	267	struct libmnt_table fstab; / fstab (or mtab for some remounts) entries */
68164f6c	268	struct libmnt_table mtab; / mtab entries */
6a52473e	269	struct libmnt_table utab; / rarely used by umount only */
1bb1d80b	270
d84508cf KZ	271	int (table_errcb)(struct libmnt_table tb, /* callback for libmnt_table structs */
	272	const char *filename, int line);
	273
4709c9e6 KZ	274	int (table_fltrcb)(struct libmnt_fs fs, void data); / callback for libmnt_table structs */
	275	void *table_fltrcb_data;
	276
1a7a421e KZ	277	char (pwd_get_cb)(struct libmnt_context ); / get encryption password */
	278	void (pwd_release_cb)(struct libmnt_context , char ); / release password */
	279
1bb1d80b	280	int optsmode; /* fstab optstr mode MNT_OPTSMODE_{AUTO,FORCE,IGNORE} */
7f8b2bf3	281	int loopdev_fd; /* open loopdev */
1bb1d80b KZ	282
	283	unsigned long mountflags; /* final mount(2) flags */
	284	const void mountdata; / final mount(2) data, string or binary data */
	285
	286	unsigned long user_mountflags; /* MNT_MS_* (loop=, user=, ...) */
	287
6498ece0 KZ	288	struct list_head addmounts; /* additional mounts */
6498ece0 KZ	289
68164f6c KZ	290	struct libmnt_cache cache; / paths cache */
	291	struct libmnt_lock lock; / mtab lock */
	292	struct libmnt_update update;/ mtab/utab update */
1d0cd73f	293
6ad929bb PU	294	const char mtab_path; / path to mtab */
6ad929bb PU	295	int mtab_writable; /* is mtab writable */
1d0cd73f	296
6ad929bb PU	297	const char utab_path; / path to utab */
6ad929bb PU	298	int utab_writable; /* is utab writable */
1bb1d80b KZ	299
1bb1d80b KZ	300	int flags; /* private context flags */
1bb1d80b KZ	301
	302	char helper; / name of the used /sbin/[u]mount.<type> helper */
	303	int helper_status; /* helper wait(2) status */
97e23b5e	304	int helper_exec_status; /* 1: not called yet, 0: success, <0: -errno */
1bb1d80b KZ	305
	306	char orig_user; / original (non-fixed) user= option */
	307
d2c97887 KZ	308	pid_t children; / "mount -a --fork" PIDs */
	309	int nchildren; /* number of children */
	310	pid_t pid; /* 0=parent; PID=child */
	311
	312
97e23b5e	313	int syscall_status; /* 1: not called yet, 0: success, <0: -errno */
1bb1d80b KZ	314	};
	315
	316	/* flags */
	317	#define MNT_FL_NOMTAB (1 << 1)
	318	#define MNT_FL_FAKE (1 << 2)
	319	#define MNT_FL_SLOPPY (1 << 3)
	320	#define MNT_FL_VERBOSE (1 << 4)
	321	#define MNT_FL_NOHELPERS (1 << 5)
	322	#define MNT_FL_LOOPDEL (1 << 6)
	323	#define MNT_FL_LAZY (1 << 7)
	324	#define MNT_FL_FORCE (1 << 8)
	325	#define MNT_FL_NOCANONICALIZE (1 << 9)
ea8f06f9	326	#define MNT_FL_RDONLY_UMOUNT (1 << 11) /* remount,ro after EBUSY umount(2) */
d2c97887	327	#define MNT_FL_FORK (1 << 12)
e39cbb76	328	#define MNT_FL_NOSWAPMATCH (1 << 13)
1bb1d80b	329
1bb1d80b	330	#define MNT_FL_MOUNTDATA (1 << 20)
cf94e97f	331	#define MNT_FL_TAB_APPLIED (1 << 21) /* mtab/fstab merged to cxt->fs */
1bb1d80b KZ	332	#define MNT_FL_MOUNTFLAGS_MERGED (1 << 22) /* MS_* flags was read from optstr */
1bb1d80b KZ	333	#define MNT_FL_SAVED_USER (1 << 23)
dbde1923	334	#define MNT_FL_PREPARED (1 << 24)
8c0797e7	335	#define MNT_FL_HELPER (1 << 25) /* [u]mount.<type> */
d58b3157	336	#define MNT_FL_LOOPDEV_READY (1 << 26) /* /dev/loop<N> initialized by the library */
dc4dbbf1	337	#define MNT_FL_MOUNTOPTS_FIXED (1 << 27)
150e696d	338	#define MNT_FL_TABPATHS_CHECKED (1 << 28)
1bb1d80b KZ	339
	340	/* default flags */
	341	#define MNT_FL_DEFAULT 0
	342
5eb00eb4	343	/* lock.c */
ba2bdf41	344	extern int mnt_lock_use_simplelock(struct libmnt_lock *ml, int enable);
5eb00eb4	345
078edb2d	346	/* optmap.c */
68164f6c KZ	347	extern const struct libmnt_optmap *mnt_optmap_get_entry(
68164f6c KZ	348	struct libmnt_optmap const **maps,
90cd46cb OO	349	int nmaps,
90cd46cb OO	350	const char *name,
68164f6c	351	size_t namelen,
ba2bdf41	352	const struct libmnt_optmap **mapent);
078edb2d	353
188dc15a	354	/* optstr.c */
ba2bdf41 KZ	355	extern int mnt_optstr_remove_option_at(char *optstr, char begin, char *end);
	356	extern int mnt_optstr_fix_gid(char *optstr, char value, size_t valsz, char **next);
	357	extern int mnt_optstr_fix_uid(char *optstr, char value, size_t valsz, char **next);
	358	extern int mnt_optstr_fix_secontext(char *optstr, char value, size_t valsz, char **next);
	359	extern int mnt_optstr_fix_user(char **optstr);
188dc15a	360
d115ee9b	361	/* fs.c */
90cd46cb OO	362	extern struct libmnt_fs mnt_copy_mtab_fs(const struct libmnt_fs fs)
	363	__attribute__((nonnull));
	364	extern int __mnt_fs_set_source_ptr(struct libmnt_fs fs, char source)
	365	__attribute__((nonnull(1)));
	366	extern int __mnt_fs_set_fstype_ptr(struct libmnt_fs fs, char fstype)
	367	__attribute__((nonnull(1)));
078edb2d	368
1bb1d80b	369	/* context.c */
150e696d KZ	370	extern int mnt_context_mtab_writable(struct libmnt_context *cxt);
	371	extern int mnt_context_utab_writable(struct libmnt_context *cxt);
	372	extern const char mnt_context_get_writable_tabpath(struct libmnt_context cxt);
	373
7deae03f KZ	374	extern int mnt_context_get_mtab_for_target(struct libmnt_context *cxt,
	375	struct libmnt_table *mtab, const char tgt);
	376
ba2bdf41 KZ	377	extern int mnt_context_prepare_srcpath(struct libmnt_context *cxt);
ba2bdf41 KZ	378	extern int mnt_context_prepare_target(struct libmnt_context *cxt);
b1f03df7	379	extern int mnt_context_guess_srcpath_fstype(struct libmnt_context cxt, char *type);
ba2bdf41	380	extern int mnt_context_guess_fstype(struct libmnt_context *cxt);
68164f6c	381	extern int mnt_context_prepare_helper(struct libmnt_context *cxt,
ba2bdf41 KZ	382	const char name, const char type);
	383	extern int mnt_context_prepare_update(struct libmnt_context *cxt);
	384	extern int mnt_context_merge_mflags(struct libmnt_context *cxt);
	385	extern int mnt_context_update_tabs(struct libmnt_context *cxt);
90cd46cb	386
ba2bdf41 KZ	387	extern int mnt_context_umount_setopt(struct libmnt_context cxt, int c, char arg);
ba2bdf41 KZ	388	extern int mnt_context_mount_setopt(struct libmnt_context cxt, int c, char arg);
90cd46cb OO	389
	390	extern int mnt_context_is_loopdev(struct libmnt_context *cxt)
	391	__attribute__((nonnull));
ba2bdf41	392
6498ece0 KZ	393	extern int mnt_context_propagation_only(struct libmnt_context *cxt)
	394	__attribute__((nonnull));
	395
	396	extern struct libmnt_addmount *mnt_new_addmount(void);
	397	extern void mnt_free_addmount(struct libmnt_addmount *ad);
	398
ba2bdf41 KZ	399	extern int mnt_context_setup_loopdev(struct libmnt_context *cxt);
	400	extern int mnt_context_delete_loopdev(struct libmnt_context *cxt);
	401	extern int mnt_context_clear_loopdev(struct libmnt_context *cxt);
7f8b2bf3	402
d2c97887 KZ	403	extern int mnt_fork_context(struct libmnt_context *cxt);
d2c97887 KZ	404
4709c9e6	405	extern int mnt_context_set_tabfilter(struct libmnt_context *cxt,
90cd46cb	406	int (fltr)(struct libmnt_fs , void *),
ba2bdf41	407	void *data);
4709c9e6	408
97e23b5e	409	/* tab_update.c */
68164f6c	410	extern int mnt_update_set_filename(struct libmnt_update *upd,
ba2bdf41	411	const char *filename, int userspace_only);
7e0c0619 KZ	412	extern int mnt_update_already_done(struct libmnt_update *upd,
7e0c0619 KZ	413	struct libmnt_lock *lc);
97e23b5e	414
2cd28fc8 SB	415	#if __linux__
	416	/* btrfs.c */
	417	extern uint64_t btrfs_get_default_subvol_id(const char *path);
	418	#endif
	419
078edb2d	420	#endif /* _LIBMOUNT_PRIVATE_H */