components/libsigsegv/man3/stackoverflow_install_handler.3

   1 .\"
   2 .\" CDDL HEADER START
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
  22 .\"
  23 .\"
  24 .TH stackoverflow_install_handler 3 "13 Jan 2009" "SunOS 5.11"
  25 .SH NAME
  26 stackoverflow_install_handler, stackoverflow_deinstall_handler \- Installs and deinstall a stack overflow handler
  27 .sp
  28 .SH SYNOPSIS
  29 .sp
  30 #include <\fBsigsegv.h\fR>
  31 .sp
  32 int \fBstackoverflow_install_handler\fR (\fIstackoverflow_handler_t\fR
  33 .RS +26
  34 \fIhandler\fR, \fIvoid* extra_stack\fR,
  35 .RE
  36 .RS +26
  37 \fIunsigned long extra_stack_size\fR);
  38 .RE
  39 .sp
  40 void \fBstackoverflow_deinstall_handler\fR (\fIvoid\fR);
  41 .sp
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 In some applications, the \fBstack\fR \fBoverflow\fR \fBhandler\fR performs some cleanup or notifies the user and then immediately terminates the application.  In other applications, the \fBstack\fR \fBoverflow\fR \fBhandler\fR longjmps back to a central point in the application.  This library supports both uses.  In the second case, the handler must ensure to restore the normal signal mask (because many signals are blocked while the handler is executed), and must also call \fBsigsegv_leave_handler()\fR to transfer control; then only it can longjmp away.
  46 .sp
  47 .LP
  48 The handler is run at a moment when nothing about the global state of the program is known. Therefore it cannot use facilities that manipulate global variables or locks. In particular, it cannot use malloc(); use mmap() Instead. It cannot use fopen(); use open() instead. Etc. All global variables that are accessed by the handler should be mark
  49 'volatile'.
  50 .sp
  51 .SH OPERANDS
  52 .sp
  53 .LP
  54 typedef void (*\fBstackoverflow_handler_t\fR) (\fIint emergency\fR,
  55 .RS +28
  56 \fIstackoverflow_context_t scp\fR);
  57 .RE
  58 .sp
  59 \fIStackoverflow_handler_t\fR is the type of a stack overflow handler. Such a handler should perform a longjmp call in order to reduce the amount of stack needed. It must not return.The \fIemergency\fR argument is 0 when the stack could be repared, or 1 if the application should better save its state and exit now.
  60 .sp
  61 .LP
  62 The \fIextra_stack\fR argument is a pointer to a preallocated area used as a stack for executing the handler. It is typically allocated by use of `alloca' during `main'. Its size should be sufficiently large.
  63 .sp
  64 .LP
  65 The \fIextra_stack_size\fR is the size of the extra_stack argument.
  66 .sp
  67 .SH EXIT STATUS
  68 .sp
  69 .LP
  70 If success, \fBstackoverflow_install_handler()\fR returns 0 on success, or -1 if the system doesn't support catching stack overflow.
  71 .sp
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fattributes\fR(5), \fBsigsegv\fR(3), \fBstandards\fR(5)