Copyright (c) 1992, 1993
The Regents of the University of California. All rights reserved.
All rights reserved.
This code is derived from software donated to Berkeley by
Jan-Simon Pendry.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)mount_procfs.8 8.3 (Berkeley) 6/1/94
.Dd February 24, 2009 .Dt MOUNT_PROCFS 8 .Os .Sh NAME .Nm mount_procfs .Nd mount the process file system .Sh SYNOPSIS .Nm .Op Fl o Ar options
a /proc
a mount_point .Sh DESCRIPTION The .Nm command attaches an instance of the process namespace to the global filesystem namespace. The conventional mount point is
a /proc . The directory specified by .Ar mount_point is converted to an absolute path before use. This command is normally executed by .Xr mount 8 at boot time.
p The options are as follows: l -tag -width indent t Fl o Cm nolinux Do not support nodes which are not part of the original procfs implementation but have been added for compatibility with the Linux procfs namespace. See .Sx FILES for more information. .El
p The root of the process filesystem contains an entry for each active process. These processes are visible as a directory whose name is the process' pid. In addition, the special entries
a curproc and
a self reference the current process. The
a self symlink appears for compatibility with the Linux procfs implementation.
p Each directory contains several files. l -tag -width status t Pa cmdline This file is readonly and returns null-terminated strings corresponding to the process' command line arguments. For a system or zombie process, this file contains only a string with the name of the process. t Pa ctl a writeonly file which supports a variety of control operations. Control commands are written as strings to the
a ctl file. The control commands are: l -tag -width detach -compact t attach stops the target process and arranges for the sending process to become the debug control process. t detach continue execution of the target process and remove it from control by the debug process. t run continue running the target process until a signal is delivered, a breakpoint is hit, or the target process exits. t step single step the target process, with no signal delivery. t wait wait for the target process to stop. The target process must be stopped before any of the run, step, or signal commands are allowed. .El
p The string can also be the name of a signal, lower case and without the .Dv SIG prefix, in which case that signal is delivered to the process (see .Xr sigaction 2 ) . t Pa cwd A symbolic link that points to the current working directory of the process. If the target process's current working directory is not available or is not at or below the current process's root directory, this link will point to .Dq / . t Pa fd/# File descriptors which can be accessed through the file system. See .Xr fd 4 for more information. t Pa file A reference to the vnode from which the process text was read. This can be used to gain access to the process' symbol table, or to start another copy of the process. t Pa map A map of the process' virtual memory. t Pa maps A map of the process' virtual memory in a form like the proc filesystem as implemented in Linux. Note that the paths corresponding to file backed mappings will not be present unless the kernel was built with the NAMECACHE_ENTER_REVERSE option. t Pa mem The complete virtual memory image of the process. Only those addresses which exist in the process can be accessed. Writes to this file modify the process. Writes to the text segment normally remain private to the process, since the text segment is mapped with MAP_PRIVATE; however, this is not guaranteed. t Pa note Not implemented. t Pa notepg Not implemented. t Pa regs Allows read and write access to the process' register set. This file contains a binary data structure .Dv "struct regs" defined in
a regs can only be written when the process is stopped. t Pa fpregs The floating point registers as defined by .Dv "struct fpregs" in
a fpregs is only implemented on machines which have distinct general purpose and floating point register sets. t Pa root A symbolic link that points to the root directory of the process. If the target process's root directory is not available or is not at or below the current process's root directory, this link will point to .Dq / . t Pa status The process status. This file is readonly and returns a single line containing multiple space-separated fields as follows:
p l -bullet -compact t command name t process id t parent process id t process group id t session id t .Ar major,minor of the controlling terminal, or .Dv -1,-1 if there is no controlling terminal. t a list of process flags: .Dv ctty if there is a controlling terminal, .Dv sldr if the process is a session leader, .Dv noflags if neither of the other two flags are set. t the process start time in seconds and microseconds, comma separated. t the user time in seconds and microseconds, comma separated. t the system time in seconds and microseconds, comma separated. t the wait channel message t the process credentials consisting of the effective user id and the list of groups (whose first member is the effective group id) all comma separated. .El .El
p In a normal debugging environment, where the target is fork/exec'd by the debugger, the debugger should fork and the child should stop itself (with a self-inflicted .Dv SIGSTOP for example). The parent should issue a .Dv wait and then an .Dv attach command via the appropriate
a ctl file. The child process will receive a .Dv SIGTRAP immediately after the call to exec (see .Xr execve 2 ) . .Sh FILES l -tag -width /proc/curproc -compact t Pa /proc/# t Pa /proc/#/cmdline t Pa /proc/#/ctl t Pa /proc/#/cwd t Pa /proc/#/exe t Pa /proc/#/file t Pa /proc/#/fpregs t Pa /proc/#/map t Pa /proc/#/maps t Pa /proc/#/mem t Pa /proc/#/note t Pa /proc/#/notepg t Pa /proc/#/regs t Pa /proc/#/root t Pa /proc/#/status t Pa /proc/curproc t Pa /proc/self .El
p If the .Cm linux mount option is used, the following files are also available:
p l -tag -width /proc/meminfo -compact t Pa /proc/#/stat t Pa /proc/cpuinfo t Pa /proc/devices t Pa /proc/meminfo t Pa /proc/mounts t Pa /proc/uptime .El .Sh SEE ALSO .Xr mount 2 , .Xr sigaction 2 , .Xr unmount 2 .Sh HISTORY The .Nm utility first appeared in x 4.4 . .Sh BUGS This filesystem may not be NFS-exported since most of the functionality of .Dv procfs requires that state be maintained.