original/man2/getpagesize.2

   1 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .TH GETPAGESIZE 2 2010-09-20 "Linux" "Linux Programmer's Manual"
  24 .SH NAME
  25 getpagesize \- get memory page size
  26 .SH SYNOPSIS
  27 .B #include <unistd.h>
  28 .sp
  29 .B int getpagesize(void);
  30 .sp
  31 .in -4n
  32 Feature Test Macro Requirements for glibc (see
  33 .BR feature_test_macros (7)):
  34 .in
  35 .sp
  36 .BR getpagesize ():
  37 .ad l
  38 .RS 4
  39 .PD 0
  40 .TP 4
  41 Since glibc 2.12:
  42 .nf
  43 _BSD_SOURCE ||
  44     !(_POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600)
  45 .TP 4
  46 .fi
  47 Before glibc 2.12:
  48 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  49 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  50 .PD
  51 .RE
  52 .ad b
  53 .SH DESCRIPTION
  54 The function
  55 .BR getpagesize ()
  56 returns the number of bytes in a page, where a "page" is the thing
  57 used where it says in the description of
  58 .BR mmap (2)
  59 that files are mapped in page-sized units.
  60
  61 The size of the kind of pages that
  62 .BR mmap (2)
  63 uses, is found using
  64
  65 .in +4n
  66 .nf
  67 #include <unistd.h>
  68 long sz = sysconf(_SC_PAGESIZE);
  69 .fi
  70 .in
  71
  72 (most systems allow the synonym
  73 .B _SC_PAGE_SIZE
  74 for
  75 .BR _SC_PAGESIZE ),
  76 or
  77
  78 .in +4n
  79 .nf
  80 #include <unistd.h>
  81 int sz = getpagesize();
  82 .fi
  83 .in
  84 .\" .SH HISTORY
  85 .\" This call first appeared in 4.2BSD.
  86 .SH CONFORMING TO
  87 SVr4, 4.4BSD, SUSv2.
  88 In SUSv2 the
  89 .BR getpagesize ()
  90 call is labeled LEGACY, and in POSIX.1-2001
  91 it has been dropped;
  92 HP-UX does not have this call.
  93 Portable applications should employ
  94 .I sysconf(_SC_PAGESIZE)
  95 instead of this call.
  96 .SH NOTES
  97 Whether
  98 .BR getpagesize ()
  99 is present as a Linux system call depends on the architecture.
 100 If it is, it returns the kernel symbol
 101 .BR PAGE_SIZE ,
 102 whose value depends on the architecture and machine model.
 103 Generally, one uses binaries that are dependent on the architecture but not
 104 on the machine model, in order to have a single binary
 105 distribution per architecture.
 106 This means that a user program
 107 should not find
 108 .B PAGE_SIZE
 109 at compile time from a header file,
 110 but use an actual system call, at least for those architectures
 111 (like sun4) where this dependency exists.
 112 Here libc4, libc5, glibc 2.0 fail because their
 113 .BR getpagesize ()
 114 returns a statically derived value, and does not use a system call.
 115 Things are OK in glibc 2.1.
 116 .SH "SEE ALSO"
 117 .BR mmap (2),
 118 .BR sysconf (3)