MALLOC(9) NetBSD Kernel Manual MALLOC(9) NNAAMMEE mmaalllloocc, ffrreeee - kernel memory allocator SSYYNNOOPPSSIISS _v_o_i_d _* mmaalllloocc(_u_n_s_i_g_n_e_d _l_o_n_g _s_i_z_e, _i_n_t _t_y_p_e, _i_n_t _f_l_a_g_s); MMAALLLLOOCC(_s_p_a_c_e, _c_a_s_t, _u_n_s_i_g_n_e_d _l_o_n_g _s_i_z_e, _i_n_t _t_y_p_e, _i_n_t _f_l_a_g_s); _v_o_i_d ffrreeee(_v_o_i_d _*_a_d_d_r, _i_n_t _t_y_p_e); FFRREEEE(_v_o_i_d _*_a_d_d_r, _i_n_t _t_y_p_e); DDEESSCCRRIIPPTTIIOONN The mmaalllloocc() function allocates uninitialized memory in kernel address space for an object whose size is specified by _s_i_z_e. ffrreeee() releases mem- ory at address _a_d_d_r that was previously allocated by mmaalllloocc() for re-use. The MMAALLLLOOCC() macro variant is functionally equivalent to (space) = (cast)malloc((u_long)(size), type, flags) and the FFRREEEE() macro variant is equivalent to free((caddr_t)(addr), type) Unlike its standard C library counterpart (malloc(3)), the kernel ver- sion takes two more arguments. The _f_l_a_g_s argument further qualifies mmaalllloocc()'s operational charateristics as follows: M_NOWAIT Causes mmaalllloocc() to return NULL if the request cannot be immedi- ately fulfilled due to resource shortage. Otherwise, mmaalllloocc() may call sleep to wait for resources to be released by other pro- cesses. If this flag is not set, mmaalllloocc() will never return NULL. Note that M_WAITOK is conveniently defined to be 0, and hence maybe or'ed into the _f_l_a_g_s argument to indicate that it's Ok to wait for resources. Currently, only one flag is defined. The _t_y_p_e argument broadly identifies the kernel subsystem for which the allocated memory was needed, and is commonly used to maintain statistics about kernel memory usage. The following types are currently defined: M_FREE Should be on free list. M_MBUF Mbuf memory. M_DEVBUF Device driver memory. M_SOCKET Socket structure. M_PCB Protocol control block. M_RTABLE Routing tables. M_HTABLE IMP host tables. M_FTABLE Fragment reassembly header. M_ZOMBIE Zombie proc status M_IFADDR Interface address. M_SOOPTS Socket options. M_SONAME Socket name. M_NAMEI Namei path name buffer. M_GPROF Kernel profiling buffer. M_IOCTLOPS Ioctl data buffer. M_MAPMEM Mapped memory descriptors. M_CRED Credentials. M_PGRP Process group header. M_SESSION Session header. M_IOV Large iov's. M_MOUNT Vfs mount struct. M_FHANDLE Network file handle. M_NFSREQ NFS request header. M_NFSMNT NFS mount structure. M_NFSNODE NFS vnode private part. M_VNODE Dynamically allocated vnodes. M_CACHE Dynamically allocated cache entries. M_DQUOT UFS quota entries. M_UFSMNT UFS mount structure. M_SHM SVID compatible shared memory segments. M_VMMAP VM map structures. M_VMMAPENT VM map entry structures. M_VMOBJ VM object structure. M_VMOBJHASH VM object hash structure. M_VMPMAP VM pmap. M_VMPVENT VM phys-virt mapping entry. M_VMPAGER XXX: VM pager struct. M_VMPGDATA XXX: VM pager private data. M_FILE Open file structure. M_FILEDESC Open file descriptor table. M_LOCKF Byte-range locking structures. M_PROC Proc structures. M_SUBPROC Proc sub-structures. M_SEGMENT Segment for LFS. M_LFSNODE LFS vnode private part. M_FFSNODE FFS vnode private part. M_MFSNODE MFS vnode private part. M_NQLEASE Nqnfs lease. M_NQMHOST Nqnfs host address table. M_NETADDR Export host address structure. M_NFSSVC Nfs server structure. M_NFSUID Nfs uid mapping structure. M_NFSD Nfs server daemon structure. M_IPMOPTS Internet multicast options. M_IPMADDR Internet multicast address. M_IFMADDR Link-level multicast address. M_MRTABLE Multicast routing tables. M_ISOFSMNT ISOFS mount structure. M_ISOFSNODE ISOFS vnode private part. M_MSDOSFSMNT MSDOS FS mount structure. M_MSDOSFSFAT MSDOS FS fat table. M_MSDOSFSNODE MSDOS FS vnode private part. M_TTYS Allocated tty structures. M_EXEC Argument lists & other mem used by exec. M_MISCFSMNT Miscfs mount structures. M_MISCFSNODE Miscfs vnode private part. M_ADOSFSMNT Adosfs mount structures. M_ADOSFSNODE Adosfs vnode private part. M_ANODE Adosfs anode structures and tables. M_IPQ IP packet queue entry. M_AFS Andrew File System. M_ADOSFSBITMAP Adosfs bitmap. M_NFSSRVDESC NFS server descriptor. M_DIROFF NFS directory cookies. M_NFSBIGFH NFS big filehandle. M_EXT2FSNODE EXT2FS vnode private part. M_VMSWAP VM swap structures. M_TEMP Misc temporary data buffers. Statistics based on the _t_y_p_e argument is maintained only if the kernel option KMEMSTATS is used when compiling the kernel (the default in currentNetBSD kernels) and can be examined by using `vmstat -m'. RREETTUURRNN VVAALLUUEESS mmaalllloocc() returns a kernel virtual address that is suitably aligned for storage of any type of object. SSEEEE AALLSSOO vmstat(8) DDIIAAGGNNOOSSTTIICCSS A kernel compiled with the DIAGNOSTIC configuration option attempts to detect detect memory corruption caused by such things as writing outside the allocated area and imbalanced calls to the mmaalllloocc() and ffrreeee() func- tions. Failing consistency checks will cause a panic or a system console message: ++oo panic: ``malloc - bogus type'' ++oo panic: ``malloc: out of space in kmem_map'' ++oo panic: ``malloc: allocation too large'' ++oo panic: ``malloc: wrong bucket'' ++oo panic: ``malloc: lost data'' ++oo panic: ``free: unaligned addr'' ++oo panic: ``free: duplicated free'' ++oo panic: ``free: multiple frees'' ++oo panic: ``init: minbucket too small/struct freelist too big'' ++oo ``multiply freed item '' ++oo ``Data modified on freelist: '' NetBSD Jun 16, 1996 3