Fixed some formatting and indexing problems.
[kopensolaris-gnu/glibc.git] / manual / setjmp.texi
1 @node Non-Local Exits
2 @chapter Non-Local Exits
3 @cindex non-local exits
4
5 Sometimes when your program detects an unusual situation inside a deeply
6 nested set of function calls, you would like to be able to immediately
7 return to an outer level of control.  This section describes how you can
8 do such @dfn{non-local exits} using the @code{setjmp} and @code{longjmp}
9 functions.
10
11 @menu
12 * Introduction to Non-Local Exits::     An overview of how and when to use
13                                          these facilities.
14 * Functions for Non-Local Exits::       Details of the interface.
15 * Non-Local Exits and Blocked Signals:: Portability issues.
16 @end menu
17
18 @node Introduction to Non-Local Exits
19 @section Introduction to Non-Local Exits
20
21 As an example of a situation where a non-local exit can be useful,
22 suppose you have an interactive program that has a ``main loop'' that
23 prompts for and executes commands.  Suppose the ``read'' command reads
24 input from a file, doing some lexical analysis and parsing of the input
25 while processing it.  If a low-level input error is detected, it would
26 be useful to be able to return immediately to the ``main loop'' instead
27 of having to make each of the lexical analysis, parsing, and processing
28 phases all have to explicitly deal with error situations initially
29 detected by nested calls.
30
31 (On the other hand, if each of these phases has to do a substantial
32 amount of cleanup when it exits --- such as closing files, deallocating
33 buffers or other data structures, and the like --- then it can be more
34 appropriate to do a normal return and have each phase do its own
35 cleanup, because a non-local exit would bypass the intervening phases and
36 their associated cleanup code entirely.  Alternatively, you could use a
37 non-local exit but do the cleanup explicitly either before or after
38 returning to the ``main loop''.)
39
40 In some ways, a non-local exit is similar to using the @samp{return}
41 statement to return from a function.  But while @samp{return} abandons
42 only a single function call, transferring control back to the point at
43 which it was called, a non-local exit can potentially abandon many
44 levels of nested function calls.
45
46 You identify return points for non-local exits calling the function
47 @code{setjmp}.  This function saves information about the execution
48 environment in which the call to @code{setjmp} appears in an object of
49 type @code{jmp_buf}.  Execution of the program continues normally after
50 the call to @code{setjmp}, but if a exit is later made to this return
51 point by calling @code{longjmp} with the corresponding @code{jmp_buf}
52 object, control is transferred back to the point where @code{setjmp} was
53 called.  The return value from @code{setjmp} is used to distinguish
54 between an ordinary return and a return made by a call to
55 @code{longjmp}, so calls to @code{setjmp} usually appear in an @samp{if}
56 statement.
57
58 Here is how the example program described above might be set up:  
59
60 @example
61 #include <setjmp.h>
62 #include <stdio.h>
63
64 jmp_buf main_loop;
65
66 void abort_to_main_loop (void)
67 @{
68   longjmp (main_loop, -1);
69 @}
70
71 main ()
72 @{
73   extern void do_command (void);
74   while (1)
75     if (setjmp (main_loop))
76       printf ("Back at main loop....\n");
77     else
78       do_command ();
79 @}
80 @end example
81
82 The function @code{abort_to_main_loop} causes an immediate transfer of
83 control back to the main loop of the program, no matter where it is
84 called from.
85
86 The flow of control inside the @code{main} function may appear a little
87 mysterious at first, but it is actually a common idiom with
88 @code{setjmp}.  A normal call to @code{setjmp} returns zero, so the
89 ``else'' clause of the conditional is executed.  If
90 @code{abort_to_main_loop} is called somewhere within the execution of
91 @code{do_command}, then it actually appears as if the @emph{same} call
92 to @code{setjmp} in @code{main} were returning a second time with a value
93 of @code{-1}.
94
95 So, the general pattern for using @code{setjmp} looks something like:
96
97 @example
98 if (setjmp (@var{buffer}))
99   /* @r{Code to clean up after premature return.} */
100   @dots{}
101 else
102   /* @r{Code to be executed normally after setting up the return point.} */
103   @dots{}
104 @end example
105
106 @node Functions for Non-Local Exits
107 @section Functions for Non-Local Exits
108
109 Here are the details on the functions and data structures used for
110 performing non-local exits.  These facilities are declared in
111 @file{setjmp.h}.
112 @pindex setjmp.h
113
114 @comment setjmp.h
115 @comment ANSI
116 @deftp {Data Type} jmp_buf
117 Objects of type @code{jmp_buf} hold the state information to
118 be restored by a non-local exit.  The contents of a @code{jmp_buf}
119 identify a specific place to return to.
120 @end deftp
121
122 @comment setjmp.h
123 @comment ANSI
124 @deftypefun int setjmp (jmp_buf @var{state})
125 When called normally, @code{setjmp} stores information about the
126 execution state of the program in @var{state} and returns zero.  If
127 @code{longjmp} is later used to perform a non-local exit to this
128 @var{state}, @code{setjmp} returns a nonzero value.
129 @end deftypefun
130
131 @comment setjmp.h
132 @comment ANSI
133 @deftypefun void longjmp (jmp_buf @var{state}, int @var{value}) 
134 This function restores current execution to the state saved in
135 @var{state}, and continues execution from the call to @code{setjmp} that
136 established that return point.  Returning from @code{setjmp} by means of
137 @code{longjmp} returns the @var{value} argument that was passed to
138 @code{longjmp}, rather than @code{0}.  (But if @var{value} is given as
139 @code{0}, @code{setjmp} returns @code{1}).@refill
140 @end deftypefun
141
142 There are a lot of obscure but important restrictions on the use of
143 @code{setjmp} and @code{longjmp}.  Most of these restrictions are
144 present because non-local exits require a fair amount of magic on the
145 part of the C compiler and can interact with other parts of the language
146 in strange ways.
147
148 The @code{setjmp} function may be implemented as a macro without an
149 actual function definition, so you shouldn't try to @samp{#undef} it or
150 take its address.  In addition, calls to @code{setjmp} are safe in only
151 the following contexts:
152
153 @itemize @bullet
154 @item
155 As the test expression of a selection or iteration
156 statement (such as @samp{if} or @samp{while}).
157
158 @item
159 As one operand of a equality or comparison operator that appears as the
160 test expression of a selection or iteration statement.  The other
161 operand must be an integer constant expression.
162
163 @item
164 As the operand of a unary @samp{!} operator, that appears as the
165 test expression of a selection or iteration statement.
166
167 @item
168 By itself as an expression statement.
169 @end itemize
170
171 Return points are valid only during the dynamic extent of the function
172 that called @code{setjmp} to establish them.  If you @code{longjmp} to
173 a return point that was established in a function that has already
174 returned, unpredictable and disastrous things are likely to happen.
175
176 You should use a nonzero @var{value} argument to @code{longjmp}.  While
177 @code{longjmp} refuses to pass back a zero argument as the return value
178 from @code{setjmp}, this is intended as a safety net against accidental
179 misuse and is not really good programming style.
180
181 When you perform a non-local exit, accessible objects generally retain
182 whatever values they had at the time @code{longjmp} was called.  The
183 exception is that the values of automatic variables local to the
184 function containing the @code{setjmp} call that have been changed since
185 the call to @code{setjmp} are indeterminate, unless you have declared
186 them @code{volatile}.
187
188 @node Non-Local Exits and Blocked Signals
189 @section Non-Local Exits and Blocked Signals
190
191 In BSD Unix systems, @code{setjmp} and @code{longjmp} also save and
192 restore the set of blocked signals; @pxref{Blocking Signals}.  However,
193 the POSIX.1 standard requires @code{setjmp} and @code{longjmp} not to
194 change the set of blocked signals, and provides an additional pair of
195 functions (@code{sigsetjmp} and @code{sigsetjmp}) to get the BSD
196 behavior.
197
198 The behavior of @code{setjmp} and @code{longjmp} in the GNU Library is
199 controlled by feature test macros; @pxref{Feature Test Macros}.  The
200 default in the GNU system is the POSIX.1 behavior rather than the BSD
201 behavior.
202
203 The facilities in this section are declared in the header file
204 @file{setjmp.h}.
205 @pindex setjmp.h
206
207 @comment setjmp.h
208 @comment POSIX.1
209 @deftp {Data Type} sigjmp_buf
210 This is similar to @code{jmp_buf}, except that it can also store state
211 information about the set of blocked signals.
212 @end deftp
213
214 @comment setjmp.h
215 @comment POSIX.1
216 @deftypefun int sigsetjmp (sigjmp_buf @var{state}, int @var{savesigs})
217 This is similar to @code{setjmp}.  If @var{savesigs} is nonzero, the set
218 of blocked signals is saved in @var{state} and will be restored if a
219 @code{siglongjmp} is later performed with this @var{state}.
220 @end deftypefun
221
222 @comment setjmp.h
223 @comment POSIX.1
224 @deftypefun void siglongjmp (sigjmp_buf @var{state}, int @var{value})
225 This is similar to @code{longjmp} except for the type of its @var{state}
226 argument.
227 @end deftypefun
228