Changeset View
Changeset View
Standalone View
Standalone View
lib/libutil/cpuset.3
- This file was added.
Property | Old Value | New Value |
---|---|---|
svn:eol-style | null | native \ No newline at end of property |
svn:keywords | null | FreeBSD=%H \ No newline at end of property |
svn:mime-type | null | text/plain \ No newline at end of property |
.\" Copyright (c) 2017 Baptiste Daroussin <bapt@FreeBSD.org> | |||||
.\" All rights reserved. | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND | |||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE | |||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 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 POSSIBILITY OF | |||||
.\" SUCH DAMAGE. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd October 31, 2017 | |||||
.Dt CPUSET 3 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm cpuset_parselist | |||||
.Nd utility functions for | |||||
.Xr cpuset 2 | |||||
handling | |||||
.Sh LIBRARY | |||||
.Lb libutil | |||||
.Sh SYNOPSIS | |||||
.In sys/cpuset.h | |||||
.In libutil.h | |||||
.Ft int | |||||
.Fn cpuset_parselist "char *cpu-list, cpuset_t **mask" | |||||
jilles: The actual implementation has one asterisk with mask, which matches the below description. | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Fn cpuset_parselist | |||||
function parses a | |||||
.Va cpu-list | |||||
filling the | |||||
.Va mask . | |||||
.Br | |||||
The | |||||
.Va cpu-list | |||||
may include numbers separated by '-' for ranges and commas separating individual | |||||
numbers. A special list of | |||||
bcrUnsubmitted Done Inline ActionsYou need to do a line break after a sentence stop. bcr: You need to do a line break after a sentence stop. | |||||
.Dq all | |||||
may be specified in which case the list includes all CPUs from the root set. | |||||
.Sh RETURN VALUES | |||||
Return values can be the following | |||||
.Bl -tag -width Er | |||||
.It Bq Er CPUSET_PARSE_OK | |||||
jillesUnsubmitted Done Inline ActionsThe Er macro seems meant for errno values only. Perhaps use Dv instead of Bq Er. jilles: The `Er` macro seems meant for errno values only. Perhaps use Dv instead of Bq Er. | |||||
The parsing was succesfull | |||||
bcrUnsubmitted Done Inline Actionss/succesfull/successful/ bcr: s/succesfull/successful/ | |||||
.It Bq Er CPUSET_PARSE_ERROR | |||||
The | |||||
.Va cpu-list | |||||
format is invalid | |||||
.It Bq Er CPUSET_PARSE_GETAFFINITY | |||||
The | |||||
.Xr cpuset_getaffinity 2 | |||||
call has failed | |||||
.It Bq Er CPUSET_PARSE_INVALID_CPU | |||||
The number of supported CPU has been exceeded | |||||
bcrUnsubmitted Done Inline Actionss/CPU/CPUs/ bcr: s/CPU/CPUs/ | |||||
jillesUnsubmitted Done Inline ActionsThis should mention CPU_SETSIZE; otherwise someone may think it is about the number of CPUs in the system. jilles: This should mention `CPU_SETSIZE`; otherwise someone may think it is about the number of CPUs… | |||||
.Sh SEE ALSO | |||||
.Xr cpuset 1 | |||||
.Xr cpuset 2 | |||||
.Xr cpuset 9 | |||||
Not Done Inline ActionsThis sentence is incomplete. It could be spliced to the previous sentence with a comma, or formulated differently. jilles: This sentence is incomplete. It could be spliced to the previous sentence with a comma, or… | |||||
Not Done Inline ActionsThe maximum number of CPUs is .Va CPU_SETSIZE . wblock: ```The maximum number of CPUs is
.Va CPU_SETSIZE .``` | |||||
.Sh AUTHORS | |||||
.An Jeffrey Roberson Aq Mt jeff@FreeBSD.org |
The actual implementation has one asterisk with mask, which matches the below description.