/* SPDX-License-Identifier: LGPL-2.1-or-later */

/*

 * mountP.h - private library header file

 *

 * This file is part of libmount from util-linux project.

 *

 * Copyright (C) 2008-2018 Karel Zak <kzak@redhat.com>

 *

 * libmount is free software; you can redistribute it and/or modify it

 * under the terms of the GNU Lesser General Public License as published by

 * the Free Software Foundation; either version 2.1 of the License, or

 * (at your option) any later version.

 */

#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 <stdint.h>

#include <inttypes.h>

#include "c.h"

#include "list.h"

#include "debug.h"

#include "buffer.h"

#include "libmount.h"

#include "mount-api-utils.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_LOOP    (1 << 13)

#define MNT_DEBUG_VERITY  (1 << 14)

#define MNT_DEBUG_HOOK    (1 << 15)

#define MNT_DEBUG_OPTLIST (1 << 16)

#define MNT_DEBUG_STATMNT (1 << 17)

#define MNT_DEBUG_ALL   0xFFFFFF

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_)

#define UL_DEBUG_CURRENT_MASK UL_DEBUG_MASK(libmount)

#include "debugobj.h"

/*

 * NLS -- the library has to be independent on main program, so define

 * UL_TEXTDOMAIN_EXPLICIT before you include nls.h.

 *

 * Now we use util-linux.po (=PACKAGE), rather than maintain the texts

 * in the separate libmount.po file.

 */

#define LIBMOUNT_TEXTDOMAIN PACKAGE

#define UL_TEXTDOMAIN_EXPLICIT  LIBMOUNT_TEXTDOMAIN

#include "nls.h"

/* extension for files in the directory */

#define MNT_MNTTABDIR_EXT ".fstab"

/* library private paths */

#define MNT_RUNTIME_TOPDIR  "/run"

/* private userspace mount table */

#define MNT_PATH_UTAB   MNT_RUNTIME_TOPDIR "/mount/utab"

/* temporary mount target */

#define MNT_PATH_TMPTGT   MNT_RUNTIME_TOPDIR "/mount/tmptgt"

#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

/* private tab_listmount.c */

struct libmnt_listmnt;

/* utils.c */

extern int mnt_valid_tagname(const char *tagname);

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_parse_uid(const char *user, size_t user_len, uid_t *gid);

extern int mnt_parse_gid(const char *group, size_t group_len, gid_t *gid);

