sbrk
{{Short description|Basic memory management system calls used in Unix}}
{{lowercase title}}
{{cleanup rewrite|date=February 2012}}
{{mono|brk}} and {{mono|sbrk}} are basic memory management system calls used in Unix and Unix-like operating systems to control the amount of memory allocated to the heap segment of the process.{{cite web|url=https://www.gnu.org/software/libc/manual/html_node/Memory-Concepts.html|title=Process Memory Concepts|publisher=Free Software Foundation|accessdate=9 October 2015}} These functions are typically called from a higher-level memory management library function such as {{mono|malloc}}. In the original Unix system, {{mono|brk}} and {{mono|sbrk}} were the only ways in which applications could acquire additional heap space; later versions allowed this to also be done using the {{mono|mmap}} call.{{cite web|title=A new malloc(3) for OpenBSD|url=http://www.openbsd.org/papers/eurobsdcon2009/otto-malloc.pdf|accessdate=13 June 2018}}{{cite web |title=POSIX Memory Management |url=http://blog.pr4tt.com/2016/02/01/posix-memory-management/ |website=blog.pr4tt.com}}
Description
The brk and sbrk calls dynamically change the amount of space allocated for the heap segment of the calling process. The change is made by resetting the program break of the process, which determines the maximum space that can be allocated. The program break is the address of the first location beyond the current end of the data region. The amount of available space increases as the break value increases. The available space is initialized to a value of zero, unless the break is lowered and then increased, as it may reuse the same pages in some unspecified way. The break value can be automatically rounded up to a size appropriate for the memory management architecture.{{cite book|title=X/Open CAE Specification, System Interfaces and Headers |date=September 1994|issue=4|edition=2|publisher=X/Open Company Ltd., U.K.|page=64|url=http://pubs.opengroup.org/onlinepubs/9695969499/toc.pdf|accessdate=9 October 2015}}
{{mono|sbrk}} and {{mono|brk}} were considered legacy even by 1997 standards (Single UNIX Specification v2 or POSIX.1-1998).{{cite web |title=brk, sbrk - change space allocation (LEGACY) |url=https://pubs.opengroup.org/onlinepubs/7908799/xsh/brk.html |website=The Single UNIX ® Specification, Version 2 |accessdate=30 November 2019 |date=1997}} They were removed in POSIX.1-2001.{{man|2|brk|Linux}}
Function signatures and behavior
- include
int brk(void* end_data_segment);
void *sbrk(intptr_t increment);
{{mono|sbrk}} is used to adjust the program break value by adding a possibly negative size, while {{mono|brk}} is used to set the break value to the value of a pointer. Set {{var|increment}} parameter to zero to fetch the current value of the program break.
Upon successful completion, the {{mono|brk}} subroutine returns a value of 0, and the {{mono|sbrk}} subroutine returns the prior value of the program break (if the available space is increased then this prior value also points to the start of the new area). If either subroutine is unsuccessful, a value of {{num|−1}} is returned and the {{mono|errno}} global variable is set to indicate the error.
Not every Unix-like system entertains the concept of having the user control the data segment. The Mac OS X implementation of {{mono|sbrk}} is an emulation and has a maximum allocation of 4 megabytes. On first call an area exactly this large is allocated to hold the simulated segment. When this limit is reached, −1 is returned and the {{mono|errno}} is set to {{mono|ENOMEM}}. {{mono|brk}} always errors.{{Cite web|url=https://opensource.apple.com/source/Libc/Libc-1272.250.1/emulated/brk.c.auto.html|title=BRK.c}}
Error codes
The error {{mono|ENOMEM}} is set and the allocated space remains unchanged if one or more of the following are true:
- The requested change allocates more space than is allowed by a system-imposed maximum.
- The requested change sets the break value to a value greater than or equal to the start address of any attached shared memory segment.
See also
- Exec (computing)
- {{section link|Memory address|Address space in application programming}}