xref: /illumos-gate/usr/src/head/ucontext.h (revision ed093b41a93e8563e6e1e5dae0768dda2a7bcc27)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*	Copyright (c) 1988 AT&T	*/
/*	  All Rights Reserved	*/


/*
 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
 * Copyright 2023 Oxide Computer Company
 *
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _UCONTEXT_H
#define	_UCONTEXT_H

#include <sys/ucontext.h>
/*
 * The file sys/regset.h defines indices in the gregset_t array,
 * such as EIP on i386.  Those defines were historically exposed
 * via sys/ucontext.h, sys/signal.h, etc. which caused surprises
 * due to those defines unexpectedly polluting the namespace.
 * On the other hand, several existing applications assume that
 * the regset names are defined after an include <ucontext.h>.
 * To solve both problems at once: <ucontext.h> (this file)
 * DOES include sys/regset.h for you but <sys/ucontext.h>
 * does NOT include sys/regset.h anymore.
 */
#if !defined(_XPG4_2) || defined(__EXTENSIONS__)
#include <sys/regset.h>
#include <sys/siginfo.h>
#include <inttypes.h>
#endif

#ifdef	__cplusplus
extern "C" {
#endif

#ifdef __sparc
#ifdef __PRAGMA_REDEFINE_EXTNAME
#pragma	redefine_extname	makecontext	__makecontext_v2
#else
#define	makecontext	__makecontext_v2
#endif
#endif

extern int getcontext(ucontext_t *) __RETURNS_TWICE;
#pragma unknown_control_flow(getcontext)
extern int setcontext(const ucontext_t *);
extern int swapcontext(ucontext_t *_RESTRICT_KYWD,
		const ucontext_t *_RESTRICT_KYWD);
extern void makecontext(ucontext_t *, void(*)(), int, ...);

#if !defined(_XPG4_2) || defined(__EXTENSIONS__)
extern ucontext_t *ucontext_alloc(uint32_t);
extern void ucontext_free(ucontext_t *);
extern int getcontext_extd(ucontext_t *, uint32_t) __RETURNS_TWICE;
#pragma unknown_control_flow(getcontext_extd)
extern int swapcontext_extd(ucontext_t *_RESTRICT_KYWD, uint32_t,
		const ucontext_t *_RESTRICT_KYWD);
extern int walkcontext(const ucontext_t *, int (*)(uintptr_t, int, void *),
    void *);
extern int printstack(int);
extern int addrtosymstr(void *, char *, int);
extern int getustack(stack_t **);
extern int setustack(stack_t *);

extern int stack_getbounds(stack_t *);
extern int stack_setbounds(const stack_t *);
extern int stack_inbounds(void *);
extern int stack_violation(int, const siginfo_t *, const ucontext_t *);

extern void *_stack_grow(void *);
#endif	/* !_XPG4_2 || __EXTENSIONS__ */

#ifdef	__cplusplus
}
#endif

#endif	/* _UCONTEXT_H */