]> git.lizzy.rs Git - plan9front.git/blob - sys/man/3/proc
/sys/man/*/*: fix perms (sorry)
[plan9front.git] / sys / man / 3 / proc
1 .TH PROC 3
2 .SH NAME
3 proc \- running processes
4 .SH SYNOPSIS
5 .nf
6 .B bind #p /proc
7 .sp 0.3v
8 .B /proc/trace
9 .BI /proc/ n /args
10 .BI /proc/ n /ctl
11 .BI /proc/ n /fd
12 .BI /proc/ n /fpregs
13 .BI /proc/ n /kregs
14 .BI /proc/ n /mem
15 .BI /proc/ n /note
16 .BI /proc/ n /noteid
17 .BI /proc/ n /notepg
18 .BI /proc/ n /ns
19 .BI /proc/ n /proc
20 .BI /proc/ n /profile
21 .BI /proc/ n /regs
22 .BI /proc/ n /segment
23 .BI /proc/ n /status
24 .BI /proc/ n /text
25 .BI /proc/ n /wait
26 \&...
27 .fi
28 .SH DESCRIPTION
29 The
30 .I proc
31 device serves a two-level directory structure.
32 The first level contains the
33 .B trace
34 file (see below) and numbered directories
35 corresponding to pids of live processes;
36 each such directory contains a set of files
37 representing the corresponding process.
38 .PP
39 The
40 .B mem
41 file contains the current memory image of the process.
42 A read or write at offset
43 .IR o ,
44 which must be a valid virtual address,
45 accesses bytes from address
46 .IR o
47 up to the end of the memory segment containing
48 .IR o .
49 Kernel virtual memory, including the kernel stack for the process and
50 saved user registers (whose addresses are machine-dependent),
51 can be accessed through
52 .BR mem .
53 Writes are permitted only while the process is in the
54 .B Stopped
55 state and only to user addresses or registers.
56 .PP
57 The read-only
58 .B proc
59 file contains the kernel per-process
60 structure.
61 Its main use is to recover the kernel stack and program counter
62 for kernel debugging.
63 .PP
64 The files
65 .BR regs ,
66 .BR fpregs ,
67 and
68 .BR kregs
69 hold representations of the user-level registers, floating-point registers,
70 and kernel registers in machine-dependent form.
71 The
72 .B kregs
73 file is read-only.
74 .PP
75 The read-only
76 .B fd
77 file lists the open file descriptors of the process.
78 The first line of the file is its current directory; subsequent lines list, one per line,
79 the open files, giving the decimal file descriptor number; whether the file is open for read
80 .RB ( r ),
81 write,
82 .RB ( w ),
83 or both
84 .RB ( rw );
85 the type, device number, and qid of the file; its I/O unit (the amount of data
86 that may be transferred on the file as a contiguous piece; see
87 .IR iounit (2)),
88 its I/O offset; and its name at the time it was opened.
89 .PP
90 The read-only
91 .B ns
92 file contains a textual representation of the process's file name space, in the format of
93 .IR namespace (6)
94 accepted by
95 .B newns
96 (see
97 .IR auth (2)).
98 The last line of the file identifies the current working directory of the process, in the form of a
99 .B cd
100 command
101 (see
102 .IR rc (1)).
103 The information in this file is based on the names files had when the name space was assembled,
104 so the names it contains may be inaccessible if the files have been subsequently renamed or rearranged.
105 .PP
106 The read-only
107 .B segment
108 file contains a textual display of the memory segments
109 attached to the process.  Each line has multiple fields:
110 the type of segment (\c
111 .BR Stack ,
112 .BR Text ,
113 .BR Data ,
114 .BR Bss ,
115 etc.); one-letter flags such as
116 .B R
117 for read-only, if any;
118 starting virtual address, in hexadecimal;
119 ending virtual address, and reference count.
120 .PP
121 The read-only
122 .B status
123 file contains a string with twelve fields, each followed by a space.
124 The fields are:
125 .IP \-
126 the process name and user name, each 27 characters left justified
127 .IP \-
128 the process state, 11 characters left justified (see
129 .IR ps (1))
130 .IP \-
131 the six 11-character numbers also held in the process's
132 .B #c/cputime
133 file
134 .IP \-
135 the amount of memory used by the process in units of 1024 bytes
136 .IP \-
137 the base and current scheduling priority, each 11 character numbers
138 .PP
139 The
140 .B args
141 file contains the arguments of the program when it was created by
142 .IR exec (2).
143 Writing to the
144 .B args
145 file will overwrite its contents.
146 If the program was not created by
147 .BR exec ,
148 such as by
149 .IR fork (2),
150 its
151 .B args
152 file will be empty.
153 The format of the file is a list of quoted strings suitable for
154 .BR tokenize ;
155 see
156 .IR getfields (2).
157 .PP
158 The
159 .B text
160 file is a pseudonym for the file
161 from which the process was executed;
162 its main use is to recover the symbol table of the process.
163 .PP
164 The
165 .B wait
166 file may be read to recover
167 records from the exiting children of the process in the format of
168 .B await
169 (see
170 .IR wait (2)).
171 If the process has no extant children, living or exited,
172 a read of
173 .B wait
174 will block.
175 It is an error for a process to attempt to read its own
176 .B wait
177 file when it has no children.
178 When a process's
179 .B wait
180 file is being read,
181 the process will draw an error
182 if it attempts an
183 .B await
184 system call; similarly, if a process is in an
185 .B await
186 system call, its
187 .B wait
188 file cannot be read by any process.
189 .PP
190 The read-only
191 .B profile
192 file contains the instruction frequency count information used for multiprocess profiling; see
193 .B tprof
194 in
195 .IR prof (1).
196 The information is gleaned by sampling the program's user-level program counter
197 at interrupt time.
198 .PP
199 Strings written to the
200 .B note
201 file will be posted as a note to the process
202 (see
203 .IR notify (2)).
204 The note should be less than
205 .B ERRLEN-1
206 characters long;
207 the last character is reserved for a terminating NUL character.
208 A read of at least
209 .B ERRLEN
210 characters will retrieve the oldest note posted to the
211 process and prevent its delivery to the process.
212 The
213 .B notepg
214 file is similar, but the note will be delivered to all the
215 processes in the target process's
216 .I note group
217 (see
218 .IR fork (2)).
219 However, if the process doing the write is in the group,
220 it will not receive the note.
221 The
222 .B notepg
223 file is write-only.
224 .PP
225 The textual
226 .B noteid
227 file may be read to recover an integer identifying the note group of the process
228 (see
229 .B RFNOTEG
230 in
231 .IR fork (2)).
232 The file may be written to cause the process to change to another note group,
233 provided the group exists and is owned by the same user.
234 .PP
235 The file
236 .B /proc/trace
237 can be opened once and read to see trace events from processes that have
238 had the string
239 .B trace
240 written to their
241 .B ctl
242 file.
243 Each event produces, in native machine format, the
244 .IR pid ,
245 a
246 .IR type ,
247 and a
248 .I "time stamp"
249 (see
250 .B /sys/include/trace.h
251 and
252 .BR /sys/src/cmd/trace.c ).
253 .
254 .PP
255 The \fLwatchpt\fR file contains a list of the watchpoints set for the process.
256 If supported by the hardware, watchpoints can be used to trap accesses to specific addresses.
257 Each line in the file has the form "\fItype\fR \fIaddress\fR \fIlength\fR",
258 where \fItype\fR consists of the characters \fLr\fR (read), \fLw\fR (write), \fLx\fR (execute) or \fL-\fR (padding character).
259 The watchpoint triggers on an access to the \fIlength\fR bytes starting at \fIaddress\fR if the type of the access must match one of the characters in the \fItype\fR field.
260 .PP
261 Writing to the file either replaces (offset zero) or adds to (offset non-zero) the list of watchpoints.
262 Each line written must be terminated by a newline.
263 If and only if all lines written comply with the (usually rather idiosyncratic) hardware restrictions, the list is updated; otherwise all changes are discarded.
264 Watchpoints can also be cleared by opening the file with \fLOTRUNC\fR (see
265 .IR open (2)).
266 .PP
267 A triggered watchpoint will deliver a \fLsys: watchpoint\fR note which includes a comma-separated list of the watchpoints that were triggered, where 0 corresponds to the first line in the
268 .B watchpt
269 file, 1 to the second and so forth.
270 .SS Control messages
271 Textual messages written to the
272 .B ctl
273 file control the execution of the process.
274 Some require that the process is in a particular state
275 and return an error if it is not.
276 .TP 10n
277 .B stop
278 Suspend execution of the process, putting it in the
279 .B Stopped
280 state.
281 .TP 10n
282 .B start
283 Resume execution of a
284 .B Stopped
285 process.
286 .TP 10n
287 .B waitstop
288 Do not affect the process directly but, like all other messages ending with
289 .BR stop ,
290 block the process writing the
291 .B ctl
292 file until the target process is in the
293 .B Stopped
294 state or exits.
295 Also like other
296 .B stop
297 control messages,
298 if the target process would receive a note while the message is pending,
299 it is instead stopped and the debugging process is resumed.
300 .TP 10n
301 .B startstop
302 Allow a
303 .B Stopped
304 process to resume, and then do a
305 .B waitstop
306 action.
307 .TP 10n
308 .B hang
309 Set a bit in the process so that,
310 when it completes an
311 .IR exec (2)
312 system call, it will enter the
313 .B Stopped
314 state before returning to user mode.
315 This bit is inherited across
316 .IR fork (2)
317 and
318 .IR exec (2).
319 .TP 10n
320 .B nohang
321 Clear the hang bit.
322 .TP 10n
323 .B private
324 Make it impossible to read the process's user memory.
325 This property is inherited on
326 .IR fork (2),
327 cleared on
328 .IR exec (2),
329 and is not otherwise resettable.
330 .TP 10n
331 .B noswap
332 Don't allow this process to be swapped out.  This should
333 be used carefully and sparingly or the system could run
334 out of memory.  It is meant for processes that can't be
335 swapped, like the local fileserver implementing the swap
336 device and for processes containing sensitive data.
337 This property is inherited on
338 .IR fork (2),
339 cleared on
340 .IR exec (2),
341 and is not otherwise resettable.
342 .TP 10n
343 .B kill
344 Kill the process the next time it crosses the user/kernel boundary.
345 .TP 10n
346 .B "close\ \fIn
347 Close file descriptor
348 .I n
349 in the process.
350 .TP 10n
351 .B closefiles
352 Close all open file descriptors in the process.
353 .TP 10n
354 .B "pri\ \fIn
355 Set the base priority for the process to the integer
356 .IR n .
357 .TP 10n
358 .B "wired\ \fIn
359 Wire the process to processor
360 .IR n .
361 .TP 10n
362 .B trace
363 Without an argument, toggle trace event generation for this process into
364 .B /proc/trace
365 (see below).
366 With a zero argument, tracing for the proc is turned off, with a non-zero numeric
367 argument, it is turned on.
368 .TP 10n
369 .B interrupt
370 Interrupt a blocking system call. If no blocking call was in progress,
371 the interrupt will be pending and the next attempt to block will be interrupted.
372 This is similar to posting a note but, unlike notes, a pending interrupt is not
373 cleared when crossing the user/kernel boundary.
374 .TP 10n
375 .B nointerrupt
376 Clear a pending interrupt.
377 .TP 10n
378 .B "period\ \fInu
379 Set the real-time scheduling period of the process to
380 .IR nu ,
381 where
382 .I n
383 is an optionally signed number containing an optional decimal point and
384 .I u
385 is one of
386 .BR s ,
387 .BR ms ,
388 .BR us ,
389 .BR µs ,
390 .BR ns ,
391 or
392 empty.  The time is interpreted, respectively, as
393 .IR seconds ,
394 .IR milliseconds ,
395 .IR microseconds ,
396 .IR microseconds ,
397 .IR nanoseconds ,
398 or, in the case of an absent units specifier, as
399 .IR nanoseconds .
400 If the time specifier is signed, it is interpreted as an increment or decrement
401 from a previously set value.  See also the
402 .B admit
403 command below.
404 .TP 10n
405 .B "deadline\ \fInu
406 Set the real-time deadline interval of the process to
407 .IR nu ,
408 where
409 .I n
410 and
411 .I u
412 are interpreted as for
413 .B period
414 above.
415 .TP 10n
416 .B "cost\ \fInu
417 Set the real-time cost (maximum CPU time per period) of the process to
418 .IR nu ,
419 where
420 .I n
421 and
422 .I u
423 are interpreted as for
424 .B period
425 above.
426 .TP 10n
427 .B "sporadic
428 Use sporadic scheduling for the real-time process.  The description of the
429 .B admit
430 command below contains further details.
431 .TP 10n
432 .B "yieldonblock
433 Make the real-time process yield on blocking I/O.
434   The description of the
435 .B admit
436 command below contains further details.
437 .TP 10n
438 .B "admit
439 Given real-time
440 .IR period ,
441 .I deadline
442 and
443 .I cost
444 are set (an unset
445 .I deadline
446 will set
447 .I deadline
448 to
449 .IR period ),
450 perform a schedulability test and start scheduling the process as a real-time
451 process if the test succeeds.  If the test fails, the
452 .B write
453 will fail with error set to the reason for failure.
454 .TP 10n
455 .B event
456 Add a user event to the
457 .B /proc/trace
458 file.
459 .PD
460 .
461 .SS Real-time scheduling
462 .I Real-time
463 processes are periodically
464 .IR released ,
465 giving them a higher priority than non-real-time processes until they either
466 give up the processor voluntarily, they exhaust their CPU allocation, or they reach their
467 .IR deadline .
468 The moment of release is dictated by the
469 .I period
470 and whether the process is
471 .I sporadic
472 or not.
473 Non-sporadic processes are called
474 .I periodic
475 and they are released precisely at intervals of their period (but periods can be skipped
476 if the process blocks on I/O).
477 Sporadic processes are released whenever they become
478 runnable (after being blocked by
479 .IR sleep ()
480 or I/O), but always at least an interval of
481 .I period
482 after the previous release.
483 .PP
484 The
485 .I deadline
486 of a real-time process specifies that the process must complete within the first
487 .I deadline
488 seconds of its
489 .IR period .
490 The dealine must be less than or equal to the period.
491 If it is not specified, it is set to the period.
492 .PP
493 The
494 .I cost
495 of a real-time process describes the maximum CPU time the process may use per period.
496 .PP
497 A real-time process can give up the CPU before its deadline is reached
498 or its allocation is exhausted.
499 It does this by calling
500 .IR sleep (0).
501 If
502 .I yieldonblock
503 is specified, it also does it by executing any blocking system call.
504 .I Yieldonblock
505 is assumed for
506 .I sporadic
507 processes.
508 .PP
509 Of the released processes,
510 the one with the earliest deadline has the highest priority.
511 Care should be taken using spin locks (see
512 .IR lock (2))
513 because a real-time process spinning on a lock will not give up the processor until
514 its CPU allocation is exhausted; this is unlikely to be the desired behavior.
515 .PP
516 When a real-time process reaches its deadline or exhausts its CPU allocation, it remains
517 schedulable, but at a very low priority.
518 .PP
519 The priority is interpreted by Plan 9's multilevel process scheduler.
520 Priorities run from 0 to 19, with higher
521 numbers representing higher priorities.
522 A process has a base priority and
523 a running priority which is less than or equal to the base priority.
524 As a process uses up more of its allocated time, its priority is lowered.
525 Unless
526 explicitly set, user processes have base priority 10, kernel processes
527 13.
528 Children inherit the parent's base priority.
529 .SH FILES
530 .nf
531 .B /sys/src/9/*/mem.h
532 .B /sys/src/9/*/dat.h
533 .B /sys/include/trace.h
534 .fi
535 .SH SEE ALSO
536 .IR trace (1),
537 .IR debugger (2),
538 .IR mach (2),
539 .IR cons (3)
540 .SH SOURCE
541 .B /sys/src/9/port/devproc.c