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  2021-03-22 "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 .nf
  30 .B #include <malloc.h>
  31 .PP
  32 .BI "size_t malloc_usable_size(void *" ptr );
  33 .fi
  34 .SH DESCRIPTION
  35 The
  36 .BR malloc_usable_size ()
  37 function returns the number of usable bytes in the block pointed to by
  38 .IR ptr ,
  39 a pointer to a block of memory allocated by
  40 .BR malloc (3)
  41 or a related function.
  42 .SH RETURN VALUE
  43 .BR malloc_usable_size ()
  44 returns the number of usable bytes in
  45 the block of allocated memory pointed to by
  46 .IR ptr .
  47 If
  48 .I ptr
  49 is NULL, 0 is returned.
  50 .SH ATTRIBUTES
  51 For an explanation of the terms used in this section, see
  52 .BR attributes (7).
  53 .ad l
  54 .nh
  55 .TS
  56 allbox;
  57 lbx lb lb
  58 l l l.
  59 Interface       Attribute       Value
  60 T{
  61 .BR malloc_usable_size ()
  62 T}      Thread safety   MT-Safe
  63 .TE
  64 .hy
  65 .ad
  66 .sp 1
  67 .SH CONFORMING TO
  68 This function is a GNU extension.
  69 .SH NOTES
  70 The value returned by
  71 .BR malloc_usable_size ()
  72 may be greater than the requested size of the allocation because
  73 of alignment and minimum size constraints.
  74 Although the excess bytes can be overwritten by the application
  75 without ill effects,
  76 this is not good programming practice:
  77 the number of excess bytes in an allocation depends on
  78 the underlying implementation.
  79 .PP
  80 The main use of this function is for debugging and introspection.
  81 .SH SEE ALSO
  82 .BR malloc (3)