extern int mnt_parse_mode(const char *mode, size_t mode_len, mode_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_safe_stat(const char *target, struct stat *st);

extern int mnt_safe_lstat(const char *target, struct stat *st);

extern int mnt_is_path(const char *target);

extern int mnt_tmptgt_unshare(int *old_ns_fd);

extern int mnt_tmptgt_cleanup(int old_ns_fd);

extern int mnt_id_from_fd(int fd, uint64_t *uniq_id, int *id);

/* 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_mountinfo(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);

extern int __mnt_table_is_fs_mounted( struct libmnt_table *tb,

          struct libmnt_fs *fstab_fs,

          const char *tgt_prefix);

extern int mnt_table_enable_noautofs(struct libmnt_table *tb, int ignore);

extern int mnt_table_is_noautofs(struct libmnt_table *tb);

/* tab_listmount.c */

extern int mnt_table_next_lsmnt(struct libmnt_table *tb, int direction);

extern int mnt_table_reset_listmount(struct libmnt_table *tb);

extern int mnt_table_want_listmount(struct libmnt_table *tb);

/*

 * 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_GET_ENTRY(itr, restype, member) \

    list_entry((itr)->p, restype, member)

#define MNT_ITER_ITERATE(itr) \

  do { \

    (itr)->p = IS_ITER_FORWARD(itr) ? \

        (itr)->p->next : (itr)->p->prev; \

  } while(0)

/*

 * statmount setting; shared between tables and filesystems

 */

struct libmnt_statmnt {

  int             refcount;

  uint64_t        mask;           /* default statmount() mask */

  struct ul_statmount *buf;

  size_t bufsiz;

  unsigned int    disabled: 1;    /* enable or disable statmount() */

};

/*

 * This struct represents one entry in a fstab/mountinfo file.

 * (note that fstab[1] means the first column from fstab, and so on...)

 */

struct libmnt_fs {

  struct list_head ents;

  struct libmnt_table *tab;

  int   refcount; /* reference counter */

  unsigned int  opts_age; /* to sync with optlist */

  struct libmnt_optlist *optlist;

  int   id;   /* mountinfo[1]: ID */

  uint64_t  uniq_id;  /* unique node ID; statx(STATX_MNT_ID_UNIQUE); statmount->mnt_id */

  uint64_t        ns_id;    /* namespace ID; statmount->mnt_ns_id */

  int   parent;   /* mountinfo[2]: parent */

  uint64_t  uniq_parent;  /* unique parent ID; statmount->mnt_parent_id */

  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 */

  uint64_t  propagation;  /* statmmount() or parsed opt_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 */

  uint64_t  stmnt_done; /* mask of already called masks */

  struct libmnt_statmnt *stmnt; /* statmount() stuff */

  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_STATUS_ATTACH  (1 << 6)

#define MNT_FS_STATUS_DETACH  (1 << 7)

static inline void mnt_fs_mark_attached(struct libmnt_fs *fs)

{

  fs->flags &= ~MNT_FS_STATUS_DETACH;

  fs->flags |= MNT_FS_STATUS_ATTACH;

}

Unexecuted instantiation: fuzz.c:mnt_fs_mark_attached

Unexecuted instantiation: tab.c:mnt_fs_mark_attached

Unexecuted instantiation: tab_listmount.c:mnt_fs_mark_attached

tab_parse.c:mnt_fs_mark_attached

Line

Count

Source

293

18.3k

{

294

18.3k

  fs->flags &= ~MNT_FS_STATUS_DETACH;

295

18.3k

  fs->flags |= MNT_FS_STATUS_ATTACH;

296

18.3k

}

Unexecuted instantiation: utils.c:mnt_fs_mark_attached

Unexecuted instantiation: btrfs.c:mnt_fs_mark_attached

Unexecuted instantiation: cache.c:mnt_fs_mark_attached

Unexecuted instantiation: fs.c:mnt_fs_mark_attached

Unexecuted instantiation: fs_statmount.c:mnt_fs_mark_attached

Unexecuted instantiation: init.c:mnt_fs_mark_attached

Unexecuted instantiation: iter.c:mnt_fs_mark_attached

Unexecuted instantiation: optmap.c:mnt_fs_mark_attached

Unexecuted instantiation: optlist.c:mnt_fs_mark_attached

Unexecuted instantiation: optstr.c:mnt_fs_mark_attached

Unexecuted instantiation: version.c:mnt_fs_mark_attached

static inline void mnt_fs_mark_detached(struct libmnt_fs *fs)

{

  fs->flags &= ~MNT_FS_STATUS_ATTACH;

  fs->flags |= MNT_FS_STATUS_DETACH;

}

Unexecuted instantiation: fuzz.c:mnt_fs_mark_detached

Unexecuted instantiation: tab.c:mnt_fs_mark_detached

Unexecuted instantiation: tab_listmount.c:mnt_fs_mark_detached

Unexecuted instantiation: tab_parse.c:mnt_fs_mark_detached

Unexecuted instantiation: utils.c:mnt_fs_mark_detached

Unexecuted instantiation: btrfs.c:mnt_fs_mark_detached

Unexecuted instantiation: cache.c:mnt_fs_mark_detached

Unexecuted instantiation: fs.c:mnt_fs_mark_detached

Unexecuted instantiation: fs_statmount.c:mnt_fs_mark_detached

Unexecuted instantiation: init.c:mnt_fs_mark_detached

Unexecuted instantiation: iter.c:mnt_fs_mark_detached

Unexecuted instantiation: optmap.c:mnt_fs_mark_detached

Unexecuted instantiation: optlist.c:mnt_fs_mark_detached

Unexecuted instantiation: optstr.c:mnt_fs_mark_detached

Unexecuted instantiation: version.c:mnt_fs_mark_detached

static inline void mnt_fs_mark_moved(struct libmnt_fs *fs)

{

  fs->flags |= MNT_FS_STATUS_ATTACH | MNT_FS_STATUS_DETACH;

}

Unexecuted instantiation: fuzz.c:mnt_fs_mark_moved

Unexecuted instantiation: tab.c:mnt_fs_mark_moved

Unexecuted instantiation: tab_listmount.c:mnt_fs_mark_moved

Unexecuted instantiation: tab_parse.c:mnt_fs_mark_moved

Unexecuted instantiation: utils.c:mnt_fs_mark_moved

Unexecuted instantiation: btrfs.c:mnt_fs_mark_moved

Unexecuted instantiation: cache.c:mnt_fs_mark_moved

Unexecuted instantiation: fs.c:mnt_fs_mark_moved

Unexecuted instantiation: fs_statmount.c:mnt_fs_mark_moved

Unexecuted instantiation: init.c:mnt_fs_mark_moved

Unexecuted instantiation: iter.c:mnt_fs_mark_moved

Unexecuted instantiation: optmap.c:mnt_fs_mark_moved

Unexecuted instantiation: optlist.c:mnt_fs_mark_moved

Unexecuted instantiation: optstr.c:mnt_fs_mark_moved

Unexecuted instantiation: version.c:mnt_fs_mark_moved

#ifdef HAVE_STATMOUNT_API

# define  mnt_fs_try_statmount(FS, MEMBER, FLAGS) __extension__ ({  \

      if (!(FS)->MEMBER         \

          && (FS)->stmnt          \

          && !(FS)->stmnt->disabled       \

          && ((FLAGS) & ~((FS)->stmnt_done)))     \

        mnt_fs_fetch_statmount((FS), (FLAGS)); })

