Date: Fri, 8 May 2009 20:03:33 GMT From: Marko Zec <zec@FreeBSD.org> To: Perforce Change Reviews <perforce@freebsd.org> Subject: PERFORCE change 161786 for review Message-ID: <200905082003.n48K3XBv000318@repoman.freebsd.org>
next in thread | raw e-mail | index | archive | help
http://perforce.freebsd.org/chv.cgi?CH=161786 Change 161786 by zec@zec_tpx32 on 2009/05/08 20:03:02 Trim no longer available options / features from vimage.8 man page - CPU scheduling, various limits, chroot... XXX needs serious editing and listing of current limitations and bugs. Affected files ... .. //depot/projects/vimage-commit2/src/usr.sbin/vimage/vimage.8#2 edit Differences ... ==== //depot/projects/vimage-commit2/src/usr.sbin/vimage/vimage.8#2 (text+ko) ==== @@ -38,7 +38,7 @@ .Ar vi_name .Op command .Nm -.Brq Fl c | m +.Brq Fl c .Ar vi_name .Op options .Nm @@ -50,39 +50,36 @@ .Nm .Fl i .Ar vi_name interface -.Op target_interface .Sh DESCRIPTION .Nm command is the user interface for controlling the virtual image facility in FreeBSD. .Ss Overview Each virtual image presents an isolated operating environment with its own -private view of vital system resources, most notably user processes, -CPU time share and an independent network stack instance. -Accordingly, every process and every network interface present -in the system is always assigned +independent network stack instance. Accordingly, every process, socket +and every network interface present in the system is always assigned to a single and unique virtual image. During the system bootup sequence -the +a .So default .Sc virtual image is created to which all the configured interfaces and user processes are initially assigned. -Assuming that enough system resources -and per virtual image privileges are provided, the super-user can create and -manage a hierarchy of subordinated virtual images. The +Assuming that enough system resources and per virtual image privileges +are provided, the super-user can create and manage a hierarchy of +subordinated virtual images. The .Nm -command allows -creation, deletion, modification and monitoring of virtual images, as well as -execution of arbitrary processes in the target virtual image. +command allows for creation, deletion and monitoring of virtual images, +as well as for execution of arbitrary processes in a targeted virtual +image. .Ss Invocation With no arguments provided, the .Nm command returns the name of the current virtual image -on the standard output and exits. +on the standard output and exits. /* XXX this is pointles - current +name is always "." */ .Pp If invoked with no modifiers, the .Nm -command spawns a new process in virtual -image +command spawns a new process in virtual image .Ar vi_name . If provided, the optional arguments following the virtual image name .Ar vi_name @@ -99,25 +96,21 @@ If additional arguments are present following the .Ar vi_name parameter, they are interpreted as custom options (see below). -.It Fl m -Modify the custom options of the existing virtual image -.Ar vi_name , -in accordance with the additional arguments following the -.Ar vi_name -parameter (see below). .It Fl d Delete the virtual image .Ar vi_name . -No processes should exist in the target virtual image, in order for -deletion to succeed. Non-loopback interfaces residing in the target -virtual image will be reassigned to the virtual image's parent. +No processes and/or sockets should exist in the target virtual image +in order for the delete request to succeed. Non-loopback interfaces +residing in the target virtual image will be reassigned to the virtual +image's parent. .It Fl l -List the properties, custom parameters and statistics for virtual +List the properties and statistics for virtual images below the current one in the hierarchy. If an optional argument .Ar vi_name is provided, only the information regarding the target virtual image .Ar vi_name is displayed. +/* XXX mention -r modifier */ .It Fl i Move the interface .Ar interface @@ -133,68 +126,14 @@ .Pp The following options to .Fl c -and -.Fl m -modifiers are available: -.Bl -tag -width indent -.It Cm cpumin -Set the minimum guaranteed average CPU share for the target virtual image. -The parameter is specified as percentage in range between 0 and 90. -The guaranteed CPU share for the -.So default -.Sc virtual image cannot be set below 10%. -Note that the system does not enforce strict global budgeting on guaranteed -CPU time shares. Therefore it is in the sole responsibility of the system -administrator whether he/she will allow for guaranteed CPU shares to be -oversubscribed or not. By default no virtual image is granted a guaranteed -CPU share, except the -.So default -.Sc virtual image, which normally runs with -.Cm cpumin -level of 10%. -.It Cm cpumax -Set the upper limit to average total CPU usage for the target virtual image. -The limit is specified as a percentage (1-100%). However, the limit cannot -be raised above the current upper CPU limit of the parent virtual image. -By default there is no CPU usage limit (100%). -.It Cm cpuweight -If the current average CPU usage of a virtual image is above the -.Cm cpumin -level, but below the -.Cm cpumax, -the virtual image becomes subject to a proportional share CPU scheduler. -The -.Cm cpuweight -parameter determines how will the virtual image compete for the available -CPU time. The higher the -.Cm cpuweight, -the less often will the virtual image be allocated a CPU time slice. -Valid parameter values range from 1 (default) to 10. -.It Cm proc -Set the maximum number of processes that are allowed to exist simultaneously -in the target virtual image. The default is 0, which means no process limit. -.It Cm chroot -Set the chroot directory for the virtual image. All new processes spawned -into the target virtual image using the -.Nm -command will be initially chrooted to that directory. This parameter can -be changed only when no processes are running within the target virtual -image. Note that it is not required to have a chrooted environment for -a virtual image operate, which is also the default behavior. -.It Cm child -Limit the number of children the target virtual image is allowed to create. -The limit cannot be raised above the lowest child limit of all the ancestors -of the target virtual image. By default all created virtual images are -prohibited from creating new virtual images, except the -.So default -.Sc virtual image. +modifier are available: .El .Sh EXAMPLES Create a new virtual image named .So v1 -.Sc with average CPU usage limited to 20%: +.Sc : .Pp -.Dl vimage -c v1 cpumax 20% +.Dl vimage -c v1 .Pp Execute the .So ifconfig @@ -236,9 +175,6 @@ naming has to be extended to reflect virtual image association of netgraph nodes and interfaces. .Pp -No testing has been performed on SMP systems. There is absolutely no guarantee -that the kernel will even compile with SMP options enabled. -.Pp At the time of writing this document the code is still in highly experimental phase, so one should expect to encounter numerous undocumented problems. The author will welcome and appreciate all (decently documented) bugreports. @@ -249,4 +185,4 @@ .Sh HISTORY The .Nm -facility first appeared as a FreeBSD 4.7-RELEASE patch. +facility first appeared as a FreeBSD 4.7-RELEASE patch in 2002.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200905082003.n48K3XBv000318>