diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2003-07-24 22:08:57 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2003-07-24 22:08:57 +0000 |
commit | 4979527ac89a23153e53f1107c12df9d47a529b2 (patch) | |
tree | 1aad473700f601dc8a0a99c967da762e7c306749 /share/man | |
parent | 5adf94b59c8d8c11af0c306e44587ebfd44e535b (diff) |
various tweaks;
ok mickey@
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man9/ktrace.9 | 25 | ||||
-rw-r--r-- | share/man/man9/namei.9 | 4 | ||||
-rw-r--r-- | share/man/man9/syscall.9 | 50 | ||||
-rw-r--r-- | share/man/man9/systrace.9 | 8 |
4 files changed, 44 insertions, 43 deletions
diff --git a/share/man/man9/ktrace.9 b/share/man/man9/ktrace.9 index 025065935de..36fb5e4688f 100644 --- a/share/man/man9/ktrace.9 +++ b/share/man/man9/ktrace.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ktrace.9,v 1.1 2003/07/24 20:15:45 mickey Exp $ +.\" $OpenBSD: ktrace.9,v 1.2 2003/07/24 22:08:56 jmc Exp $ .\" .\" Copyright (c) 2003 Michael Shalayeff .\" @@ -54,15 +54,16 @@ .Ft void .Fn ktrsysret "struct proc *p" "register_t code" "int error" "register_t retval" .Sh DESCRIPTION -This interface is ment for kernel subsystems and machine dependent code +This interface is meant for kernel subsystems and machine dependent code to inform the user about the events occuring to the process should tracing of such be enabled using the .Xr ktrace 2 system call. Each of the functions (except for .Nm KTRPOINT ) -is ment for a particular type of events and is described below. +is meant for a particular type of event and is described below. .Pp +The .Fn KTRPOINT macro should be used before calling any of the other tracing functions to verify that tracing for that particular type of events has been enabled. @@ -75,7 +76,7 @@ argument are a mask of the KTRFAC_ values described in is called during the context switching. The .Fa user -argument is a boolean value specifing whether process has +argument is a boolean value specifying whether the process has been put into a waiting state (true) or placed onto a running queue (false). Furthemore the .Fa user @@ -89,7 +90,7 @@ is changed and thus the name of which is given in the argument. .Pp .Fn ktrgenio -should be called for each generic input/output transactions that is +should be called for each generic input/output transaction that is described by the .Fa fd file descriptor, @@ -105,7 +106,7 @@ input/output data vector, size of the .Fa iov vector, -and, at last, +and, lastly, .Fa error status of the transaction. .Pp @@ -122,9 +123,10 @@ should be called for each signal posted for the traced process. The .Fa action -taken is one of the +taken is one of .Nm SIG_DFL , .Nm SIG_IGN , +or .Nm SIG_ERR as described in the .Xr sigaction 2 @@ -133,7 +135,7 @@ document. is the current traced process' signal mask. Signal-specific code and .Em siginfo_t -structure as descibed in the +structure as described in .Aq Pa sys/siginfo.h are given in the .Fa code @@ -154,12 +156,13 @@ should be called for a return from each system call number .Fa code and error number of .Fa error -as described in the +as described in .Xr errno 2 and a return value in -.Fa retval that is syscall dependent. +.Fa retval +that is syscall dependent. .Sh CODE REFERENCES -These process tracing facility is implemented in +The process tracing facility is implemented in .Pa sys/kern/kern_ktrace.c . .Sh SEE ALSO .Xr errno 2 , diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9 index 99d434a8e3e..77ab38ed5f8 100644 --- a/share/man/man9/namei.9 +++ b/share/man/man9/namei.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: namei.9,v 1.3 2003/07/24 20:15:45 mickey Exp $ +.\" $OpenBSD: namei.9,v 1.4 2003/07/24 22:08:56 jmc Exp $ .\" $NetBSD: namei.9,v 1.9 2003/05/06 10:46:44 jmmv Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. @@ -296,7 +296,7 @@ The name lookup subsystem is implemented within the file .Xr intro 9 , .\" .Xr namecache 9 , .Xr vfs 9 , -.Xr vnode 9 +.Xr vnode 9 , .Xr vnodeops 9 .Sh BUGS It is unfortunate that much of the diff --git a/share/man/man9/syscall.9 b/share/man/man9/syscall.9 index 726a586e9e9..b6bfdd12283 100644 --- a/share/man/man9/syscall.9 +++ b/share/man/man9/syscall.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: syscall.9,v 1.1 2003/07/24 20:15:45 mickey Exp $ +.\" $OpenBSD: syscall.9,v 1.2 2003/07/24 22:08:56 jmc Exp $ .\" .\" Copyright (c) 2003 Michael Shalayeff .\" @@ -34,19 +34,19 @@ System calls in the kernel are implemented through a set of switch tables for each emulation type. Each table is generated from the .Dq master -file by the +file by .Pa sys/kern/makesyscalls.sh through the appropriate rules in the .Pa Makefile . .Pp The .Dq master -file is a text file sonsisting of a list of lines for each -system call. Lines may be split by the means of back slashing the end -of the line. -Each line is a set of fields seprated by whitespaces: +file is a text file consisting of a list of lines for each +system call. +Lines may be split by the means of back slashing the end of the line. +Each line is a set of fields separated by whitespace: .Pp -.Cd number type ... +.D1 Cd number type ... .Pp Where: .Bl -tag -width number -compact @@ -69,20 +69,19 @@ included, but don't define the syscall args structure; included, but don't define the syscall args structure, and allow it to be "really" varargs; .It COMPAT_XX -a compatibility systen call, only included if the corresponding +a compatibility system call, only included if the corresponding option is configured for the kernel (see -.Xr options 4 ). +.Xr options 4 ) . .El .El .Pp The rest of the line for the STD, NODEF, NOARGS, and COMPAT_XX types is: .Pp -.Cd { pseudo-proto } [alias] +.D1 Cd { pseudo-proto } [alias] .Pp -The .Nm pseudo-proto -is a C-like prototype used to generate the system call argument list +is a C-like prototype used to generate the system call argument list, and alias is an optional name alias for the call. The function in the prototype has to be defined somewhere in the kernel sources as it will be used as an entry point for @@ -94,10 +93,9 @@ To generate the header and code files from the .Dq master file a .Xr make 1 -command has to be ran from the directory containing the +command has to be run from the directory containing the .Dq master file. -.Pp .Ss Usage Entry from the user space for the system call is machine dependant. Typical code to invoke a system call from the machine dependant @@ -167,7 +165,7 @@ else } #ifdef SYSCALL_DEBUG scdebug_ret(p, code, orig_error, rval); -#endif +#endif userret(p, frame.tf_eip, sticks); #ifdef KTRACE if (KTRPOINT(p, KTR_SYSRET)) @@ -179,33 +177,33 @@ else The .Dq SYSCALL_DEBUG parts of the code are explained in the section -.Dq Debugging +.Sx Debugging later in the document. For the .Dq KTRACE -portitions of the code refer to the +portions of the code refer to the .Xr ktrace 9 -document for futher exlanations. -The +document for futher explanations. .Dq NSYSTRACE is a system call tracing facility and is explained in the .Xr systrace 9 and -.Xr systrcae 4 +.Xr systrace 4 documents. .Ss Debugging -For debugging purposes a line +For debugging purposes the line .Pp -.Cd option SYSCALL_DEBUG +.D1 Cd option SYSCALL_DEBUG .Pp -should be inluded into the kernel configuration file (see -.Xr options 4 ). +should be included in the kernel configuration file (see +.Xr options 4 ) . This allows tracing for calls, returns, and arguments for both -implemented and not system calls. +implemented and non-implemented system calls. A global integer variable .Dr scdebug contains a mask for for the desired logging events: -.Bl -tag -width SCDEBUG_SHOWARGS__ -compat +.Pp +.Bl -tag -width SCDEBUG_SHOWARGS__ -compact .It SCDEBUG_CALLS (0x0001) show calls; .It SCDEBUG_RETURNS diff --git a/share/man/man9/systrace.9 b/share/man/man9/systrace.9 index 77275036188..560d4e1ba5f 100644 --- a/share/man/man9/systrace.9 +++ b/share/man/man9/systrace.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: systrace.9,v 1.1 2003/07/24 20:15:45 mickey Exp $ +.\" $OpenBSD: systrace.9,v 1.2 2003/07/24 22:08:56 jmc Exp $ .\" .\" Copyright (c) 2003 Michael Shalayeff .\" @@ -50,10 +50,10 @@ with arguments .Fa args for the process .Fa p . -Result is then put into the +The result is then put into the .Fa retval pointer. -Typycal code sequence would be: +A typical code sequence would be: .Bd -literal -offset indent #include "systrace.h" @@ -73,7 +73,7 @@ is called from the function to inherit policy for the child process. .Pp .Fn systrace_exit -is called during the death cycle of the prcess to +is called during the death cycle of the process to detach the policy from the exiting process. .Sh CODE REFERENCES A subsystem for enforcing system call policies is implemented in |