share/man/man9/kmalloc.9

   1 .\"
   2 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Paul Kranenburg.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"        This product includes software developed by the NetBSD
  19 .\"        Foundation, Inc. and its contributors.
  20 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  21 .\"    contributors may be used to endorse or promote products derived
  22 .\"    from this software without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  25 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
  28 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 .\" POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" $NetBSD: malloc.9,v 1.3 1996/11/11 00:05:11 lukem Exp $
  37 .\" $FreeBSD: src/share/man/man9/malloc.9,v 1.42 2005/02/22 17:20:20 brueffer Exp $
  38 .\" $DragonFly: src/share/man/man9/kmalloc.9,v 1.8 2008/01/19 08:23:17 swildner Exp $
  39 .\"
  40 .Dd June 12, 2003
  41 .Dt KMALLOC 9
  42 .Os
  43 .Sh NAME
  44 .Nm kmalloc ,
  45 .Nm MALLOC ,
  46 .Nm kfree ,
  47 .Nm FREE ,
  48 .Nm krealloc ,
  49 .Nm MALLOC_DEFINE ,
  50 .Nm MALLOC_DECLARE
  51 .Nd kernel memory management routines
  52 .Sh SYNOPSIS
  53 .In sys/types.h
  54 .In sys/malloc.h
  55 .Ft void *
  56 .Fn kmalloc "unsigned long size" "struct malloc_type *type" "int flags"
  57 .Fn MALLOC space cast "unsigned long size" "struct malloc_type *type" "int flags"
  58 .Ft void
  59 .Fn kfree "void *addr" "struct malloc_type *type"
  60 .Fn FREE "void *addr" "struct malloc_type *type"
  61 .Ft void *
  62 .Fn krealloc "void *addr" "unsigned long size" "struct malloc_type *type" "int flags"
  63 .Fn MALLOC_DECLARE type
  64 .In sys/param.h
  65 .In sys/malloc.h
  66 .In sys/kernel.h
  67 .Fn MALLOC_DEFINE type shortdesc longdesc
  68 .Sh DESCRIPTION
  69 The
  70 .Fn kmalloc
  71 function allocates uninitialized memory in kernel address space for an
  72 object whose size is specified by
  73 .Fa size .
  74 .Pp
  75 The
  76 .Fn kfree
  77 function releases memory at address
  78 .Fa addr
  79 that was previously allocated by
  80 .Fn kmalloc
  81 for re-use.
  82 The memory is not zeroed.
  83 The kernel implementation of
  84 .Fn kfree
  85 does not allow
  86 .Fa addr
  87 to be
  88 .Dv NULL .
  89 .Pp
  90 The
  91 .Fn krealloc
  92 function changes the size of the previously allocated memory referenced by
  93 .Fa addr
  94 to
  95 .Fa size
  96 bytes.
  97 The contents of the memory are unchanged up to the lesser of the new and
  98 old sizes.
  99 Note that the returned value may differ from
 100 .Fa addr .
 101 If the requested memory cannot be allocated,
 102 .Dv NULL
 103 is returned and the memory referenced by
 104 .Fa addr
 105 is valid and unchanged.
 106 If
 107 .Fa addr
 108 is
 109 .Dv NULL ,
 110 the
 111 .Fn krealloc
 112 function behaves identically to
 113 .Fn kmalloc
 114 for the specified size.
 115 .Pp
 116 The
 117 .Fn MALLOC
 118 macro variant is functionally equivalent to
 119 .Bd -literal -offset indent
 120 (space) = (cast)kmalloc((u_long)(size), type, flags)
 121 .Ed
 122 .Pp
 123 and the
 124 .Fn FREE
 125 macro variant is equivalent to
 126 .Bd -literal -offset indent
 127 kfree((addr), type)
 128 .Ed
 129 .Pp
 130 Unlike its standard C library counterpart
 131 .Pq Xr malloc 3 ,
 132 the kernel version takes two more arguments.
 133 The
 134 .Fa flags
 135 argument further qualifies
 136 .Fn kmalloc Ns 's
 137 operational characteristics as follows:
 138 .Bl -tag -width indent
 139 .It Dv M_ZERO
 140 Causes the allocated memory to be set to all zeros.
 141 .It Dv M_NOWAIT
 142 Causes
 143 .Fn kmalloc
 144 and
 145 .Fn krealloc ,
 146 to return
 147 .Dv NULL
 148 if the request cannot be immediately fulfilled due to resource shortage.
 149 Note that
 150 .Dv M_NOWAIT
 151 is required when running in an interrupt context.
 152 .It Dv M_WAITOK
 153 Indicates that it is OK to wait for resources.
 154 If the request cannot be immediately fulfilled, the current process is put
 155 to sleep to wait for resources to be released by other processes.
 156 The
 157 .Fn kmalloc
 158 and
 159 .Fn krealloc ,
 160 functions cannot return
 161 .Dv NULL
 162 if
 163 .Dv M_WAITOK
 164 is specified.
 165 .It Dv M_USE_RESERVE
 166 Indicates that the system can dig into its reserve in order to obtain the
 167 requested memory.
 168 This option used to be called
 169 .Dv M_KERNEL
 170 but has been renamed to something more obvious.
 171 This option has been deprecated and is slowly being removed from the kernel,
 172 and so should not be used with any new code.
 173 .El
 174 .Pp
 175 Exactly one of either
 176 .Dv M_WAITOK
 177 or
 178 .Dv M_NOWAIT
 179 must be specified.
 180 .Pp
 181 The
 182 .Fa type
 183 argument is used to perform statistics on memory usage, and for
 184 basic sanity checks.
 185 It can be used to identify multiple allocations.
 186 The statistics can be examined by
 187 .Sq vmstat -m .
 188 .Pp
 189 A
 190 .Fa type
 191 is defined using the
 192 .Va malloc_type_t
 193 typedef via the
 194 .Fn MALLOC_DECLARE
 195 and
 196 .Fn MALLOC_DEFINE
 197 macros.
 198 .Bd -literal -offset indent
 199 /* sys/something/foo_extern.h */
 200
 201 MALLOC_DECLARE(M_FOOBUF);
 202
 203 /* sys/something/foo_main.c */
 204
 205 MALLOC_DEFINE(M_FOOBUF, "foobuffers", "Buffers to foo data into the ether");
 206
 207 /* sys/something/foo_subr.c */
 208
 209 \&...
 210 MALLOC(buf, struct foo_buf *, sizeof *buf, M_FOOBUF, M_NOWAIT);
 211
 212 .Ed
 213 .Sh IMPLEMENTATION NOTES
 214 The memory allocator allocates memory in chunks that have size a power
 215 of two for requests up to the size of a page of memory.
 216 For larger requests, one or more pages is allocated.
 217 While it should not be relied upon, this information may be useful for
 218 optimizing the efficiency of memory use.
 219 .Sh RETURN VALUES
 220 The
 221 .Fn kmalloc
 222 and
 223 .Fn krealloc ,
 224 functions return a kernel virtual address that is suitably aligned for
 225 storage of any type of object, or
 226 .Dv NULL
 227 if the request could not be satisfied (implying that
 228 .Dv M_NOWAIT
 229 was set).
 230 .Sh DIAGNOSTICS
 231 A kernel compiled with the
 232 .Dv INVARIANTS
 233 configuration option attempts to detect memory corruption caused by
 234 such things as writing outside the allocated area and imbalanced calls to the
 235 .Fn kmalloc
 236 and
 237 .Fn kfree
 238 functions.
 239 Failing consistency checks will cause a panic or a system console
 240 message.
 241 .Sh SEE ALSO
 242 .Xr vmstat 8 ,
 243 .Xr contigmalloc 9 ,
 244 .Xr vnode 9