Browse Source

added notes about _unix_alloc

CiD- 3 years ago
parent
commit
ebdb3ab43a
3 changed files with 6 additions and 0 deletions
  1. 2 0
      core/os/os_darwin.odin
  2. 2 0
      core/os/os_freebsd.odin
  3. 2 0
      core/os/os_linux.odin

+ 2 - 0
core/os/os_darwin.odin

@@ -530,6 +530,8 @@ heap_alloc :: proc(size: int) -> rawptr {
 	return _unix_calloc(1, size)
 }
 heap_resize :: proc(ptr: rawptr, new_size: int) -> rawptr {
+	// NOTE: _unix_realloc doesn't guarantee new memory will be zeroed on
+	// POSIX platforms. Ensure your caller takes this into account.
 	return _unix_realloc(ptr, new_size)
 }
 heap_free :: proc(ptr: rawptr) {

+ 2 - 0
core/os/os_freebsd.odin

@@ -378,6 +378,8 @@ heap_alloc :: proc(size: int) -> rawptr {
 }
 
 heap_resize :: proc(ptr: rawptr, new_size: int) -> rawptr {
+	// NOTE: _unix_realloc doesn't guarantee new memory will be zeroed on
+	// POSIX platforms. Ensure your caller takes this into account.
 	return _unix_realloc(ptr, c.size_t(new_size));
 }
 

+ 2 - 0
core/os/os_linux.odin

@@ -543,6 +543,8 @@ heap_alloc :: proc(size: int) -> rawptr {
 }
 
 heap_resize :: proc(ptr: rawptr, new_size: int) -> rawptr {
+	// NOTE: _unix_realloc doesn't guarantee new memory will be zeroed on
+	// POSIX platforms. Ensure your caller takes this into account.
 	return _unix_realloc(ptr, c.size_t(new_size))
 }