#endif

/*

 * 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 libmnt_listmnt *lsmnt; /* listmount() stuff */

  struct libmnt_statmnt *stmnt; /* statmount() stuff */

  int   noautofs; /* ignore autofs mounts */

  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, int empty_for_enoent);

/*

 * 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 */

};

/*

 * Context hooks

 *

 * TODO: this will be public one day when libmount will support modules for

 * stuff like veritydev.c.

 */

enum {

  MNT_STAGE_PREP_SOURCE = 1,  /* mount source preparation */

  MNT_STAGE_PREP_TARGET,    /* mount target preparation */

  MNT_STAGE_PREP_OPTIONS,   /* mount options preparation */

  MNT_STAGE_PREP,     /* all prepared */

  MNT_STAGE_MOUNT_PRE = 100,  /* before mount */

  MNT_STAGE_MOUNT,    /* mount(2) or fsmount(2) or tree-clone */

  MNT_STAGE_MOUNT_POST,   /* after mount */

  MNT_STAGE_POST = 200    /* all is done */

};

struct libmnt_hookset {

  const char *name;       /* hook set name */

  int firststage;

  int (*firstcall)(struct libmnt_context *, const struct libmnt_hookset *, void *);

  int (*deinit)(struct libmnt_context *, const struct libmnt_hookset *);  /* cleanup function */

};

/* built-in hooks */

extern const struct libmnt_hookset hookset_mount_legacy;

extern const struct libmnt_hookset hookset_mount;

extern const struct libmnt_hookset hookset_mkdir;

extern const struct libmnt_hookset hookset_subdir;

extern const struct libmnt_hookset hookset_owner;

extern const struct libmnt_hookset hookset_idmap;

extern const struct libmnt_hookset hookset_loopdev;

#ifdef HAVE_CRYPTSETUP

extern const struct libmnt_hookset hookset_veritydev;

#endif

#ifdef HAVE_LIBSELINUX

extern const struct libmnt_hookset hookset_selinux;

#endif

extern int mnt_context_deinit_hooksets(struct libmnt_context *cxt);

extern const struct libmnt_hookset *mnt_context_get_hookset(struct libmnt_context *cxt, const char *name);

extern int mnt_context_set_hookset_data(struct libmnt_context *cxt,

      const struct libmnt_hookset *hs,

      void *data);

extern void *mnt_context_get_hookset_data(struct libmnt_context *cxt,

      const struct libmnt_hookset *hs);

extern int mnt_context_has_hook(struct libmnt_context *cxt,

                         const struct libmnt_hookset *hs,

                         int stage,

                         void *data);

extern int mnt_context_append_hook(struct libmnt_context *cxt,

      const struct libmnt_hookset *hs,

      int stage,

      void *data,

      int (*func)(struct libmnt_context *,

        const struct libmnt_hookset *,

        void *));

extern int mnt_context_insert_hook(struct libmnt_context *cxt,

      const char *after,

      const struct libmnt_hookset *hs,

      int stage,

      void *data,

      int (*func)(struct libmnt_context *,

        const struct libmnt_hookset *,

        void *));

