original/man3/malloc_usable_size.3

   1 .\" Copyright (c) 2012 by Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH MALLOC_USABLE_SIZE 3  2014-06-13 "GNU" "Linux Programmer's Manual"
  26 .SH NAME
  27 malloc_usable_size \- obtain size of block of memory allocated from heap
  28 .SH SYNOPSIS
  29 .B #include <malloc.h>
  30
  31 .BI "size_t malloc_usable_size (void *" ptr );
  32 .SH DESCRIPTION
  33 The
  34 .BR malloc_usable_size ()
  35 function returns the number of usable bytes in the block pointed to by
  36 .IR ptr ,
  37 a pointer to a block of memory allocated by
  38 .BR malloc (3)
  39 or a related function.
  40 .SH RETURN VALUE
  41 .BR malloc_usable_size ()
  42 returns the number of usable bytes in
  43 the block of allocated memory pointed to by
  44 .IR ptr .
  45 If
  46 .I ptr
  47 is NULL, 0 is returned.
  48 .SH ATTRIBUTES
  49 .SS Multithreading (see pthreads(7))
  50 The
  51 .BR malloc_usable_size ()
  52 function is thread-safe.
  53 .SH CONFORMING TO
  54 This function is a GNU extension.
  55 .SH NOTES
  56 The value returned by
  57 .BR malloc_usable_size ()
  58 may be greater than the requested size of the allocation because
  59 of alignment and minimum size constraints.
  60 Although the excess bytes can be overwritten by the application
  61 without ill effects,
  62 this is not good programming practice:
  63 the number of excess bytes in an allocation depends on
  64 the underlying implementation.
  65
  66 The main use of this function is for debugging and introspection.
  67 .SH SEE ALSO
  68 .BR malloc (3)
  69 .SH COLOPHON
  70 This page is part of release 3.79 of the Linux
  71 .I man-pages
  72 project.
  73 A description of the project,
  74 information about reporting bugs,
  75 and the latest version of this page,
  76 can be found at
  77 \%http://www.kernel.org/doc/man\-pages/.