~ubuntu-branches/ubuntu/saucy/numactl/saucy-proposed

.\" Copyright 2003,2004 Andi Kleen, SuSE Labs.

.\"

.\" 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.

.\" 

.\" 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

.\" the use of the information contained herein.  

.\" 

.\" Formatted or processed versions of this manual, if unaccompanied by

.\" the source, must acknowledge the copyright and authors of this work.

.TH GET_MEMPOLICY "2" "Nov 2003" "SuSE Labs" "Linux Programmer's Manual"

.SH SYNOPSIS

get_mempolicy - Retrieve NUMA memory policy for a process

.SH NAME

.B "#include <numaif.h>" 

.sp

.B int get_mempolicy(int *policy, unsigned long *nodemask, unsigned long maxnode, unsigned long addr, unsigned long flags) 

.\" TBD rewrite this. it is confusing.

.SH DESCRIPTION

.B get_mempolicy

retrieves the NUMA policy of the current process or an memory address.

A NUMA machine has different

memory controllers with different distances to specific CPUs.

The memory policy defines in which node memory is allocated for 

the process.   

.I get_mempolicy

gets the memory policy of the current process. The policy is stored into

.I policy

when not zero, with the associated nodemask stored into 

.I nodemask.

.I maxnode 

is the maximum bit number plus one that can be stored into 

.I nodemask.

The bit number is always rounded to an multiple of unsigned long.

 

.\" FIXME

.\" The other valid flag is 

.\" .I MPOL_F_NODE.

.\" It is only valid when the policy is 

.\" .I MPOL_INTERLEAVE.

.\" In this case not the interleave mask, but an unsigned long with the next

.\" node that would be used for interleaving is returned in 

.\" .I nodemask.

 

.\" Other flag values are reserved.

 

For an overview of the possible policies see the

.I set_mempolicy(2)

manpage.

 

.SH RETURN VALUE

.I get_mempolicy

returns -1 when an error occurred, otherwise 0.

 

.\" .SH ERRORS

.\" writeme

 

.SH NOTES

Applications should consider using the higher level functions

in 

.I numa(3)

instead. This library is available in the 

.I numactl

package.

 

This manpage is not documenting some obscure features

that can be enabled using 

.I flags.

 

.SH VERSIONS

The

.I get_mempolicy

syscall was added to the Linux kernel with version

.I 2.6.7rc1.

It is only available on kernels compiled with

.I CONFIG_NUMA.

 

Until glibc supports these system calls you can link with 

.I -lnuma

to get system call definitions. libnuma is available in the numactl

package. It also has the

.I numaif.h

header.

 

.SH SEE ALSO

.I mbind(2),

.I set_mempolicy(2),

.I numactl(8),

.I numa(3)