extern int mnt_context_remove_hook(struct libmnt_context *cxt,

      const struct libmnt_hookset *hs,

      int stage,

      void **data);

extern int mnt_context_call_hooks(struct libmnt_context *cxt, int stage);

/*

 * Namespace

 */

struct libmnt_ns {

  int fd;       /* file descriptor of namespace, -1 when inactive */

  struct libmnt_cache *cache; /* paths cache associated with NS */

};

/*

 * 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 entries */

  struct libmnt_table *mountinfo; /* already mounted filesystems */

  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} */

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

  struct libmnt_cache *cache;   /* paths cache */

  struct libmnt_lock  *lock;    /* utab lock */

  struct libmnt_update  *update;  /* utab update */

  struct libmnt_optlist *optlist; /* parsed mount options */

  struct libmnt_optlist *optlist_saved; /* save/apply context template */

  const struct libmnt_optmap *map_linux;    /* system options map */

  const struct libmnt_optmap *map_userspace;  /* userspace options map */

  const char  *mountinfo_path; /* usually /proc/self/moutinfo */

  const char  *utab_path; /* path to utab */

  int   utab_writable; /* is utab writable */

  char    *tgt_prefix;  /* path used for all targets */

  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 */

  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 */

  const char *syscall_name; /* failed syscall name */

  char  **mesgs;    /* library or kernel messages (NULL terminated array) */

  struct libmnt_ns  ns_orig;  /* original namespace */

  struct libmnt_ns  ns_tgt;   /* target namespace */

  struct libmnt_ns  *ns_cur;  /* pointer to current namespace */

  unsigned int  enabled_textdomain : 1; /* bindtextdomain() called */

  unsigned int  noautofs : 1;   /* ignore autofs mounts */

  unsigned int  has_selinux_opt : 1;  /* temporary for broken fsconfig() syscall */

  unsigned int    force_clone : 1;  /* OPEN_TREE_CLONE */

  struct list_head  hooksets_datas; /* global hooksets data */

  struct list_head  hooksets_hooks; /* global hooksets data */

};

/* 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_RWONLY_MOUNT (1 << 14) /* explicit mount -w; never try read-only  */

#define MNT_FL_ONLYONCE   (1 << 15)

#define MNT_FL_EXCL   (1 << 16)

#define MNT_FL_BENEATH    (1 << 17)

#define MNT_FL_MOUNTDATA  (1 << 20)

#define MNT_FL_TAB_APPLIED  (1 << 21) /* 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_MOUNTOPTS_FIXED  (1 << 27)

#define MNT_FL_TABPATHS_CHECKED (1 << 28)

#define MNT_FL_FORCED_RDONLY  (1 << 29) /* mounted read-only on write-protected device */

#define MNT_FL_VERITYDEV_READY  (1 << 30) /* /dev/mapper/<FOO> initialized by the library */

/* default flags */

#define MNT_FL_DEFAULT    0

/* Flags usable with MS_BIND|MS_REMOUNT */

#define MNT_BIND_SETTABLE (MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_NOATIME|MS_NODIRATIME|MS_RELATIME|MS_RDONLY|MS_NOSYMFOLLOW)

/* 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_get_missing(const char *optstr, const char *wanted, char **missing);

extern int mnt_buffer_append_option(struct ul_buffer *buf,

                        const char *name, size_t namesz,

                        const char *val, size_t valsz, int quoted);

/* optlist.h */

struct libmnt_opt;

struct libmnt_optlist;

extern struct libmnt_optlist *mnt_new_optlist(void);

extern void mnt_ref_optlist(struct libmnt_optlist *ls);

extern void mnt_unref_optlist(struct libmnt_optlist *ls);

extern struct libmnt_optlist *mnt_copy_optlist(struct libmnt_optlist *ls);

extern int mnt_optlist_is_empty(struct libmnt_optlist *ls);

extern unsigned int mnt_optlist_get_age(struct libmnt_optlist *ls);

extern int mnt_optlist_register_map(struct libmnt_optlist *ls, const struct libmnt_optmap *map);

extern int mnt_optlist_remove_opt(struct libmnt_optlist *ls, struct libmnt_opt *opt);

extern int mnt_optlist_remove_named(struct libmnt_optlist *ls, const char *name,

                             const struct libmnt_optmap *map);

