path: root/sbin/mount_procfs/mount_procfs.8

.\"	$OpenBSD: mount_procfs.8,v 1.22 2003/12/08 11:30:28 jmc Exp $
.\"	$NetBSD: mount_procfs.8,v 1.6 1995/03/18 14:58:10 cgd Exp $
.\"
.\" 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.2 (Berkeley) 3/27/94
.\"
.Dd March 27, 1994
.Dt MOUNT_PROCFS 8
.Os
.Sh NAME
.Nm mount_procfs
.Nd mount the process file system
.Sh SYNOPSIS
.Nm mount_procfs
.Op Fl o Ar options
.Pa /proc
.Pa mount_point
.Sh DESCRIPTION
The
.Nm
command attaches an instance of the process
namespace to the global filesystem namespace.
The conventional mount point is
.Pa /proc .
This command is normally executed by
.Xr mount 8
at boot time.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl o Ar options
Options are specified with a
.Fl o
flag followed by a comma separated string of options.
See the
.Xr mount 8
man page for possible options and their meanings.
The following procfs specific option is also available:
.Bl -tag -width indent
.It linux
Add Linux compatibility links and nodes to procfs.
.El
.El
.Pp
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's PID.
In addition, the special entry
.Pa curproc
references the current process.
.Pp
Each directory contains several files.
.Bl -tag -width status
.It Pa cmdline
Process command line parameters, separated by NULs.
.It Pa ctl
A write-only file which supports a variety
of control operations.
Control commands are written as strings to the
.Pa ctl
file.
The control commands are:
.Pp
.Bl -tag -width detach -compact
.It attach
Stops the target process and arranges for the sending
process to become the debug control process.
.It detach
Continues execution of the target process and
removes it from control by the debug process (which
need not be the sending process).
.It run
Continues running the target process until
a signal is delivered, a breakpoint is hit, or the
target process exits.
.It step
Single steps the target process, with no signal delivery.
.It wait
Waits for the target process to come to a steady
state ready for debugging.
The target process must be in this state before
any of the other commands are allowed.
.El
.Pp
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 ) .
.It Pa file
A reference to the vnode from which the process text was read.
This can be used to gain access to the process's symbol table,
or to start another copy of the process.
.It Pa fpregs
The floating point registers as defined by
.Dv "struct fpregs"
in
.Aq Pa machine/reg.h .
.Pa fpregs
is only implemented on machines which have distinct general
purpose and floating point register sets.
.It Pa mem
The complete virtual memory image of the process.
Only those address which exist in the process can be accessed.
Reads and writes to this file modify the process.
Writes to the text segment remain private to the process.
.It Pa note
Not implemented.
.It Pa notepg
Not implemented.
.It Pa regs
Allows read and write access to the process's register set.
This file contains a binary data structure
.Dv "struct regs"
defined in
.Aq Pa machine/reg.h .
.Pa regs
can only be written when the process is stopped.
.It Pa status
The process status.
This file is read-only and returns a single line containing
multiple space-separated fields as follows:
.Pp
.Bl -bullet -compact
.It
Command name.
.It
Process ID.
.It
Parent process ID.
.It
Process group ID.
.It
Session ID.
.It
.Ar major,minor
of the controlling terminal, or
.Dv -1,-1
if there is no controlling terminal.
.It
List of process flags:
.Dv ctty
if there is a controlling terminal,
.Dv sldr
if the process is a session leader, or
.Dv noflags
if neither of the other two flags are set.
.It
Process start time in seconds and microseconds,
comma separated.
.It
User time in seconds and microseconds,
comma separated.
.It
System time in seconds and microseconds,
comma separated.
.It
Wait channel message.
.It
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
.Pp
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
.Pa ctl
file.
The child process will receive a
.Dv SIGTRAP
immediately after the call to exec (see
.Xr execve 2 ) .
.Pp
Statistics reported by
.Xr df 1
on a procfs filesystem will indicate virtual memory used/available instead of
.Sq disk space ,
and the number of process slots used/allocated instead of
.Sq inodes .
The block size of the filesystem is the system page size.
.Sh FILES
.Bl -tag -width /proc/curproc -compact
.It Pa /proc/#
.It Pa /proc/curproc
.It Pa /proc/curproc/cmdline
.It Pa /proc/curproc/ctl
.It Pa /proc/curproc/file
.It Pa /proc/curproc/fpregs
.It Pa /proc/curproc/mem
.It Pa /proc/curproc/note
.It Pa /proc/curproc/notepg
.It Pa /proc/curproc/regs
.It Pa /proc/curproc/status
.El
.Sh SEE ALSO
.Xr mount 2 ,
.Xr sigaction 2 ,
.Xr fstab 5 ,
.Xr mount 8 ,
.Xr umount 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
.Sh CAVEATS
This filesystem may not be NFS-exported
since most of the functionality of
.Dv procfs
requires that state be maintained.