Skip to content

L
linux
Commit f11f2a3c authored by Jaskaran Singh's avatar Jaskaran Singh Committed by Jonathan Corbet
Browse files
Options

docs: filesystems: convert autofs.txt to reST 

Convert autofs.txt to reST.

The following changes abound:

- Introduce reST formatting for headings, lists et al.
- Add an indentation of an 8 space tab wherever suitable, so as
  to maintain consistency.
- Remove indentation of the description of the ioctls which are similar
  to the AUTOFS_IOC ioctls, as it does not come out quite right in HTML.
- Add an entry for autofs in the index.
Signed-off-by: default avatarJaskaran Singh <jaskaransingh7654321@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 14d3fe42
Show whitespace changes
Inline Side-by-side
Showing with 135 additions and 119 deletions
Documentation/filesystems/autofs.txt → Documentation/filesystems/autofs.rst
View file @ f11f2a3c
<head> =====================
<style> p { max-width:50em} ol, ul {max-width: 40em}</style>
</head>
autofs - how it works autofs - how it works
===================== =====================
Purpose Purpose
------- =======
The goal of autofs is to provide on-demand mounting and race free The goal of autofs is to provide on-demand mounting and race free
automatic unmounting of various other filesystems. This provides two automatic unmounting of various other filesystems. This provides two
...@@ -28,7 +25,7 @@ key advantages: ...@@ -28,7 +25,7 @@ key advantages:
first accessed a name. first accessed a name.
Context Context
------- =======
The "autofs" filesystem module is only one part of an autofs system. The "autofs" filesystem module is only one part of an autofs system.
There also needs to be a user-space program which looks up names There also needs to be a user-space program which looks up names
...@@ -43,7 +40,7 @@ filesystem type. Several "autofs" filesystems can be mounted and they ...@@ -43,7 +40,7 @@ filesystem type. Several "autofs" filesystems can be mounted and they
can each be managed separately, or all managed by the same daemon. can each be managed separately, or all managed by the same daemon.
Content Content
------- =======
An autofs filesystem can contain 3 sorts of objects: directories, An autofs filesystem can contain 3 sorts of objects: directories,
symbolic links and mount traps. Mount traps are directories with symbolic links and mount traps. Mount traps are directories with
...@@ -52,7 +49,7 @@ extra properties as described in the next section. ...@@ -52,7 +49,7 @@ extra properties as described in the next section.
Objects can only be created by the automount daemon: symlinks are Objects can only be created by the automount daemon: symlinks are
created with a regular `symlink` system call, while directories and created with a regular `symlink` system call, while directories and
mount traps are created with `mkdir`. The determination of whether a mount traps are created with `mkdir`. The determination of whether a
directory should be a mount trap or not is quite _ad hoc_, largely for directory should be a mount trap or not is quite ad hoc, largely for
historical reasons, and is determined in part by the historical reasons, and is determined in part by the
*direct*/*indirect*/*offset* mount options, and the *maxproto* mount option. *direct*/*indirect*/*offset* mount options, and the *maxproto* mount option.
...@@ -80,7 +77,7 @@ where in the tree they are (root, top level, or lower), the *maxproto*, ...@@ -80,7 +77,7 @@ where in the tree they are (root, top level, or lower), the *maxproto*,
and whether the mount was *indirect* or not. and whether the mount was *indirect* or not.
Mount Traps Mount Traps
--------------- ===========
A core element of the implementation of autofs is the Mount Traps A core element of the implementation of autofs is the Mount Traps
which are provided by the Linux VFS. Any directory provided by a which are provided by the Linux VFS. Any directory provided by a
...@@ -201,7 +198,7 @@ initiated or is being considered, otherwise it returns 0. ...@@ -201,7 +198,7 @@ initiated or is being considered, otherwise it returns 0.
Mountpoint expiry Mountpoint expiry
----------------- =================
The VFS has a mechanism for automatically expiring unused mounts, The VFS has a mechanism for automatically expiring unused mounts,
much as it can expire any unused dentry information from the dcache. much as it can expire any unused dentry information from the dcache.
...@@ -301,7 +298,7 @@ completed (together with removing any directories that might have been ...@@ -301,7 +298,7 @@ completed (together with removing any directories that might have been
necessary), or has been aborted. necessary), or has been aborted.
Communicating with autofs: detecting the daemon Communicating with autofs: detecting the daemon
----------------------------------------------- ===============================================
There are several forms of communication between the automount daemon There are several forms of communication between the automount daemon
and the filesystem. As we have already seen, the daemon can create and and the filesystem. As we have already seen, the daemon can create and
...@@ -317,12 +314,12 @@ If the daemon ever has to be stopped and restarted a new pgid can be ...@@ -317,12 +314,12 @@ If the daemon ever has to be stopped and restarted a new pgid can be
provided through an ioctl as will be described below. provided through an ioctl as will be described below.
Communicating with autofs: the event pipe Communicating with autofs: the event pipe
----------------------------------------- =========================================
When an autofs filesystem is mounted, the 'write' end of a pipe must When an autofs filesystem is mounted, the 'write' end of a pipe must
be passed using the 'fd=' mount option. autofs will write be passed using the 'fd=' mount option. autofs will write
notification messages to this pipe for the daemon to respond to. notification messages to this pipe for the daemon to respond to.
For version 5, the format of the message is: For version 5, the format of the message is::
struct autofs_v5_packet { struct autofs_v5_packet {
int proto_version; /* Protocol version */ int proto_version; /* Protocol version */
...@@ -338,7 +335,7 @@ For version 5, the format of the message is: ...@@ -338,7 +335,7 @@ For version 5, the format of the message is:
char name[NAME_MAX+1]; char name[NAME_MAX+1];
}; };
where the type is one of where the type is one of ::
autofs_ptype_missing_indirect autofs_ptype_missing_indirect
autofs_ptype_expire_indirect autofs_ptype_expire_indirect
...@@ -360,7 +357,7 @@ acknowledged using one of the ioctls below with the relevant ...@@ -360,7 +357,7 @@ acknowledged using one of the ioctls below with the relevant
`wait_queue_token`. `wait_queue_token`.
Communicating with autofs: root directory ioctls Communicating with autofs: root directory ioctls
------------------------------------------------ ================================================
The root directory of an autofs filesystem will respond to a number of The root directory of an autofs filesystem will respond to a number of
ioctls. The process issuing the ioctl must have the CAP_SYS_ADMIN ioctls. The process issuing the ioctl must have the CAP_SYS_ADMIN
...@@ -368,26 +365,34 @@ capability, or must be the automount daemon. ...@@ -368,26 +365,34 @@ capability, or must be the automount daemon.
The available ioctl commands are: The available ioctl commands are:
- **AUTOFS_IOC_READY**: a notification has been handled. The argument - **AUTOFS_IOC_READY**:
a notification has been handled. The argument
to the ioctl command is the "wait_queue_token" number to the ioctl command is the "wait_queue_token" number
corresponding to the notification being acknowledged. corresponding to the notification being acknowledged.
- **AUTOFS_IOC_FAIL**: similar to above, but indicates failure with - **AUTOFS_IOC_FAIL**:
similar to above, but indicates failure with
the error code `ENOENT`. the error code `ENOENT`.
- **AUTOFS_IOC_CATATONIC**: Causes the autofs to enter "catatonic" - **AUTOFS_IOC_CATATONIC**:
Causes the autofs to enter "catatonic"
mode meaning that it stops sending notifications to the daemon. mode meaning that it stops sending notifications to the daemon.
This mode is also entered if a write to the pipe fails. This mode is also entered if a write to the pipe fails.
- **AUTOFS_IOC_PROTOVER**: This returns the protocol version in use. - **AUTOFS_IOC_PROTOVER**:
- **AUTOFS_IOC_PROTOSUBVER**: Returns the protocol sub-version which This returns the protocol version in use.
- **AUTOFS_IOC_PROTOSUBVER**:
Returns the protocol sub-version which
is really a version number for the implementation. is really a version number for the implementation.
- **AUTOFS_IOC_SETTIMEOUT**: This passes a pointer to an unsigned - **AUTOFS_IOC_SETTIMEOUT**:
This passes a pointer to an unsigned
long. The value is used to set the timeout for expiry, and long. The value is used to set the timeout for expiry, and
the current timeout value is stored back through the pointer. the current timeout value is stored back through the pointer.
- **AUTOFS_IOC_ASKUMOUNT**: Returns, in the pointed-to `int`, 1 if - **AUTOFS_IOC_ASKUMOUNT**:
Returns, in the pointed-to `int`, 1 if
the filesystem could be unmounted. This is only a hint as the filesystem could be unmounted. This is only a hint as
the situation could change at any instant. This call can be the situation could change at any instant. This call can be
used to avoid a more expensive full unmount attempt. used to avoid a more expensive full unmount attempt.
- **AUTOFS_IOC_EXPIRE**: as described above, this asks if there is - **AUTOFS_IOC_EXPIRE**:
anything suitable to expire. A pointer to a packet: as described above, this asks if there is
anything suitable to expire. A pointer to a packet::
struct autofs_packet_expire_multi { struct autofs_packet_expire_multi {
int proto_version; /* Protocol version */ int proto_version; /* Protocol version */
...@@ -402,7 +407,8 @@ The available ioctl commands are: ...@@ -402,7 +407,8 @@ The available ioctl commands are:
`errno` is set to `EAGAIN`. Even though a `wait_queue_token` `errno` is set to `EAGAIN`. Even though a `wait_queue_token`
is present in the structure, no "wait queue" is established is present in the structure, no "wait queue" is established
and no acknowledgment is needed. and no acknowledgment is needed.
- **AUTOFS_IOC_EXPIRE_MULTI**: This is similar to - **AUTOFS_IOC_EXPIRE_MULTI**:
This is similar to
**AUTOFS_IOC_EXPIRE** except that it causes notification to be **AUTOFS_IOC_EXPIRE** except that it causes notification to be
sent to the daemon, and it blocks until the daemon acknowledges. sent to the daemon, and it blocks until the daemon acknowledges.
The argument is an integer which can contain two different flags. The argument is an integer which can contain two different flags.
...@@ -419,7 +425,7 @@ The available ioctl commands are: ...@@ -419,7 +425,7 @@ The available ioctl commands are:
name to expire. This is only safe when *maxproto* is 4. name to expire. This is only safe when *maxproto* is 4.
Communicating with autofs: char-device ioctls Communicating with autofs: char-device ioctls
--------------------------------------------- =============================================
It is not always possible to open the root of an autofs filesystem, It is not always possible to open the root of an autofs filesystem,
particularly a *direct* mounted filesystem. If the automount daemon particularly a *direct* mounted filesystem. If the automount daemon
...@@ -429,9 +435,9 @@ need there is a "miscellaneous" character device (major 10, minor 235) ...@@ -429,9 +435,9 @@ need there is a "miscellaneous" character device (major 10, minor 235)
which can be used to communicate directly with the autofs filesystem. which can be used to communicate directly with the autofs filesystem.
It requires CAP_SYS_ADMIN for access. It requires CAP_SYS_ADMIN for access.
The `ioctl`s that can be used on this device are described in a separate The 'ioctl's that can be used on this device are described in a separate
document `autofs-mount-control.txt`, and are summarised briefly here. document `autofs-mount-control.txt`, and are summarised briefly here.
Each ioctl is passed a pointer to an `autofs_dev_ioctl` structure: Each ioctl is passed a pointer to an `autofs_dev_ioctl` structure::
struct autofs_dev_ioctl { struct autofs_dev_ioctl {
__u32 ver_major; __u32 ver_major;
...@@ -469,41 +475,50 @@ that the kernel module can support. ...@@ -469,41 +475,50 @@ that the kernel module can support.
Commands are: Commands are:
- **AUTOFS_DEV_IOCTL_VERSION_CMD**: does nothing, except validate and - **AUTOFS_DEV_IOCTL_VERSION_CMD**:
does nothing, except validate and
set version numbers. set version numbers.
- **AUTOFS_DEV_IOCTL_OPENMOUNT_CMD**: return an open file descriptor - **AUTOFS_DEV_IOCTL_OPENMOUNT_CMD**:
return an open file descriptor
on the root of an autofs filesystem. The filesystem is identified on the root of an autofs filesystem. The filesystem is identified
by name and device number, which is stored in `openmount.devid`. by name and device number, which is stored in `openmount.devid`.
Device numbers for existing filesystems can be found in Device numbers for existing filesystems can be found in
`/proc/self/mountinfo`. `/proc/self/mountinfo`.
- **AUTOFS_DEV_IOCTL_CLOSEMOUNT_CMD**: same as `close(ioctlfd)`. - **AUTOFS_DEV_IOCTL_CLOSEMOUNT_CMD**:
- **AUTOFS_DEV_IOCTL_SETPIPEFD_CMD**: if the filesystem is in same as `close(ioctlfd)`.
- **AUTOFS_DEV_IOCTL_SETPIPEFD_CMD**:
if the filesystem is in
catatonic mode, this can provide the write end of a new pipe catatonic mode, this can provide the write end of a new pipe
in `setpipefd.pipefd` to re-establish communication with a daemon. in `setpipefd.pipefd` to re-establish communication with a daemon.
The process group of the calling process is used to identify the The process group of the calling process is used to identify the
daemon. daemon.
- **AUTOFS_DEV_IOCTL_REQUESTER_CMD**: `path` should be a - **AUTOFS_DEV_IOCTL_REQUESTER_CMD**:
`path` should be a
name within the filesystem that has been auto-mounted on. name within the filesystem that has been auto-mounted on.
On successful return, `requester.uid` and `requester.gid` will be On successful return, `requester.uid` and `requester.gid` will be
the UID and GID of the process which triggered that mount. the UID and GID of the process which triggered that mount.
- **AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD**: Check if path is a - **AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD**:
Check if path is a
mountpoint of a particular type - see separate documentation for mountpoint of a particular type - see separate documentation for
details. details.
- **AUTOFS_DEV_IOCTL_PROTOVER_CMD**:
- **AUTOFS_DEV_IOCTL_PROTOSUBVER_CMD**: - **AUTOFS_DEV_IOCTL_PROTOVER_CMD**
- **AUTOFS_DEV_IOCTL_READY_CMD**: - **AUTOFS_DEV_IOCTL_PROTOSUBVER_CMD**
- **AUTOFS_DEV_IOCTL_FAIL_CMD**: - **AUTOFS_DEV_IOCTL_READY_CMD**
- **AUTOFS_DEV_IOCTL_CATATONIC_CMD**: - **AUTOFS_DEV_IOCTL_FAIL_CMD**
- **AUTOFS_DEV_IOCTL_TIMEOUT_CMD**: - **AUTOFS_DEV_IOCTL_CATATONIC_CMD**
- **AUTOFS_DEV_IOCTL_EXPIRE_CMD**: - **AUTOFS_DEV_IOCTL_TIMEOUT_CMD**
- **AUTOFS_DEV_IOCTL_ASKUMOUNT_CMD**: These all have the same - **AUTOFS_DEV_IOCTL_EXPIRE_CMD**
function as the similarly named **AUTOFS_IOC** ioctls, except - **AUTOFS_DEV_IOCTL_ASKUMOUNT_CMD**
that **FAIL** can be given an explicit error number in `fail.status`
instead of assuming `ENOENT`, and this **EXPIRE** command These all have the same
corresponds to **AUTOFS_IOC_EXPIRE_MULTI**. function as the similarly named **AUTOFS_IOC** ioctls, except
that **FAIL** can be given an explicit error number in `fail.status`
instead of assuming `ENOENT`, and this **EXPIRE** command
corresponds to **AUTOFS_IOC_EXPIRE_MULTI**.
Catatonic mode Catatonic mode
-------------- ==============
As mentioned, an autofs mount can enter "catatonic" mode. This As mentioned, an autofs mount can enter "catatonic" mode. This
happens if a write to the notification pipe fails, or if it is happens if a write to the notification pipe fails, or if it is
...@@ -527,7 +542,7 @@ Catatonic mode can only be left via the ...@@ -527,7 +542,7 @@ Catatonic mode can only be left via the
**AUTOFS_DEV_IOCTL_OPENMOUNT_CMD** ioctl on the `/dev/autofs`. **AUTOFS_DEV_IOCTL_OPENMOUNT_CMD** ioctl on the `/dev/autofs`.
The "ignore" mount option The "ignore" mount option
------------------------- =========================
The "ignore" mount option can be used to provide a generic indicator The "ignore" mount option can be used to provide a generic indicator
to applications that the mount entry should be ignored when displaying to applications that the mount entry should be ignored when displaying
...@@ -542,18 +557,18 @@ This is intended to be used by user space programs to exclude autofs ...@@ -542,18 +557,18 @@ This is intended to be used by user space programs to exclude autofs
mounts from consideration when reading the mounts list. mounts from consideration when reading the mounts list.
autofs, name spaces, and shared mounts autofs, name spaces, and shared mounts
-------------------------------------- ======================================
With bind mounts and name spaces it is possible for an autofs With bind mounts and name spaces it is possible for an autofs
filesystem to appear at multiple places in one or more filesystem filesystem to appear at multiple places in one or more filesystem
name spaces. For this to work sensibly, the autofs filesystem should name spaces. For this to work sensibly, the autofs filesystem should
always be mounted "shared". e.g. always be mounted "shared". e.g. ::
> `mount --make-shared /autofs/mount/point` mount --make-shared /autofs/mount/point
The automount daemon is only able to manage a single mount location for The automount daemon is only able to manage a single mount location for
an autofs filesystem and if mounts on that are not 'shared', other an autofs filesystem and if mounts on that are not 'shared', other
locations will not behave as expected. In particular access to those locations will not behave as expected. In particular access to those
other locations will likely result in the `ELOOP` error other locations will likely result in the `ELOOP` error ::
> Too many levels of symbolic links Too many levels of symbolic links
Documentation/filesystems/index.rst
View file @ f11f2a3c
...@@ -46,4 +46,5 @@ Documentation for filesystem implementations. ...@@ -46,4 +46,5 @@ Documentation for filesystem implementations.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
autofs
virtiofs virtiofs
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7