d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

malloc(9): Document/complete aligned variants

Browse Source 
Comments on a pending kvmclock driver suggested adding a
malloc_aligned() to complement malloc_domainset_aligned(); add it now,
and document both.

Reviewed by:	imp, kib, allanjude (manpages)
Differential Revision:	https://reviews.freebsd.org/D31004
This commit is contained in:
Adam Fenn 2021-08-02 15:33:31 -05:00 committed by Kyle Evans
parent 428624130a
commit 6162cf885c
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
share/man/man9/malloc.9
View File

@ -29,7 +29,7 @@
.\" $NetBSD: malloc.9,v 1.3 1996/11/11 00:05:11 lukem Exp $ .\" $NetBSD: malloc.9,v 1.3 1996/11/11 00:05:11 lukem Exp $
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd March 6, 2021 .Dd July 2, 2021
.Dt MALLOC 9 .Dt MALLOC 9
.Os .Os
.Sh NAME .Sh NAME
@ -58,6 +58,13 @@
.Ft size_t .Ft size_t
.Fn malloc_usable_size "const void *addr" .Fn malloc_usable_size "const void *addr"
.Ft void * .Ft void *
.Fo malloc_aligned
.Fa "size_t size"
.Fa "size_t align"
.Fa "struct malloc_type *type"
.Fa "int flags"
.Fc
.Ft void *
.Fn malloc_exec "size_t size" "struct malloc_type *type" "int flags" .Fn malloc_exec "size_t size" "struct malloc_type *type" "int flags"
.Fn MALLOC_DECLARE type .Fn MALLOC_DECLARE type
.In sys/param.h .In sys/param.h
@ -69,6 +76,14 @@
.Ft void * .Ft void *
.Fn malloc_domainset "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags" .Fn malloc_domainset "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags"
.Ft void * .Ft void *
.Fo malloc_domainset_aligned
.Fa "size_t size"
.Fa "size_t align"
.Fa "struct malloc_type *type"
.Fa "struct domainset *ds"
.Fa "int flags"
.Fc
.Ft void *
.Fn malloc_domainset_exec "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags" .Fn malloc_domainset_exec "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags"
.Ft void * .Ft void *
.Fn mallocarray_domainset "size_t nmemb" "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags" .Fn mallocarray_domainset "size_t nmemb" "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags"
@ -88,6 +103,14 @@ See
.Xr domainset 9 .Xr domainset 9
for some example policies. for some example policies.
.Pp .Pp
The
.Fn malloc_aligned
and
.Fn malloc_domainset_aligned
variants return allocations aligned as specified by
.Fa align ,
which must be non-zero, a power of two, and less than or equal to the page size.
.Pp
Both Both
.Fn malloc_exec .Fn malloc_exec
and and

2
sys/sys/malloc.h
View File

@ -265,6 +265,8 @@ void *realloc(void *addr, size_t size, struct malloc_type *type, int flags)
__result_use_check __alloc_size(2); __result_use_check __alloc_size(2);
void *reallocf(void *addr, size_t size, struct malloc_type *type, int flags) void *reallocf(void *addr, size_t size, struct malloc_type *type, int flags)
__result_use_check __alloc_size(2); __result_use_check __alloc_size(2);
void *malloc_aligned(size_t size, size_t align, struct malloc_type *type,
int flags) __malloc_like __result_use_check __alloc_size(1);
void *malloc_domainset_aligned(size_t size, size_t align, void *malloc_domainset_aligned(size_t size, size_t align,
struct malloc_type *mtp, struct domainset *ds, int flags) struct malloc_type *mtp, struct domainset *ds, int flags)
__malloc_like __result_use_check __alloc_size(1); __malloc_like __result_use_check __alloc_size(1);