Differential D5080 Diff 14959 head/usr.bin/rctl/rctl.8

Changeset View

Standalone View

head/usr.bin/rctl/rctl.8

	Show All 19 Lines
	.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS			.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN			.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)			.\" 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			.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	.\" POSSIBILITY OF SUCH DAMAGE.			.\" POSSIBILITY OF SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd November 29, 2015			.Dd January 30, 2016
	.Dt RCTL 8			.Dt RCTL 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm rctl			.Nm rctl
	.Nd display and update resource limits database			.Nd display and update resource limits database
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Op Fl h			.Op Fl h
	▲ Show 20 Lines • Show All 162 Lines • ▼ Show 20 Lines
	.It Sy msgqsize Ta "SysV message queue size, in bytes"			.It Sy msgqsize Ta "SysV message queue size, in bytes"
	.It Sy nmsgq Ta "number of SysV message queues"			.It Sy nmsgq Ta "number of SysV message queues"
	.It Sy nsem Ta "number of SysV semaphores"			.It Sy nsem Ta "number of SysV semaphores"
	.It Sy nsemop Ta "number of SysV semaphores modified in a single semop(2) call"			.It Sy nsemop Ta "number of SysV semaphores modified in a single semop(2) call"
	.It Sy nshm Ta "number of SysV shared memory segments"			.It Sy nshm Ta "number of SysV shared memory segments"
	.It Sy shmsize Ta "SysV shared memory size, in bytes"			.It Sy shmsize Ta "SysV shared memory size, in bytes"
	.It Sy wallclock Ta "wallclock time, in seconds"			.It Sy wallclock Ta "wallclock time, in seconds"
	.It Sy pcpu Ta "%CPU, in percents of a single CPU core"			.It Sy pcpu Ta "%CPU, in percents of a single CPU core"
				.It Sy readbps Ta "filesystem reads, in bytes per second"
				.It Sy writebps Ta "filesystem writes, in bytes per second"
				.It Sy readiops Ta "filesystem reads, in operations per second"
				.It Sy writeiops Ta "filesystem writes, in operations per second"
	.El			.El
	.Sh ACTIONS			.Sh ACTIONS
	.Bl -column -offset 3n "pseudoterminals"			.Bl -column -offset 3n "pseudoterminals"
	.It Em action			.It Em action
	.It Sy deny Ta deny the allocation; not supported for			.It Sy deny Ta deny the allocation; not supported for
	.Sy cputime			.Sy cputime ,
				.Sy wallclock ,
				.Sy readbps ,
				.Sy writebps ,
				.Sy readiops ,
	and			and
	.Sy wallclock			.Sy writeiops
	.It Sy log Ta "log a warning to the console"			.It Sy log Ta "log a warning to the console"
	.It Sy devctl Ta "send notification to"			.It Sy devctl Ta "send notification to"
	.Xr devd 8			.Xr devd 8
	using			using
	.Sy system			.Sy system
	= "RCTL",			= "RCTL",
	.Sy subsystem			.Sy subsystem
	= "rule",			= "rule",
	.Sy type			.Sy type
	= "matched"			= "matched"
	.It sig* e.g.			.It sig* e.g.
	.Sy sigterm ;			.Sy sigterm ;
	send a signal to the offending process.			send a signal to the offending process.
	See			See
	.Xr signal 3			.Xr signal 3
	for a list of supported signals			for a list of supported signals
				.It Sy throttle Ta "slow down process execution"; only supported for
				.Sy readbps ,
				.Sy writebps ,
				.Sy readiops ,
				and
				.Sy writeiops .
	.El			.El
	.Pp			.Pp
	Not all actions are supported for all resources.			Not all actions are supported for all resources.
	Attempting to add a rule with an action not supported by a given resource will			Attempting to add a rule with an action not supported by a given resource will
	result in error.			result in error.
	.Sh LOADER TUNABLES			.Sh LOADER TUNABLES
	Tunables can be set at the			Tunables can be set at the
	.Xr loader 8			.Xr loader 8
	▲ Show 20 Lines • Show All 43 Lines • ▼ Show 20 Lines
	.Nm			.Nm
	was developed by			was developed by
	.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org			.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
	under sponsorship from the FreeBSD Foundation.			under sponsorship from the FreeBSD Foundation.
	.Sh BUGS			.Sh BUGS
	Limiting			Limiting
	.Sy memoryuse			.Sy memoryuse
	may kill the machine due to thrashing.			may kill the machine due to thrashing.
				.Pp
				The
				.Sy readiops
				and
				.Sy writeiops
				counters are only approximations.
				Like
				.Sy readbps
				and
				.Sy writebps ,
				they are calculated in the filesystem layer, where it is difficult
				or even impossible to observe actual disk device operations.
				.Pp
				The
				.Sy writebps
				and
				.Sy writeiops
				resources generally account for writes to the filesystem cache,
				not to actual devices.