extern int mnt_optlist_remove_flags(struct libmnt_optlist *ls, unsigned long flags,

                        const struct libmnt_optmap *map);

extern int mnt_optlist_next_opt(struct libmnt_optlist *ls,

                        struct libmnt_iter *itr, struct libmnt_opt **opt);

extern struct libmnt_opt *mnt_optlist_get_opt(struct libmnt_optlist *ls,

                        unsigned long id, const struct libmnt_optmap *map);

extern struct libmnt_opt *mnt_optlist_get_named(struct libmnt_optlist *ls,

                          const char *name, const struct libmnt_optmap *map);

extern int mnt_optlist_set_optstr(struct libmnt_optlist *ls, const char *optstr,

                          const struct libmnt_optmap *map);

extern int mnt_optlist_append_optstr(struct libmnt_optlist *ls, const char *optstr,

                        const struct libmnt_optmap *map);

extern int mnt_optlist_prepend_optstr(struct libmnt_optlist *ls, const char *optstr,

                        const struct libmnt_optmap *map);

extern int mnt_optlist_append_flags(struct libmnt_optlist *ls, unsigned long flags,

                          const struct libmnt_optmap *map);

extern int mnt_optlist_set_flags(struct libmnt_optlist *ls, unsigned long flags,

                          const struct libmnt_optmap *map);

extern int mnt_optlist_insert_flags(struct libmnt_optlist *ls, unsigned long flags,

                        const struct libmnt_optmap *map,

                        unsigned long after,

                        const struct libmnt_optmap *after_map);

/* "what" argument */

enum {

  /* Default -- if @map specified then returns all options for the map, otherwise

   *            returns all options including uknonwn options, exclude external options  */

  MNT_OL_FLTR_DFLT = 0,

  /* Options as expected by mount.<type> helpers */

  MNT_OL_FLTR_HELPERS,

  /* Options as expected in mtab */

  MNT_OL_FLTR_MTAB,

  /* All options -- include mapped, unknown and external options */

  MNT_OL_FLTR_ALL,

  /* All unknown options -- exclude external (usually FS specific options) */

  MNT_OL_FLTR_UNKNOWN,

  __MNT_OL_FLTR_COUNT /* keep it last */

};

extern int mnt_optlist_get_flags(struct libmnt_optlist *ls, unsigned long *flags,

                          const struct libmnt_optmap *map, unsigned int what);

/* recursive status for mnt_optlist_get_attrs() */

#define MNT_OL_REC  1

#define MNT_OL_NOREC  2

extern int mnt_optlist_get_attrs(struct libmnt_optlist *ls, uint64_t *set, uint64_t *clr, int rec);

extern int mnt_optlist_get_optstr(struct libmnt_optlist *ol, const char **optstr,

                        const struct libmnt_optmap *map, unsigned int what);

extern int mnt_optlist_strdup_optstr(struct libmnt_optlist *ls, char **optstr,

                        const struct libmnt_optmap *map, unsigned int what);

extern int mnt_optlist_get_propagation(struct libmnt_optlist *ls);

extern int mnt_optlist_is_propagation_only(struct libmnt_optlist *ls);

extern int mnt_optlist_is_remount(struct libmnt_optlist *ls);

extern int mnt_optlist_is_rpropagation(struct libmnt_optlist *ls);

extern int mnt_optlist_is_bind(struct libmnt_optlist *ls);

extern int mnt_optlist_is_rbind(struct libmnt_optlist *ls);

extern int mnt_optlist_is_move(struct libmnt_optlist *ls);

extern int mnt_optlist_is_rdonly(struct libmnt_optlist *ls);

extern int mnt_optlist_is_silent(struct libmnt_optlist *ls);

extern int mnt_optlist_merge_opts(struct libmnt_optlist *ls);

extern int mnt_opt_has_value(struct libmnt_opt *opt);

extern const char *mnt_opt_get_value(struct libmnt_opt *opt);

extern const char *mnt_opt_get_name(struct libmnt_opt *opt);

extern const struct libmnt_optmap *mnt_opt_get_map(struct libmnt_opt *opt);

extern const struct libmnt_optmap *mnt_opt_get_mapent(struct libmnt_opt *opt);

extern int mnt_opt_set_external(struct libmnt_opt *opt, int enable);

