share/man/man5/linprocfs.5

   1 .\" Written by Garrett Wollman
   2 .\" This file is in the public domain.
   3 .\"
   4 .Dd November 13, 2019
   5 .Dt LINPROCFS 5
   6 .Os
   7 .Sh NAME
   8 .Nm linprocfs
   9 .Nd Linux process file system
  10 .Sh SYNOPSIS
  11 .Bd -literal
  12 linproc         /compat/linux/proc      linprocfs       rw 0 0
  13 .Ed
  14 .Sh DESCRIPTION
  15 The Linux process file system, or
  16 .Nm ,
  17 emulates a subset of Linux' process file system and is required for
  18 the complete operation of some Linux binaries.
  19 .Pp
  20 The
  21 .Nm
  22 provides a two-level view of process space.
  23 At the highest level, processes themselves are named, according to
  24 their process ids in decimal, with no leading zeros.
  25 There is also a special node called
  26 .Pa self
  27 which always refers to the process making the lookup request.
  28 .Pp
  29 Each node is a directory containing several files:
  30 .Bl -tag -width status
  31 .It Pa exe
  32 A reference to the vnode from which the process text was read.
  33 This can be used to gain access to the process' symbol table,
  34 or to start another copy of the process.
  35 .It Pa mem
  36 The complete virtual memory image of the process.
  37 Only those addresses which exist in the process can be accessed.
  38 Reads and writes to this file modify the process.
  39 Writes to the text segment remain private to the process.
  40 .El
  41 .Pp
  42 Each node is owned by the process's user, and belongs to that user's
  43 primary group, except for the
  44 .Pa mem
  45 node, which belongs to the
  46 .Li kmem
  47 group.
  48 .Sh FILES
  49 .Bl -tag -width /compat/linux/proc/self/XXXXXXX -compact
  50 .It Pa /compat/linux/proc
  51 The normal mount point for the
  52 .Nm .
  53 .It Pa /compat/linux/proc/cpuinfo
  54 CPU vendor and model information in human-readable form.
  55 .It Pa /compat/linux/proc/meminfo
  56 System memory information in human-readable form.
  57 .It Pa /compat/linux/proc/pid
  58 A directory containing process information for process
  59 .Pa pid .
  60 .It Pa /compat/linux/proc/self
  61 A directory containing process information for the current process.
  62 .It Pa /compat/linux/proc/self/exe
  63 The executable image for the current process.
  64 .It Pa /compat/linux/proc/self/mem
  65 The complete virtual address space of the current process.
  66 .El
  67 .Sh EXAMPLES
  68 To mount a
  69 .Nm
  70 file system on
  71 .Pa /compat/linux/proc :
  72 .Pp
  73 .Dl "mount -t linprocfs linproc /compat/linux/proc"
  74 .Sh SEE ALSO
  75 .Xr mount 2 ,
  76 .Xr unmount 2 ,
  77 .Xr linux 4 ,
  78 .Xr procfs 5 ,
  79 .Xr pseudofs 9
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 first appeared in
  84 .Fx 4.0 .
  85 .Sh AUTHORS
  86 .An -nosplit
  87 The
  88 .Nm
  89 was derived from
  90 .Nm procfs
  91 by
  92 .An Pierre Beyssac .
  93 This manual page was written by
  94 .An Dag-Erling Sm\(/orgrav ,
  95 based on the
  96 .Xr procfs 5
  97 manual page by
  98 .An Garrett Wollman .