ed/Odin
1
0
Fork 0
mirror of https://github.com/Ed94/Odin.git synced 2026-07-09 04:51:37 -07:00
Code Issues Packages Projects Releases Wiki Activity

[mem]: Adjust the docs for calc_padding_with_header

Browse Source
This commit is contained in:
flysand7
2024-09-14 10:18:51 +11:00
parent e90f5d2528
commit 3ed2ab6e2c
2 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/mem/alloc.odin
+1 -2
View File
@@ -1019,8 +1019,7 @@ Default resize procedure.
When allocator does not support resize operation, but supports
`.Alloc_Non_Zeroed` and `.Free`, this procedure is used to implement allocator's
default behavior on
resize.
default behavior on resize.
Unlike `default_resize_align` no new memory is being explicitly
zero-initialized.
core/mem/mem.odin
+19 -3
View File
@@ -644,10 +644,26 @@ align_formula :: proc "contextless" (size, align: int) -> int {
}
/*
Calculate the padding after the pointer with a header.
Calculate the padding for header preceding aligned data.
This procedure returns the next address, following `ptr` and `header_size`
bytes of space that is aligned to a boundary specified by `align`.
This procedure returns the padding, following the specified pointer `ptr` that
will be able to fit in a header of the size `header_size`, immediately
preceding the memory region, aligned on a boundary specified by `align`. See
the following diagram for a visual representation.
header size
|<------>|
+---+--------+------------- - - -
| HEADER | DATA...
+---+--------+------------- - - -
^ ^
|<---------->|
| padding |
ptr aligned ptr
The function takes in `ptr` and `header_size`, as well as the required
alignment for `DATA`. The return value of the function is the padding between
`ptr` and `aligned_ptr` that will be able to fit the header.
*/
@(require_results)
calc_padding_with_header :: proc "contextless" (ptr: uintptr, align: uintptr, header_size: int) -> int {