Merge remote-tracking branch 'remotes/crater/vendor/BYACC'
[dragonfly.git] / share / man / man3 / end.3
1 .\" Copyright (c) 1986
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)end.3       6.4 (Berkeley) 1/24/94
29 .\" $FreeBSD: src/share/man/man3/end.3,v 1.3.2.3 2001/01/12 16:16:01 ru Exp $
30 .\" $DragonFly: src/share/man/man3/end.3,v 1.2 2003/06/17 04:36:58 dillon Exp $
31 .\"
32 .Dd August 28, 2000
33 .Dt END 3
34 .Os
35 .Sh NAME
36 .Nm end ,
37 .Nm etext ,
38 .Nm edata
39 .Nd end boundaries of image segments
40 .Sh SYNOPSIS
41 .Vt extern end ;
42 .Vt extern etext ;
43 .Vt extern edata ;
44 .Sh DESCRIPTION
45 The globals
46 .Va end , etext
47 and
48 .Va edata
49 are program segment end addresses.
50 .Pp
51 .Va etext
52 is the first address after the end of the text segment.
53 .Pp
54 .Va edata
55 is the first address after the end of the initialized data segment.
56 .Pp
57 .Va end
58 is the first address after the end of the data segment
59 .Pq Tn BSS
60 when the program is loaded.
61 Use the
62 .Xr sbrk 2
63 .\".Fn sbrk 0
64 system call with zero as its argument to find the current end of the
65 data segment.
66 .Sh SEE ALSO
67 .Xr sbrk 2 ,
68 .Xr malloc 3 ,
69 .Xr a.out 5
70 .Sh HISTORY
71 An
72 .Nm
73 manual page appeared in
74 .At v6 .
75 .Sh BUGS
76 Traditionally, no variable existed that pointed to the start of the
77 text segment because the text segment always started at address zero.
78 Although it is no longer valid to make this assumption, no
79 variable similar to the ones documented above exists to point to the
80 start of the text segment.