extern int mnt_opt_set_value(struct libmnt_opt *opt, const char *str);

extern int mnt_opt_set_u64value(struct libmnt_opt *opt, uint64_t num);

extern int mnt_opt_set_quoted_value(struct libmnt_opt *opt, const char *str);

extern int mnt_opt_is_external(struct libmnt_opt *opt);

extern int mnt_opt_is_sepnodata(struct libmnt_opt *opt);

extern int mnt_opt_value_with(struct libmnt_opt *opt, const char *str);

/* fs.c */

extern int mnt_fs_follow_optlist(struct libmnt_fs *fs, struct libmnt_optlist *ol);

extern struct libmnt_fs *mnt_copy_mtab_fs(struct libmnt_fs *fs);

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)));

extern int __mnt_fs_set_target_ptr(struct libmnt_fs *fs, char *tgt)

      __attribute__((nonnull(1)));

/* context.c */

extern void mnt_context_syscall_save_status(struct libmnt_context *cxt,

                                        const char *syscallname, int success);

extern void mnt_context_syscall_reset_status(struct libmnt_context *cxt);

extern struct libmnt_context *mnt_copy_context(struct libmnt_context *o);

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_within_helper(struct libmnt_context *cxt);

extern int mnt_context_get_mountinfo(struct libmnt_context *cxt, struct libmnt_table **tb);

extern int mnt_context_get_mountinfo_for_target(struct libmnt_context *cxt,

            struct libmnt_table **mountinfo, const char *tgt);

extern int mnt_context_prepare_srcpath(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 void mnt_context_reset_mesgs(struct libmnt_context *cxt);

extern int mnt_context_append_mesg(struct libmnt_context *cxt, const char *msg);

extern int mnt_context_sprintf_mesg(struct libmnt_context *cxt, const char *msg, ...);

extern int mnt_context_read_mesgs(struct libmnt_context *cxt, int fd);

extern int mnt_context_propagation_only(struct libmnt_context *cxt)

      __attribute__((nonnull));

extern int mnt_context_delete_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);

extern int mnt_context_get_generic_excode(int rc, char *buf, size_t bufsz, const char *fmt, ...)

        __attribute__ ((__format__ (__printf__, 4, 5)));

extern int mnt_context_get_mount_excode(struct libmnt_context *cxt, int mntrc, char *buf, size_t bufsz);

extern int mnt_context_get_umount_excode(struct libmnt_context *cxt, int mntrc, char *buf, size_t bufsz);

extern int mnt_context_has_template(struct libmnt_context *cxt);

extern int mnt_context_apply_template(struct libmnt_context *cxt);

extern int mnt_context_save_template(struct libmnt_context *cxt);

extern int mnt_context_apply_fs(struct libmnt_context *cxt, struct libmnt_fs *fs);

extern struct libmnt_optlist *mnt_context_get_optlist(struct libmnt_context *cxt);

extern int mnt_context_is_xnocanonicalize(struct libmnt_context *cxt, const char *type);

/* tab_update.c */

extern int mnt_update_emit_event(struct libmnt_update *upd);

extern int mnt_update_set_filename(struct libmnt_update *upd, const char *filename);

extern int mnt_update_already_done(struct libmnt_update *upd);

extern int mnt_update_start(struct libmnt_update *upd);

extern int mnt_update_end(struct libmnt_update *upd);

#if __linux__

/* btrfs.c */

extern uint64_t btrfs_get_default_subvol_id(const char *path);

#endif

#ifdef USE_LIBMOUNT_MOUNTFD_SUPPORT

/* fsconfig/fsopen based stuff */

struct libmnt_sysapi {

  int fd_fs;    /* FD from fsopen() or fspick() */

  int fd_tree;  /* FD from fsmount() or open_tree() */

  char  *subdir;  /* Linux >= 6.15 can directly open subdir;

         * hook_subdir sets this variable */

  unsigned int is_new_fs : 1 ;  /* fd_fs comes from fsopen() */

};

static inline struct libmnt_sysapi *mnt_context_get_sysapi(struct libmnt_context *cxt)

{

  return mnt_context_get_hookset_data(cxt, &hookset_mount);

}

int mnt_context_open_tree(struct libmnt_context *cxt, const char *path, unsigned long mflg);

#endif

#endif /* _LIBMOUNT_PRIVATE_H */