2006-02-08 03:20:44 +00:00
|
|
|
.\" Copyright 2003,2004 Andi Kleen, SuSE Labs.
|
2007-08-27 11:01:24 +00:00
|
|
|
.\" and Copyright 2007 Lee Schermerhorn, Hewlett Packard
|
2006-02-08 03:20:44 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-02-08 03:20:44 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
2007-04-12 22:42:49 +00:00
|
|
|
.\" the use of the information contained herein.
|
|
|
|
.\"
|
2006-02-08 03:20:44 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-02-08 03:20:44 +00:00
|
|
|
.\" 2006-02-03, mtk, substantial wording changes and other improvements
|
2007-08-27 10:48:50 +00:00
|
|
|
.\" 2007-08-27, Lee Schermerhorn <Lee.Schermerhorn@hp.com>
|
|
|
|
.\" more precise specification of behavior.
|
2006-02-08 03:20:44 +00:00
|
|
|
.\"
|
2008-08-13 08:15:51 +00:00
|
|
|
.TH MBIND 2 2008-08-15 Linux "Linux Programmer's Manual"
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH NAME
|
|
|
|
mbind \- Set memory policy for a memory range
|
|
|
|
.SH SYNOPSIS
|
2007-04-03 14:04:54 +00:00
|
|
|
.nf
|
2006-02-08 03:20:44 +00:00
|
|
|
.B "#include <numaif.h>"
|
|
|
|
.sp
|
2008-04-21 07:51:17 +00:00
|
|
|
.BI "int mbind(void *" addr ", unsigned long " len ", int " mode ,
|
2007-04-12 22:42:49 +00:00
|
|
|
.BI " unsigned long *" nodemask ", unsigned long " maxnode ,
|
2007-04-03 14:04:54 +00:00
|
|
|
.BI " unsigned " flags );
|
2006-02-08 03:20:44 +00:00
|
|
|
.sp
|
2009-02-23 18:40:41 +00:00
|
|
|
Link with \fI\-lnuma\fP.
|
2007-04-03 14:04:54 +00:00
|
|
|
.fi
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR mbind ()
|
2007-08-27 10:48:50 +00:00
|
|
|
sets the NUMA memory policy,
|
|
|
|
which consists of a policy mode and zero or more nodes,
|
2006-02-08 03:20:44 +00:00
|
|
|
for the memory range starting with
|
2008-04-21 07:51:17 +00:00
|
|
|
.I addr
|
2006-02-08 03:20:44 +00:00
|
|
|
and continuing for
|
2007-09-20 16:26:31 +00:00
|
|
|
.I len
|
2007-04-12 22:42:49 +00:00
|
|
|
bytes.
|
2007-08-27 10:48:50 +00:00
|
|
|
The memory policy defines from which node memory is allocated.
|
|
|
|
|
|
|
|
If the memory range specified by the
|
2008-04-21 07:51:17 +00:00
|
|
|
.IR addr " and " len
|
2007-08-27 10:48:50 +00:00
|
|
|
arguments includes an "anonymous" region of memory\(emthat is
|
|
|
|
a region of memory created using the
|
|
|
|
.BR mmap (2)
|
|
|
|
system call with the
|
|
|
|
.BR MAP_ANONYMOUS \(emor
|
|
|
|
a memory mapped file, mapped using the
|
|
|
|
.BR mmap (2)
|
|
|
|
system call with the
|
|
|
|
.B MAP_PRIVATE
|
|
|
|
flag, pages will only be allocated according to the specified
|
|
|
|
policy when the application writes [stores] to the page.
|
|
|
|
For anonymous regions, an initial read access will use a shared
|
|
|
|
page in the kernel containing all zeros.
|
|
|
|
For a file mapped with
|
|
|
|
.BR MAP_PRIVATE ,
|
|
|
|
an initial read access will allocate pages according to the
|
|
|
|
process policy of the process that causes the page to be allocated.
|
|
|
|
This may not be the process that called
|
|
|
|
.BR mbind ().
|
|
|
|
|
|
|
|
The specified policy will be ignored for any
|
|
|
|
.B MAP_SHARED
|
|
|
|
mappings in the specified memory range.
|
|
|
|
Rather the pages will be allocated according to the process policy
|
|
|
|
of the process that caused the page to be allocated.
|
|
|
|
Again, this may not be the process that called
|
|
|
|
.BR mbind ().
|
|
|
|
|
|
|
|
If the specified memory range includes a shared memory region
|
|
|
|
created using the
|
|
|
|
.BR shmget (2)
|
|
|
|
system call and attached using the
|
|
|
|
.BR shmat (2)
|
|
|
|
system call,
|
|
|
|
pages allocated for the anonymous or shared memory region will
|
|
|
|
be allocated according to the policy specified, regardless which
|
|
|
|
process attached to the shared memory segment causes the allocation.
|
|
|
|
If, however, the shared memory region was created with the
|
|
|
|
.B SHM_HUGETLB
|
|
|
|
flag,
|
|
|
|
the huge pages will be allocated according to the policy specified
|
2008-08-11 09:00:23 +00:00
|
|
|
only if the page allocation is caused by the process that calls
|
2007-08-27 10:48:50 +00:00
|
|
|
.BR mbind ()
|
|
|
|
for that region.
|
|
|
|
|
|
|
|
By default,
|
2006-02-08 03:20:44 +00:00
|
|
|
.BR mbind ()
|
2007-04-12 22:42:49 +00:00
|
|
|
only has an effect for new allocations; if the pages inside
|
2006-02-08 03:20:44 +00:00
|
|
|
the range have been already touched before setting the policy,
|
|
|
|
then the policy has no effect.
|
2007-08-27 10:48:50 +00:00
|
|
|
This default behavior may be overridden by the
|
2007-09-20 16:26:31 +00:00
|
|
|
.B MPOL_MF_MOVE
|
2007-08-27 10:48:50 +00:00
|
|
|
and
|
|
|
|
.B MPOL_MF_MOVE_ALL
|
|
|
|
flags described below.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
2007-08-27 10:48:50 +00:00
|
|
|
The
|
|
|
|
.I mode
|
|
|
|
argument must specify one of
|
2006-02-08 03:20:44 +00:00
|
|
|
.BR MPOL_DEFAULT ,
|
|
|
|
.BR MPOL_BIND ,
|
2007-08-27 10:48:50 +00:00
|
|
|
.B MPOL_INTERLEAVE
|
|
|
|
or
|
2006-02-08 03:20:44 +00:00
|
|
|
.BR MPOL_PREFERRED .
|
2007-08-27 10:48:50 +00:00
|
|
|
All policy modes except
|
2006-02-08 03:20:44 +00:00
|
|
|
.B MPOL_DEFAULT
|
2007-08-27 10:48:50 +00:00
|
|
|
require the caller to specify via the
|
2007-04-12 22:42:49 +00:00
|
|
|
.I nodemask
|
2008-07-10 20:53:08 +00:00
|
|
|
argument,
|
2007-08-27 10:48:50 +00:00
|
|
|
the node or nodes to which the mode applies.
|
|
|
|
|
2008-08-11 05:27:30 +00:00
|
|
|
The
|
|
|
|
.I mode
|
|
|
|
argument may also include an optional
|
|
|
|
.IR "mode flag ".
|
|
|
|
The supported
|
|
|
|
.I "mode flags"
|
|
|
|
are:
|
|
|
|
.TP
|
|
|
|
.BR MPOL_F_STATIC_NODES " (since Linux-2.6.26)"
|
mbind.2, rename.2, sched_setscheduler.2, set_mempolicy.2, syslog.2, argz_add.3, dlopen.3, scanf.3, strtod.3, strtok.3, tcgetpgrp.3, hd.4, cpuset.7, regex.7, ld.so.8: Global fix: s/non-empty/nonempty/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:41:47 +00:00
|
|
|
A nonempty
|
2008-08-11 05:27:30 +00:00
|
|
|
.I nodemask
|
|
|
|
specifies physical node ids.
|
2008-09-29 09:09:52 +00:00
|
|
|
Linux does not remap the
|
2008-08-11 05:27:30 +00:00
|
|
|
.I nodemask
|
2008-08-11 09:00:23 +00:00
|
|
|
when the process moves to a different cpuset context,
|
|
|
|
nor when the set of nodes allowed by the process's
|
2008-08-11 05:27:30 +00:00
|
|
|
current cpuset context changes.
|
|
|
|
.TP
|
|
|
|
.BR MPOL_F_RELATIVE_NODES " (since Linux-2.6.26)"
|
mbind.2, rename.2, sched_setscheduler.2, set_mempolicy.2, syslog.2, argz_add.3, dlopen.3, scanf.3, strtod.3, strtok.3, tcgetpgrp.3, hd.4, cpuset.7, regex.7, ld.so.8: Global fix: s/non-empty/nonempty/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:41:47 +00:00
|
|
|
A nonempty
|
2008-08-11 05:27:30 +00:00
|
|
|
.I nodemask
|
|
|
|
specifies node ids that are relative to the set of
|
clock_getres.2, clone.2, mbind.2, set_mempolicy.2, atan2.3, getipnodebyname.3, ilogb.3, lgamma.3, elf.5, capabilities.7, math_error.7: srcfix: Remove double space
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2011-09-27 03:17:10 +00:00
|
|
|
node ids allowed by the process's current cpuset.
|
2008-08-11 05:27:30 +00:00
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
.I nodemask
|
2007-08-27 10:48:50 +00:00
|
|
|
points to a bitmask of nodes containing up to
|
2006-02-08 03:20:44 +00:00
|
|
|
.I maxnode
|
|
|
|
bits.
|
2007-08-27 10:48:50 +00:00
|
|
|
The bit mask size is rounded to the next multiple of
|
2006-02-08 03:20:44 +00:00
|
|
|
.IR "sizeof(unsigned long)" ,
|
|
|
|
but the kernel will only use bits up to
|
|
|
|
.IR maxnode .
|
2007-08-27 10:48:50 +00:00
|
|
|
A NULL value of
|
|
|
|
.I nodemask
|
|
|
|
or a
|
|
|
|
.I maxnode
|
|
|
|
value of zero specifies the empty set of nodes.
|
|
|
|
If the value of
|
|
|
|
.I maxnode
|
|
|
|
is zero,
|
|
|
|
the
|
|
|
|
.I nodemask
|
|
|
|
argument is ignored.
|
2008-08-08 15:22:56 +00:00
|
|
|
Where a
|
|
|
|
.I nodemask
|
|
|
|
is required, it must contain at least one node that is on-line,
|
2008-08-11 05:27:30 +00:00
|
|
|
allowed by the process's current cpuset context
|
|
|
|
[unless the
|
|
|
|
.B MPOL_F_STATIC_NODES
|
|
|
|
mode flag is specified],
|
2008-08-08 15:22:56 +00:00
|
|
|
and contains memory.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2006-02-08 03:20:44 +00:00
|
|
|
.B MPOL_DEFAULT
|
accept.2, access.2, acct.2, clock_nanosleep.2, mbind.2, mincore.2, remap_file_pages.2, sched_setscheduler.2, set_mempolicy.2, splice.2, stat.2, syslog.2, timer_create.2, timerfd_create.2, truncate.2, fenv.3, ferror.3, fflush.3, fgetwc.3, fgetws.3, flockfile.3, fputwc.3, fputws.3, fread.3, getopt.3, gets.3, getwchar.3, glob.3, iconv.3, longjmp.3, pow.3, printf.3, puts.3, putwchar.3, regex.3, rpc.3, scanf.3, setjmp.3, termios.3, unlocked_stdio.3, wcswidth.3, hd.4, rtc.4, st.4, core.5, dir_colors.5, elf.5, proc.5, arp.7, ascii.7, boot.7, bootparam.7, charsets.7, futex.7, ip.7, iso_8859-11.7, man-pages.7, man.7, mdoc.samples.7, path_resolution.7, pipe.7, posixoptions.7, unicode.7, unix.7, uri.7, utf-8.7, ld.so.8: s/non-/non/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:20:12 +00:00
|
|
|
mode requests that any nondefault policy be removed,
|
2008-08-11 05:31:24 +00:00
|
|
|
restoring default behavior.
|
2007-08-27 10:48:50 +00:00
|
|
|
When applied to a range of memory via
|
2007-12-20 12:44:59 +00:00
|
|
|
.BR mbind (),
|
2007-08-27 10:48:50 +00:00
|
|
|
this means to use the process policy,
|
2007-09-18 18:43:25 +00:00
|
|
|
which may have been set with
|
2007-08-27 10:48:50 +00:00
|
|
|
.BR set_mempolicy (2).
|
|
|
|
If the mode of the process policy is also
|
|
|
|
.BR MPOL_DEFAULT ,
|
|
|
|
the system-wide default policy will be used.
|
2008-08-11 05:31:24 +00:00
|
|
|
The system-wide default policy allocates
|
2007-08-27 10:48:50 +00:00
|
|
|
pages on the node of the CPU that triggers the allocation.
|
|
|
|
For
|
|
|
|
.BR MPOL_DEFAULT ,
|
|
|
|
the
|
2007-04-12 22:42:49 +00:00
|
|
|
.I nodemask
|
2007-08-27 10:48:50 +00:00
|
|
|
and
|
|
|
|
.I maxnode
|
|
|
|
arguments must be specify the empty set of nodes.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
|
|
|
The
|
|
|
|
.B MPOL_BIND
|
2007-08-27 10:48:50 +00:00
|
|
|
mode specifies a strict policy that restricts memory allocation to
|
|
|
|
the nodes specified in
|
|
|
|
.IR nodemask .
|
|
|
|
If
|
|
|
|
.I nodemask
|
|
|
|
specifies more than one node, page allocations will come from
|
2007-08-27 11:34:07 +00:00
|
|
|
the node with the lowest numeric node ID first, until that node
|
2007-08-27 10:48:50 +00:00
|
|
|
contains no free memory.
|
|
|
|
Allocations will then come from the node with the next highest
|
2007-08-27 11:34:07 +00:00
|
|
|
node ID specified in
|
2007-08-27 10:48:50 +00:00
|
|
|
.I nodemask
|
|
|
|
and so forth, until none of the specified nodes contain free memory.
|
|
|
|
Pages will not be allocated from any node not specified in the
|
2006-02-08 03:20:44 +00:00
|
|
|
.IR nodemask .
|
|
|
|
|
2007-08-27 10:48:50 +00:00
|
|
|
The
|
2006-02-08 03:20:44 +00:00
|
|
|
.B MPOL_INTERLEAVE
|
2007-08-27 10:48:50 +00:00
|
|
|
mode specifies that page allocations be interleaved across the
|
|
|
|
set of nodes specified in
|
2006-02-08 03:20:44 +00:00
|
|
|
.IR nodemask .
|
2007-08-27 10:48:50 +00:00
|
|
|
This optimizes for bandwidth instead of latency
|
|
|
|
by spreading out pages and memory accesses to those pages across
|
|
|
|
multiple nodes.
|
2007-04-12 22:42:49 +00:00
|
|
|
To be effective the memory area should be fairly large,
|
2007-08-27 10:48:50 +00:00
|
|
|
at least 1MB or bigger with a fairly uniform access pattern.
|
|
|
|
Accesses to a single page of the area will still be limited to
|
|
|
|
the memory bandwidth of a single node.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
|
|
|
.B MPOL_PREFERRED
|
2007-04-12 22:42:49 +00:00
|
|
|
sets the preferred node for allocation.
|
2007-08-27 10:48:50 +00:00
|
|
|
The kernel will try to allocate pages from this
|
2007-04-12 22:42:49 +00:00
|
|
|
node first and fall back to other nodes if the
|
|
|
|
preferred nodes is low on free memory.
|
2007-08-27 10:48:50 +00:00
|
|
|
If
|
2007-04-12 22:42:49 +00:00
|
|
|
.I nodemask
|
2007-08-27 11:34:07 +00:00
|
|
|
specifies more than one node ID, the first node in the
|
2007-08-27 10:48:50 +00:00
|
|
|
mask will be selected as the preferred node.
|
|
|
|
If the
|
|
|
|
.I nodemask
|
|
|
|
and
|
|
|
|
.I maxnode
|
|
|
|
arguments specify the empty set, then the memory is allocated on
|
|
|
|
the node of the CPU that triggered the allocation.
|
|
|
|
This is the only way to specify "local allocation" for a
|
|
|
|
range of memory via
|
2007-12-20 12:44:59 +00:00
|
|
|
.BR mbind ().
|
2006-02-08 03:20:44 +00:00
|
|
|
|
|
|
|
If
|
|
|
|
.B MPOL_MF_STRICT
|
2007-04-12 22:42:49 +00:00
|
|
|
is passed in
|
2007-09-20 16:26:31 +00:00
|
|
|
.I flags
|
2006-02-08 03:20:44 +00:00
|
|
|
and
|
2010-10-19 10:38:12 +00:00
|
|
|
.I mode
|
2006-02-08 03:20:44 +00:00
|
|
|
is not
|
|
|
|
.BR MPOL_DEFAULT ,
|
|
|
|
then the call will fail with the error
|
|
|
|
.B EIO
|
2007-08-27 10:48:50 +00:00
|
|
|
if the existing pages in the memory range don't follow the policy.
|
2007-08-27 11:34:07 +00:00
|
|
|
.\" According to the kernel code, the following is not true
|
|
|
|
.\" --Lee Schermerhorn
|
2007-08-27 10:48:50 +00:00
|
|
|
.\" In 2.6.16 or later the kernel will also try to move pages
|
|
|
|
.\" to the requested node with this flag.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
2006-03-15 10:26:29 +00:00
|
|
|
If
|
2007-04-12 22:42:49 +00:00
|
|
|
.B MPOL_MF_MOVE
|
2007-08-27 10:48:50 +00:00
|
|
|
is specified in
|
2006-03-15 10:26:29 +00:00
|
|
|
.IR flags ,
|
2007-08-27 10:48:50 +00:00
|
|
|
then the kernel will attempt to move all the existing pages
|
|
|
|
in the memory range so that they follow the policy.
|
|
|
|
Pages that are shared with other processes will not be moved.
|
2007-04-12 22:42:49 +00:00
|
|
|
If
|
2006-03-15 10:26:29 +00:00
|
|
|
.B MPOL_MF_STRICT
|
|
|
|
is also specified, then the call will fail with the error
|
2007-04-12 22:42:49 +00:00
|
|
|
.B EIO
|
2006-03-15 10:26:29 +00:00
|
|
|
if some pages could not be moved.
|
|
|
|
|
|
|
|
If
|
2007-04-12 22:42:49 +00:00
|
|
|
.B MPOL_MF_MOVE_ALL
|
|
|
|
is passed in
|
|
|
|
.IR flags ,
|
2007-08-27 10:48:50 +00:00
|
|
|
then the kernel will attempt to move all existing pages in the memory range
|
|
|
|
regardless of whether other processes use the pages.
|
2006-03-15 10:26:29 +00:00
|
|
|
The calling process must be privileged
|
2006-03-21 20:56:33 +00:00
|
|
|
.RB ( CAP_SYS_NICE )
|
2006-03-15 10:26:29 +00:00
|
|
|
to use this flag.
|
2007-04-12 22:42:49 +00:00
|
|
|
If
|
2006-03-15 10:26:29 +00:00
|
|
|
.B MPOL_MF_STRICT
|
|
|
|
is also specified, then the call will fail with the error
|
2007-04-12 22:42:49 +00:00
|
|
|
.B EIO
|
2006-03-15 10:26:29 +00:00
|
|
|
if some pages could not be moved.
|
2007-08-27 10:48:50 +00:00
|
|
|
.\" ---------------------------------------------------------------
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
On success,
|
|
|
|
.BR mbind ()
|
|
|
|
returns 0;
|
|
|
|
on error, \-1 is returned and
|
2007-04-12 22:42:49 +00:00
|
|
|
.I errno
|
2006-02-08 03:20:44 +00:00
|
|
|
is set to indicate the error.
|
2007-08-27 10:48:50 +00:00
|
|
|
.\" ---------------------------------------------------------------
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH ERRORS
|
2007-08-27 11:34:07 +00:00
|
|
|
.\" I think I got all of the error returns. --Lee Schermerhorn
|
2007-04-12 22:42:49 +00:00
|
|
|
.TP
|
2007-10-23 06:15:48 +00:00
|
|
|
.B EFAULT
|
2008-08-13 08:15:51 +00:00
|
|
|
Part or all of the memory range specified by
|
2007-10-23 06:15:48 +00:00
|
|
|
.I nodemask
|
|
|
|
and
|
|
|
|
.I maxnode
|
|
|
|
points outside your accessible address space.
|
2007-12-29 17:42:38 +00:00
|
|
|
Or, there was an unmapped hole in the specified memory range.
|
2007-10-23 06:15:48 +00:00
|
|
|
.TP
|
2006-02-08 03:20:44 +00:00
|
|
|
.B EINVAL
|
|
|
|
An invalid value was specified for
|
|
|
|
.I flags
|
|
|
|
or
|
|
|
|
.IR mode ;
|
2007-04-12 22:42:49 +00:00
|
|
|
or
|
2008-04-21 07:51:17 +00:00
|
|
|
.I addr + len
|
2007-04-12 22:42:49 +00:00
|
|
|
was less than
|
2008-04-21 07:51:17 +00:00
|
|
|
.IR addr ;
|
2006-02-08 03:20:44 +00:00
|
|
|
or
|
2008-04-21 07:51:17 +00:00
|
|
|
.I addr
|
2007-08-27 10:48:50 +00:00
|
|
|
is not a multiple of the system page size.
|
|
|
|
Or,
|
|
|
|
.I mode
|
|
|
|
is
|
2007-08-27 11:34:07 +00:00
|
|
|
.B MPOL_DEFAULT
|
2006-02-08 03:20:44 +00:00
|
|
|
and
|
|
|
|
.I nodemask
|
mbind.2, rename.2, sched_setscheduler.2, set_mempolicy.2, syslog.2, argz_add.3, dlopen.3, scanf.3, strtod.3, strtok.3, tcgetpgrp.3, hd.4, cpuset.7, regex.7, ld.so.8: Global fix: s/non-empty/nonempty/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:41:47 +00:00
|
|
|
specified a nonempty set;
|
2006-02-08 03:20:44 +00:00
|
|
|
or
|
2007-08-27 10:48:50 +00:00
|
|
|
.I mode
|
|
|
|
is
|
2007-08-27 11:34:07 +00:00
|
|
|
.B MPOL_BIND
|
2006-02-08 03:20:44 +00:00
|
|
|
or
|
2007-08-27 11:34:07 +00:00
|
|
|
.B MPOL_INTERLEAVE
|
2006-02-08 03:20:44 +00:00
|
|
|
and
|
|
|
|
.I nodemask
|
2007-08-27 10:48:50 +00:00
|
|
|
is empty.
|
|
|
|
Or,
|
|
|
|
.I maxnode
|
2008-08-08 15:22:56 +00:00
|
|
|
exceeds a kernel-imposed limit.
|
2007-12-23 21:40:51 +00:00
|
|
|
.\" As at 2.6.23, this limit is "a page worth of bits", e.g.,
|
|
|
|
.\" 8 * 4096 bits, assuming a 4kB page size.
|
2007-08-27 10:48:50 +00:00
|
|
|
Or,
|
|
|
|
.I nodemask
|
2007-08-27 11:34:07 +00:00
|
|
|
specifies one or more node IDs that are
|
2008-08-08 15:22:56 +00:00
|
|
|
greater than the maximum supported node ID.
|
2007-08-27 11:34:07 +00:00
|
|
|
Or, none of the node IDs specified by
|
2007-08-27 10:48:50 +00:00
|
|
|
.I nodemask
|
2008-08-08 15:22:56 +00:00
|
|
|
are on-line and allowed by the process's current cpuset context,
|
|
|
|
or none of the specified nodes contain memory.
|
2008-08-11 05:27:30 +00:00
|
|
|
Or, the
|
|
|
|
.I mode
|
|
|
|
argument specified both
|
|
|
|
.B MPOL_F_STATIC_NODES
|
|
|
|
and
|
|
|
|
.BR MPOL_F_RELATIVE_NODES .
|
2007-08-27 10:48:50 +00:00
|
|
|
.TP
|
2007-04-12 22:42:49 +00:00
|
|
|
.B EIO
|
2006-02-08 03:20:44 +00:00
|
|
|
.B MPOL_MF_STRICT
|
2007-04-12 22:42:49 +00:00
|
|
|
was specified and an existing page was already on a node
|
2007-08-27 10:48:50 +00:00
|
|
|
that does not follow the policy;
|
|
|
|
or
|
|
|
|
.B MPOL_MF_MOVE
|
|
|
|
or
|
|
|
|
.B MPOL_MF_MOVE_ALL
|
|
|
|
was specified and the kernel was unable to move all existing
|
|
|
|
pages in the range.
|
2007-08-27 07:56:52 +00:00
|
|
|
.TP
|
|
|
|
.B ENOMEM
|
2007-08-27 10:48:50 +00:00
|
|
|
Insufficient kernel memory was available.
|
|
|
|
.TP
|
|
|
|
.B EPERM
|
|
|
|
The
|
|
|
|
.I flags
|
|
|
|
argument included the
|
|
|
|
.B MPOL_MF_MOVE_ALL
|
|
|
|
flag and the caller does not have the
|
|
|
|
.B CAP_SYS_NICE
|
|
|
|
privilege.
|
|
|
|
.\" ---------------------------------------------------------------
|
2008-08-13 08:15:51 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
The
|
2009-09-27 07:26:28 +00:00
|
|
|
.BR mbind ()
|
2008-08-13 08:15:51 +00:00
|
|
|
system call was added to the Linux kernel in version 2.6.7.
|
2007-11-24 10:15:53 +00:00
|
|
|
.SH CONFORMING TO
|
2007-12-25 21:28:09 +00:00
|
|
|
This system call is Linux-specific.
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH NOTES
|
2008-08-13 08:15:51 +00:00
|
|
|
For information on library support, see
|
|
|
|
.BR numa (7).
|
|
|
|
|
2007-08-27 10:48:50 +00:00
|
|
|
NUMA policy is not supported on a memory mapped file range
|
|
|
|
that was mapped with the
|
2007-08-27 11:34:07 +00:00
|
|
|
.B MAP_SHARED
|
2007-08-27 10:48:50 +00:00
|
|
|
flag.
|
2006-02-08 03:20:44 +00:00
|
|
|
|
2007-08-27 10:48:50 +00:00
|
|
|
The
|
2008-09-29 09:00:36 +00:00
|
|
|
.B MPOL_DEFAULT
|
2008-08-11 05:31:24 +00:00
|
|
|
mode can have different effects for
|
2007-11-24 10:10:39 +00:00
|
|
|
.BR mbind ()
|
2006-02-08 03:20:44 +00:00
|
|
|
and
|
|
|
|
.BR set_mempolicy (2).
|
2007-08-27 10:48:50 +00:00
|
|
|
When
|
|
|
|
.B MPOL_DEFAULT
|
2008-08-11 05:31:24 +00:00
|
|
|
is specified for
|
|
|
|
.BR set_mempolicy (2),
|
2008-08-11 09:01:40 +00:00
|
|
|
the process's policy reverts to system default policy
|
2008-08-11 05:31:24 +00:00
|
|
|
or local allocation.
|
|
|
|
When
|
|
|
|
.B MPOL_DEFAULT
|
2007-08-27 10:48:50 +00:00
|
|
|
is specified for a range of memory using
|
2006-02-08 03:20:44 +00:00
|
|
|
.BR mbind (),
|
2007-08-27 10:48:50 +00:00
|
|
|
any pages subsequently allocated for that range will use
|
2007-08-27 11:34:07 +00:00
|
|
|
the process's policy, as set by
|
2007-08-27 10:48:50 +00:00
|
|
|
.BR set_mempolicy (2).
|
|
|
|
This effectively removes the explicit policy from the
|
accept.2, access.2, acct.2, clock_nanosleep.2, mbind.2, mincore.2, remap_file_pages.2, sched_setscheduler.2, set_mempolicy.2, splice.2, stat.2, syslog.2, timer_create.2, timerfd_create.2, truncate.2, fenv.3, ferror.3, fflush.3, fgetwc.3, fgetws.3, flockfile.3, fputwc.3, fputws.3, fread.3, getopt.3, gets.3, getwchar.3, glob.3, iconv.3, longjmp.3, pow.3, printf.3, puts.3, putwchar.3, regex.3, rpc.3, scanf.3, setjmp.3, termios.3, unlocked_stdio.3, wcswidth.3, hd.4, rtc.4, st.4, core.5, dir_colors.5, elf.5, proc.5, arp.7, ascii.7, boot.7, bootparam.7, charsets.7, futex.7, ip.7, iso_8859-11.7, man-pages.7, man.7, mdoc.samples.7, path_resolution.7, pipe.7, posixoptions.7, unicode.7, unix.7, uri.7, utf-8.7, ld.so.8: s/non-/non/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:20:12 +00:00
|
|
|
specified range, "falling back" to a possibly nondefault
|
2008-08-11 05:31:24 +00:00
|
|
|
policy.
|
|
|
|
To select explicit "local allocation" for a memory range,
|
2007-04-12 22:42:49 +00:00
|
|
|
specify a
|
2007-08-27 10:48:50 +00:00
|
|
|
.I mode
|
2007-04-12 22:42:49 +00:00
|
|
|
of
|
2006-02-08 03:20:44 +00:00
|
|
|
.B MPOL_PREFERRED
|
2007-08-27 10:48:50 +00:00
|
|
|
with an empty set of nodes.
|
|
|
|
This method will work for
|
|
|
|
.BR set_mempolicy (2),
|
|
|
|
as well.
|
|
|
|
|
|
|
|
Support for huge page policy was added with 2.6.16.
|
|
|
|
For interleave policy to be effective on huge page mappings the
|
|
|
|
policied memory needs to be tens of megabytes or larger.
|
|
|
|
|
2008-08-13 08:15:51 +00:00
|
|
|
.B MPOL_MF_STRICT
|
|
|
|
is ignored on huge page mappings.
|
|
|
|
|
2007-08-27 10:48:50 +00:00
|
|
|
.B MPOL_MF_MOVE
|
|
|
|
and
|
|
|
|
.B MPOL_MF_MOVE_ALL
|
|
|
|
are only available on Linux 2.6.16 and later.
|
2006-02-08 03:20:44 +00:00
|
|
|
.SH SEE ALSO
|
2007-04-12 22:42:49 +00:00
|
|
|
.BR get_mempolicy (2),
|
2008-07-03 12:20:42 +00:00
|
|
|
.BR getcpu (2),
|
2007-08-27 10:48:50 +00:00
|
|
|
.BR mmap (2),
|
|
|
|
.BR set_mempolicy (2),
|
|
|
|
.BR shmat (2),
|
|
|
|
.BR shmget (2),
|
|
|
|
.BR numa (3),
|
2008-06-17 08:32:41 +00:00
|
|
|
.BR cpuset (7),
|
2008-08-13 08:15:51 +00:00
|
|
|
.BR numa (7),
|
2007-08-27 10:48:50 +00:00
|
|
|
.BR numactl (8)
|