src/Unix/sigsegv.cpp

/*
 *  sigsegv.cpp - SIGSEGV signals support
 *
 *  Derived from Bruno Haible's work on his SIGSEGV library for clisp
 *  <http://clisp.sourceforge.net/>
 *
 *  Basilisk II (C) 1997-2002 Christian Bauer
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <signal.h>
#include "sigsegv.h"

// Return value type of a signal handler (standard type if not defined)
#ifndef RETSIGTYPE
#define RETSIGTYPE void
#endif

// Type of the system signal handler
typedef RETSIGTYPE (*signal_handler)(int);

// Is the fault to be ignored?
static bool sigsegv_ignore_fault = false;

// User's SIGSEGV handler
static sigsegv_fault_handler_t sigsegv_fault_handler = 0;

// Function called to dump state if we can't handle the fault
static sigsegv_state_dumper_t sigsegv_state_dumper = 0;

// Actual SIGSEGV handler installer
static bool sigsegv_do_install_handler(int sig);


/*
 *  OS-dependant SIGSEGV signals support section
 */

#if HAVE_SIGINFO_T
// Generic extended signal handler
#if defined(__NetBSD__) || defined(__FreeBSD__)
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGBUS)
#else
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#endif
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, siginfo_t *sip, void *scp
#define SIGSEGV_FAULT_ADDRESS                   sip->si_addr
#if defined(__linux__)
#if (defined(i386) || defined(__i386__))
#include <sys/ucontext.h>
#define SIGSEGV_FAULT_INSTRUCTION               (((ucontext_t *)scp)->uc_mcontext.gregs[14]) /* should use REG_EIP instead */
#define SIGSEGV_REGISTER_FILE                   (unsigned long *)(((ucontext_t *)scp)->uc_mcontext.gregs)
#define SIGSEGV_SKIP_INSTRUCTION                ix86_skip_instruction
#endif
#if (defined(ia64) || defined(__ia64__))
#define SIGSEGV_FAULT_INSTRUCTION               (((struct sigcontext *)scp)->sc_ip & ~0x3ULL) /* slot number is in bits 0 and 1 */
#endif
#if (defined(powerpc) || defined(__powerpc__))
#include <sys/ucontext.h>
#define SIGSEGV_FAULT_INSTRUCTION               (((ucontext_t *)scp)->uc_mcontext.regs->nip)
#endif
#endif
#endif

#if HAVE_SIGCONTEXT_SUBTERFUGE
// Linux kernels prior to 2.4 ?
#if defined(__linux__)
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#if (defined(i386) || defined(__i386__))
#include <asm/sigcontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, struct sigcontext scs
#define SIGSEGV_FAULT_ADDRESS                   scs.cr2
#define SIGSEGV_FAULT_INSTRUCTION               scs.eip
#define SIGSEGV_REGISTER_FILE                   (unsigned long *)(&scs)
#define SIGSEGV_SKIP_INSTRUCTION                ix86_skip_instruction
#endif
#if (defined(sparc) || defined(__sparc__))
#include <asm/sigcontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp, char *addr
#define SIGSEGV_FAULT_ADDRESS                   addr
#endif
#if (defined(powerpc) || defined(__powerpc__))
#include <asm/sigcontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   scp->regs->dar
#define SIGSEGV_FAULT_INSTRUCTION               scp->regs->nip
#endif
#if (defined(alpha) || defined(__alpha__))
#include <asm/sigcontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   get_fault_address(scp)
#define SIGSEGV_FAULT_INSTRUCTION               scp->sc_pc

// From Boehm's GC 6.0alpha8
static sigsegv_address_t get_fault_address(struct sigcontext *scp)
{
        unsigned int instruction = *((unsigned int *)(scp->sc_pc));
        unsigned long fault_address = scp->sc_regs[(instruction >> 16) & 0x1f];
        fault_address += (signed long)(signed short)(instruction & 0xffff);
        return (sigsegv_address_t)fault_address;
}
#endif
#endif

// Irix 5 or 6 on MIPS
#if (defined(sgi) || defined(__sgi)) && (defined(SYSTYPE_SVR4) || defined(__SYSTYPE_SVR4))
#include <ucontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   scp->sc_badvaddr
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#endif

// HP-UX
#if (defined(hpux) || defined(__hpux__))
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   scp->sc_sl.sl_ss.ss_narrow.ss_cr21
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV) FAULT_HANDLER(SIGBUS)
#endif

// OSF/1 on Alpha
#if defined(__osf__)
#include <ucontext.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   scp->sc_traparg_a0
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#endif

// AIX
#if defined(_AIX)
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   scp->sc_jmpbuf.jmp_context.o_vaddr
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#endif

// NetBSD or FreeBSD
#if defined(__NetBSD__) || defined(__FreeBSD__)
#if (defined(m68k) || defined(__m68k__))
#include <m68k/frame.h>
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   ({                                                                                                                              \
        struct sigstate {                                                                                                                                                                       \
                int ss_flags;                                                                                                                                                                   \
                struct frame ss_frame;                                                                                                                                                  \
        };                                                                                                                                                                                                      \
        struct sigstate *state = (struct sigstate *)scp->sc_ap;                                                                                         \
        char *fault_addr;                                                                                                                                                                       \
        switch (state->ss_frame.f_format) {                                                                                                                                     \
        case 7:         /* 68040 access error */                                                                                                                                \
                /* "code" is sometimes unreliable (i.e. contains NULL or a bogus address), reason unknown */    \
                fault_addr = state->ss_frame.f_fmt7.f_fa;                                                                                                               \
                break;                                                                                                                                                                                  \
        default:                                                                                                                                                                                        \
                fault_addr = (char *)code;                                                                                                                                              \
                break;                                                                                                                                                                                  \
        }                                                                                                                                                                                                       \
        fault_addr;                                                                                                                                                                                     \
})
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGSEGV)
#else
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, void *scp, char *addr
#define SIGSEGV_FAULT_ADDRESS                   addr
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGBUS)
#endif
#endif

// MacOS X
#if defined(__APPLE__) && defined(__MACH__)
#if (defined(ppc) || defined(__ppc__))
#define SIGSEGV_FAULT_HANDLER_ARGLIST   int sig, int code, struct sigcontext *scp
#define SIGSEGV_FAULT_ADDRESS                   get_fault_address(scp)
#define SIGSEGV_FAULT_INSTRUCTION               scp->sc_ir
#define SIGSEGV_ALL_SIGNALS                             FAULT_HANDLER(SIGBUS)

// From Boehm's GC 6.0alpha8
#define EXTRACT_OP1(iw)     (((iw) & 0xFC000000) >> 26)
#define EXTRACT_OP2(iw)     (((iw) & 0x000007FE) >> 1)
#define EXTRACT_REGA(iw)    (((iw) & 0x001F0000) >> 16)
#define EXTRACT_REGB(iw)    (((iw) & 0x03E00000) >> 21)
#define EXTRACT_REGC(iw)    (((iw) & 0x0000F800) >> 11)
#define EXTRACT_DISP(iw)    ((short *) &(iw))[1]

static sigsegv_address_t get_fault_address(struct sigcontext *scp)
{
        unsigned int   instr = *((unsigned int *) scp->sc_ir);
        unsigned int * regs = &((unsigned int *) scp->sc_regs)[2];
        int            disp = 0, tmp;
        unsigned int   baseA = 0, baseB = 0;
        unsigned int   addr, alignmask = 0xFFFFFFFF;

        switch(EXTRACT_OP1(instr)) {
        case 38:   /* stb */
        case 39:   /* stbu */
        case 54:   /* stfd */
        case 55:   /* stfdu */
        case 52:   /* stfs */
        case 53:   /* stfsu */
        case 44:   /* sth */
        case 45:   /* sthu */
        case 47:   /* stmw */
        case 36:   /* stw */
        case 37:   /* stwu */
                tmp = EXTRACT_REGA(instr);
                if(tmp > 0)
                        baseA = regs[tmp];
                disp = EXTRACT_DISP(instr);
                break;
        case 31:
                switch(EXTRACT_OP2(instr)) {
                case 86:    /* dcbf */
                case 54:    /* dcbst */
                case 1014:  /* dcbz */
                case 247:   /* stbux */
                case 215:   /* stbx */
                case 759:   /* stfdux */
                case 727:   /* stfdx */
                case 983:   /* stfiwx */
                case 695:   /* stfsux */
                case 663:   /* stfsx */
                case 918:   /* sthbrx */
                case 439:   /* sthux */
                case 407:   /* sthx */
                case 661:   /* stswx */
                case 662:   /* stwbrx */
                case 150:   /* stwcx. */
                case 183:   /* stwux */
                case 151:   /* stwx */
                case 135:   /* stvebx */
                case 167:   /* stvehx */
                case 199:   /* stvewx */
                case 231:   /* stvx */
                case 487:   /* stvxl */
                        tmp = EXTRACT_REGA(instr);
                        if(tmp > 0)
                                baseA = regs[tmp];
                        baseB = regs[EXTRACT_REGC(instr)];
                        /* determine Altivec alignment mask */
                        switch(EXTRACT_OP2(instr)) {
                        case 167:   /* stvehx */
                                alignmask = 0xFFFFFFFE;
                                break;
                        case 199:   /* stvewx */
                                alignmask = 0xFFFFFFFC;
                                break;
                        case 231:   /* stvx */
                                alignmask = 0xFFFFFFF0;
                                break;
                        case 487:  /* stvxl */
                                alignmask = 0xFFFFFFF0;
                                break;
                        }
                        break;
                case 725:   /* stswi */
                        tmp = EXTRACT_REGA(instr);
                        if(tmp > 0)
                                baseA = regs[tmp];
                        break;
                default:   /* ignore instruction */
                        return 0;
                        break;
                }
                break;
        default:   /* ignore instruction */
                return 0;
                break;
        }
        
        addr = (baseA + baseB) + disp;
        addr &= alignmask;
        return (sigsegv_address_t)addr;
}
#endif
#endif
#endif

#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
// Decode and skip X86 instruction
#if (defined(i386) || defined(__i386__))
#if defined(__linux__)
enum {
        X86_REG_EIP = 14,
        X86_REG_EAX = 11,
        X86_REG_ECX = 10,
        X86_REG_EDX = 9,
        X86_REG_EBX = 8,
        X86_REG_ESP = 7,
        X86_REG_EBP = 6,
        X86_REG_ESI = 5,
        X86_REG_EDI = 4
};
#endif
// FIXME: this is partly redundant with the instruction decoding phase
// to discover transfer type and register number
static inline int ix86_step_over_modrm(unsigned char * p)
{
        int mod = (p[0] >> 6) & 3;
        int rm = p[0] & 7;
        int offset = 0;

        // ModR/M Byte
        switch (mod) {
        case 0: // [reg]
                if (rm == 5) return 4; // disp32
                break;
        case 1: // disp8[reg]
                offset = 1;
                break;
        case 2: // disp32[reg]
                offset = 4;
                break;
        case 3: // register
                return 0;
        }
        
        // SIB Byte
        if (rm == 4) {
                if (mod == 0 && (p[1] & 7) == 5)
                        offset = 5; // disp32[index]
                else
                        offset++;
        }

        return offset;
}

static bool ix86_skip_instruction(sigsegv_address_t fault_instruction, unsigned long * regs)
{
        unsigned char * eip = (unsigned char *)fault_instruction;

        if (eip == 0)
                return false;
        
        // Transfer type
        enum {
                TYPE_UNKNOWN,
                TYPE_LOAD,
                TYPE_STORE
        } transfer_type = TYPE_UNKNOWN;
        
        // Transfer size
        enum {
                SIZE_BYTE,
                SIZE_WORD,
                SIZE_LONG
        } transfer_size = SIZE_LONG;
        
        int reg = -1;
        int len = 0;
        
        // Operand size prefix
        if (*eip == 0x66) {
                eip++;
                len++;
                transfer_size = SIZE_WORD;
        }

        // Decode instruction
        switch (eip[0]) {
        case 0x8a: // MOV r8, r/m8
                transfer_size = SIZE_BYTE;
        case 0x8b: // MOV r32, r/m32 (or 16-bit operation)
                switch (eip[1] & 0xc0) {
                case 0x80:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_LOAD;
                        break;
                case 0x40:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_LOAD;
                        break;
                case 0x00:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_LOAD;
                        break;
                }
                len += 2 + ix86_step_over_modrm(eip + 1);
                break;
        case 0x88: // MOV r/m8, r8
                transfer_size = SIZE_BYTE;
        case 0x89: // MOV r/m32, r32 (or 16-bit operation)
                switch (eip[1] & 0xc0) {
                case 0x80:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_STORE;
                        break;
                case 0x40:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_STORE;
                        break;
                case 0x00:
                        reg = (eip[1] >> 3) & 7;
                        transfer_type = TYPE_STORE;
                        break;
                }
                len += 2 + ix86_step_over_modrm(eip + 1);
                break;
        }

        if (transfer_type == TYPE_UNKNOWN) {
                // Unknown machine code, let it crash. Then patch the decoder
                return false;
        }

        if (transfer_type == TYPE_LOAD && reg != -1) {
                static const int x86_reg_map[8] = {
                        X86_REG_EAX, X86_REG_ECX, X86_REG_EDX, X86_REG_EBX,
                        X86_REG_ESP, X86_REG_EBP, X86_REG_ESI, X86_REG_EDI
                };
                
                if (reg < 0 || reg >= 8)
                        return false;

                int rloc = x86_reg_map[reg];
                switch (transfer_size) {
                case SIZE_BYTE:
                        regs[rloc] = (regs[rloc] & ~0xff);
                        break;
                case SIZE_WORD:
                        regs[rloc] = (regs[rloc] & ~0xffff);
                        break;
                case SIZE_LONG:
                        regs[rloc] = 0;
                        break;
                }
        }

#if DEBUG
        printf("%08x: %s %s access", regs[X86_REG_EIP],
                   transfer_size == SIZE_BYTE ? "byte" : transfer_size == SIZE_WORD ? "word" : "long",
                   transfer_type == TYPE_LOAD ? "read" : "write");
        
        if (reg != -1) {
                static const char * x86_reg_str_map[8] = {
                        "eax", "ecx", "edx", "ebx",
                        "esp", "ebp", "esi", "edi"
                };
                printf(" %s register %%%s", transfer_type == TYPE_LOAD ? "to" : "from", x86_reg_str_map[reg]);
        }
        printf(", %d bytes instruction\n", len);
#endif
        
        regs[X86_REG_EIP] += len;
        return true;
}
#endif
#endif

// Fallbacks
#ifndef SIGSEGV_FAULT_INSTRUCTION
#define SIGSEGV_FAULT_INSTRUCTION               SIGSEGV_INVALID_PC
#endif

// SIGSEGV recovery supported ?
#if defined(SIGSEGV_ALL_SIGNALS) && defined(SIGSEGV_FAULT_HANDLER_ARGLIST) && defined(SIGSEGV_FAULT_ADDRESS)
#define HAVE_SIGSEGV_RECOVERY
#endif


/*
 *  SIGSEGV global handler
 */

#ifdef HAVE_SIGSEGV_RECOVERY
static void sigsegv_handler(SIGSEGV_FAULT_HANDLER_ARGLIST)
{
        sigsegv_address_t fault_address = (sigsegv_address_t)SIGSEGV_FAULT_ADDRESS;
        sigsegv_address_t fault_instruction = (sigsegv_address_t)SIGSEGV_FAULT_INSTRUCTION;
        bool fault_recovered = false;
        
        // Call user's handler and reinstall the global handler, if required
        if (sigsegv_fault_handler(fault_address, fault_instruction)) {
#if (defined(HAVE_SIGACTION) ? defined(SIGACTION_NEED_REINSTALL) : defined(SIGNAL_NEED_REINSTALL))
                sigsegv_do_install_handler(sig);
#endif
                fault_recovered = true;
        }
#if HAVE_SIGSEGV_SKIP_INSTRUCTION
        else if (sigsegv_ignore_fault) {
                // Call the instruction skipper with the register file available
                if (SIGSEGV_SKIP_INSTRUCTION(fault_instruction, SIGSEGV_REGISTER_FILE))
                        fault_recovered = true;
        }
#endif

        if (!fault_recovered) {
                // FAIL: reinstall default handler for "safe" crash
#define FAULT_HANDLER(sig) signal(sig, SIG_DFL);
                SIGSEGV_ALL_SIGNALS
#undef FAULT_HANDLER
                
                // We can't do anything with the fault_address, dump state?
                if (sigsegv_state_dumper != 0)
                        sigsegv_state_dumper(fault_address, fault_instruction);
        }
}
#endif


/*
 *  SIGSEGV handler initialization
 */

#if defined(HAVE_SIGINFO_T)
static bool sigsegv_do_install_handler(int sig)
{
        // Setup SIGSEGV handler to process writes to frame buffer
#ifdef HAVE_SIGACTION
        struct sigaction vosf_sa;
        sigemptyset(&vosf_sa.sa_mask);
        vosf_sa.sa_sigaction = sigsegv_handler;
        vosf_sa.sa_flags = SA_SIGINFO;
        return (sigaction(sig, &vosf_sa, 0) == 0);
#else
        return (signal(sig, (signal_handler)sigsegv_handler) != SIG_ERR);
#endif
}
#endif

#if defined(HAVE_SIGCONTEXT_SUBTERFUGE)
static bool sigsegv_do_install_handler(int sig)
{
        // Setup SIGSEGV handler to process writes to frame buffer
#ifdef HAVE_SIGACTION
        struct sigaction vosf_sa;
        sigemptyset(&vosf_sa.sa_mask);
        vosf_sa.sa_handler = (signal_handler)sigsegv_handler;
#if !EMULATED_68K && defined(__NetBSD__)
        sigaddset(&vosf_sa.sa_mask, SIGALRM);
        vosf_sa.sa_flags = SA_ONSTACK;
#else
        vosf_sa.sa_flags = 0;
#endif
        return (sigaction(sig, &vosf_sa, 0) == 0);
#else
        return (signal(sig, (signal_handler)sigsegv_handler) != SIG_ERR);
#endif
}
#endif

bool sigsegv_install_handler(sigsegv_fault_handler_t handler)
{
#ifdef HAVE_SIGSEGV_RECOVERY
        sigsegv_fault_handler = handler;
        bool success = true;
#define FAULT_HANDLER(sig) success = success && sigsegv_do_install_handler(sig);
        SIGSEGV_ALL_SIGNALS
#undef FAULT_HANDLER
        return success;
#else
        // FAIL: no siginfo_t nor sigcontext subterfuge is available
        return false;
#endif
}


/*
 *  SIGSEGV handler deinitialization
 */

void sigsegv_deinstall_handler(void)
{
#ifdef HAVE_SIGSEGV_RECOVERY
        sigsegv_fault_handler = 0;
#define FAULT_HANDLER(sig) signal(sig, SIG_DFL);
        SIGSEGV_ALL_SIGNALS
#undef FAULT_HANDLER
#endif
}


/*
 *  SIGSEGV ignore state modifier
 */

void sigsegv_set_ignore_state(bool ignore_fault)
{
        sigsegv_ignore_fault = ignore_fault;
}


/*
 *  Set callback function when we cannot handle the fault
 */

void sigsegv_set_dump_state(sigsegv_state_dumper_t handler)
{
        sigsegv_state_dumper = handler;
}


/*
 *  Test program used for configure/test
 */

#ifdef CONFIGURE_TEST_SIGSEGV_RECOVERY
#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include <sys/mman.h>
#include "vm_alloc.h"

static int page_size;
static volatile char * page = 0;
static volatile int handler_called = 0;

static bool sigsegv_test_handler(sigsegv_address_t fault_address, sigsegv_address_t instruction_address)
{
        handler_called++;
        if ((fault_address - 123) != page)
                exit(1);
        if (vm_protect((char *)((unsigned long)fault_address & -page_size), page_size, VM_PAGE_READ | VM_PAGE_WRITE) != 0)
                exit(1);
        return true;
}

#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
static bool sigsegv_insn_handler(sigsegv_address_t fault_address, sigsegv_address_t instruction_address)
{
        return false;
}
#endif

int main(void)
{
        if (vm_init() < 0)
                return 1;

        page_size = getpagesize();
        if ((page = (char *)vm_acquire(page_size)) == VM_MAP_FAILED)
                return 1;
        
        if (vm_protect((char *)page, page_size, VM_PAGE_READ) < 0)
                return 1;
        
        if (!sigsegv_install_handler(sigsegv_test_handler))
                return 1;
        
        page[123] = 45;
        page[123] = 45;
        
        if (handler_called != 1)
                return 1;

#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
        if (!sigsegv_install_handler(sigsegv_insn_handler))
                return 1;
        
        if (vm_protect((char *)page, page_size, VM_PAGE_WRITE) < 0)
                return 1;
        
        for (int i = 0; i < page_size; i++)
                page[i] = (i + 1) % page_size;
        
        if (vm_protect((char *)page, page_size, VM_PAGE_NOACCESS) < 0)
                return 1;
        
        sigsegv_set_ignore_state(true);

#define TEST_SKIP_INSTRUCTION(TYPE) do {                                \
                const unsigned int TAG = 0x12345678;                    \
                TYPE data = *((TYPE *)(page + sizeof(TYPE)));   \
                volatile unsigned int effect = data + TAG;              \
                if (effect != TAG)                                                              \
                        return 1;                                                                       \
        } while (0)
        
        TEST_SKIP_INSTRUCTION(unsigned char);
        TEST_SKIP_INSTRUCTION(unsigned short);
        TEST_SKIP_INSTRUCTION(unsigned int);
#endif

        vm_exit();
        return 0;
}
#endif
Revision:	1.12
Committed:	2002-05-16T15:48:06Z (22 years, 2 months ago) by gbeauche
Branch:	MAIN
Changes since 1.11:	+10 -10 lines
Log Message:	- video_vosh.h (Screen_fault_handler): Move unrecoverable fault case to... - main_unix.cpp (sigsegv_dump_state): ... Here. - sigsegv.h (sigsegv_fault_handler_t): Rename from sigsegv_handler_t. - sigsegv.h (sigsegv_state_dumper_t): New.
#	User	Rev	Content
1	gbeauche	1.1	/*
2			* sigsegv.cpp - SIGSEGV signals support
3			*
4			* Derived from Bruno Haible's work on his SIGSEGV library for clisp
5			* <http://clisp.sourceforge.net/>
6			*
7	cebix	1.7	* Basilisk II (C) 1997-2002 Christian Bauer
8	gbeauche	1.1	*
9			* This program is free software; you can redistribute it and/or modify
10			* it under the terms of the GNU General Public License as published by
11			* the Free Software Foundation; either version 2 of the License, or
12			* (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU General Public License for more details.
18			*
19			* You should have received a copy of the GNU General Public License
20			* along with this program; if not, write to the Free Software
21			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22			*/
23
24			#ifdef HAVE_UNISTD_H
25			#include <unistd.h>
26			#endif
27
28			#ifdef HAVE_CONFIG_H
29			#include "config.h"
30			#endif
31
32			#include <signal.h>
33			#include "sigsegv.h"
34
35			// Return value type of a signal handler (standard type if not defined)
36			#ifndef RETSIGTYPE
37			#define RETSIGTYPE void
38			#endif
39
40			// Type of the system signal handler
41			typedef RETSIGTYPE (*signal_handler)(int);
42
43	gbeauche	1.10	// Is the fault to be ignored?
44			static bool sigsegv_ignore_fault = false;
45
46	gbeauche	1.1	// User's SIGSEGV handler
47	gbeauche	1.12	static sigsegv_fault_handler_t sigsegv_fault_handler = 0;
48	gbeauche	1.1
49	gbeauche	1.10	// Function called to dump state if we can't handle the fault
50	gbeauche	1.12	static sigsegv_state_dumper_t sigsegv_state_dumper = 0;
51	gbeauche	1.10
52	gbeauche	1.1	// Actual SIGSEGV handler installer
53			static bool sigsegv_do_install_handler(int sig);
54
55
56			/*
57			* OS-dependant SIGSEGV signals support section
58			*/
59
60			#if HAVE_SIGINFO_T
61			// Generic extended signal handler
62	cebix	1.8	#if defined(__NetBSD__) \|\| defined(__FreeBSD__)
63			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGBUS)
64			#else
65	gbeauche	1.1	#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
66	cebix	1.8	#endif
67	gbeauche	1.5	#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, siginfo_t sip, void scp
68	gbeauche	1.1	#define SIGSEGV_FAULT_ADDRESS sip->si_addr
69	gbeauche	1.5	#if defined(__linux__)
70	gbeauche	1.6	#if (defined(i386) \|\| defined(__i386__))
71			#include <sys/ucontext.h>
72			#define SIGSEGV_FAULT_INSTRUCTION (((ucontext_t )scp)->uc_mcontext.gregs[14]) / should use REG_EIP instead */
73	gbeauche	1.10	#define SIGSEGV_REGISTER_FILE (unsigned long )(((ucontext_t )scp)->uc_mcontext.gregs)
74			#define SIGSEGV_SKIP_INSTRUCTION ix86_skip_instruction
75	gbeauche	1.6	#endif
76	gbeauche	1.5	#if (defined(ia64) \|\| defined(__ia64__))
77			#define SIGSEGV_FAULT_INSTRUCTION (((struct sigcontext )scp)->sc_ip & ~0x3ULL) / slot number is in bits 0 and 1 */
78			#endif
79	gbeauche	1.9	#if (defined(powerpc) \|\| defined(__powerpc__))
80			#include <sys/ucontext.h>
81			#define SIGSEGV_FAULT_INSTRUCTION (((ucontext_t *)scp)->uc_mcontext.regs->nip)
82			#endif
83	gbeauche	1.5	#endif
84	gbeauche	1.1	#endif
85
86			#if HAVE_SIGCONTEXT_SUBTERFUGE
87			// Linux kernels prior to 2.4 ?
88			#if defined(__linux__)
89			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
90			#if (defined(i386) \|\| defined(__i386__))
91			#include <asm/sigcontext.h>
92			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, struct sigcontext scs
93			#define SIGSEGV_FAULT_ADDRESS scs.cr2
94			#define SIGSEGV_FAULT_INSTRUCTION scs.eip
95	gbeauche	1.10	#define SIGSEGV_REGISTER_FILE (unsigned long *)(&scs)
96			#define SIGSEGV_SKIP_INSTRUCTION ix86_skip_instruction
97	gbeauche	1.1	#endif
98			#if (defined(sparc) \|\| defined(__sparc__))
99			#include <asm/sigcontext.h>
100	gbeauche	1.5	#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext scp, char addr
101	gbeauche	1.1	#define SIGSEGV_FAULT_ADDRESS addr
102			#endif
103			#if (defined(powerpc) \|\| defined(__powerpc__))
104			#include <asm/sigcontext.h>
105	gbeauche	1.4	#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, struct sigcontext *scp
106	gbeauche	1.1	#define SIGSEGV_FAULT_ADDRESS scp->regs->dar
107			#define SIGSEGV_FAULT_INSTRUCTION scp->regs->nip
108			#endif
109	gbeauche	1.4	#if (defined(alpha) \|\| defined(__alpha__))
110			#include <asm/sigcontext.h>
111			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
112			#define SIGSEGV_FAULT_ADDRESS get_fault_address(scp)
113			#define SIGSEGV_FAULT_INSTRUCTION scp->sc_pc
114
115			// From Boehm's GC 6.0alpha8
116			static sigsegv_address_t get_fault_address(struct sigcontext *scp)
117			{
118			unsigned int instruction = ((unsigned int )(scp->sc_pc));
119			unsigned long fault_address = scp->sc_regs[(instruction >> 16) & 0x1f];
120			fault_address += (signed long)(signed short)(instruction & 0xffff);
121			return (sigsegv_address_t)fault_address;
122			}
123			#endif
124	gbeauche	1.1	#endif
125
126			// Irix 5 or 6 on MIPS
127			#if (defined(sgi) \|\| defined(__sgi)) && (defined(SYSTYPE_SVR4) \|\| defined(__SYSTYPE_SVR4))
128	gbeauche	1.11	#include <ucontext.h>
129	gbeauche	1.1	#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
130			#define SIGSEGV_FAULT_ADDRESS scp->sc_badvaddr
131			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
132			#endif
133
134	gbeauche	1.11	// HP-UX
135			#if (defined(hpux) \|\| defined(__hpux__))
136			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
137			#define SIGSEGV_FAULT_ADDRESS scp->sc_sl.sl_ss.ss_narrow.ss_cr21
138			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV) FAULT_HANDLER(SIGBUS)
139			#endif
140
141	gbeauche	1.1	// OSF/1 on Alpha
142			#if defined(__osf__)
143	gbeauche	1.11	#include <ucontext.h>
144	gbeauche	1.1	#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
145			#define SIGSEGV_FAULT_ADDRESS scp->sc_traparg_a0
146			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
147			#endif
148
149			// AIX
150			#if defined(_AIX)
151			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
152			#define SIGSEGV_FAULT_ADDRESS scp->sc_jmpbuf.jmp_context.o_vaddr
153			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
154			#endif
155
156			// NetBSD or FreeBSD
157			#if defined(__NetBSD__) \|\| defined(__FreeBSD__)
158			#if (defined(m68k) \|\| defined(__m68k__))
159			#include <m68k/frame.h>
160			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
161			#define SIGSEGV_FAULT_ADDRESS ({ \
162			struct sigstate { \
163			int ss_flags; \
164			struct frame ss_frame; \
165			}; \
166			struct sigstate state = (struct sigstate )scp->sc_ap; \
167			char *fault_addr; \
168			switch (state->ss_frame.f_format) { \
169			case 7: /* 68040 access error */ \
170			/* "code" is sometimes unreliable (i.e. contains NULL or a bogus address), reason unknown */ \
171			fault_addr = state->ss_frame.f_fmt7.f_fa; \
172			break; \
173			default: \
174			fault_addr = (char *)code; \
175			break; \
176			} \
177			fault_addr; \
178			})
179			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGSEGV)
180			#else
181			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, void scp, char addr
182			#define SIGSEGV_FAULT_ADDRESS addr
183			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGBUS)
184			#endif
185			#endif
186	gbeauche	1.4
187			// MacOS X
188			#if defined(__APPLE__) && defined(__MACH__)
189			#if (defined(ppc) \|\| defined(__ppc__))
190			#define SIGSEGV_FAULT_HANDLER_ARGLIST int sig, int code, struct sigcontext *scp
191			#define SIGSEGV_FAULT_ADDRESS get_fault_address(scp)
192			#define SIGSEGV_FAULT_INSTRUCTION scp->sc_ir
193			#define SIGSEGV_ALL_SIGNALS FAULT_HANDLER(SIGBUS)
194
195			// From Boehm's GC 6.0alpha8
196			#define EXTRACT_OP1(iw) (((iw) & 0xFC000000) >> 26)
197			#define EXTRACT_OP2(iw) (((iw) & 0x000007FE) >> 1)
198			#define EXTRACT_REGA(iw) (((iw) & 0x001F0000) >> 16)
199			#define EXTRACT_REGB(iw) (((iw) & 0x03E00000) >> 21)
200			#define EXTRACT_REGC(iw) (((iw) & 0x0000F800) >> 11)
201			#define EXTRACT_DISP(iw) ((short *) &(iw))[1]
202
203			static sigsegv_address_t get_fault_address(struct sigcontext *scp)
204			{
205			unsigned int instr = ((unsigned int ) scp->sc_ir);
206			unsigned int * regs = &((unsigned int *) scp->sc_regs)[2];
207			int disp = 0, tmp;
208			unsigned int baseA = 0, baseB = 0;
209			unsigned int addr, alignmask = 0xFFFFFFFF;
210
211			switch(EXTRACT_OP1(instr)) {
212			case 38: /* stb */
213			case 39: /* stbu */
214			case 54: /* stfd */
215			case 55: /* stfdu */
216			case 52: /* stfs */
217			case 53: /* stfsu */
218			case 44: /* sth */
219			case 45: /* sthu */
220			case 47: /* stmw */
221			case 36: /* stw */
222			case 37: /* stwu */
223			tmp = EXTRACT_REGA(instr);
224			if(tmp > 0)
225			baseA = regs[tmp];
226			disp = EXTRACT_DISP(instr);
227			break;
228			case 31:
229			switch(EXTRACT_OP2(instr)) {
230			case 86: /* dcbf */
231			case 54: /* dcbst */
232			case 1014: /* dcbz */
233			case 247: /* stbux */
234			case 215: /* stbx */
235			case 759: /* stfdux */
236			case 727: /* stfdx */
237			case 983: /* stfiwx */
238			case 695: /* stfsux */
239			case 663: /* stfsx */
240			case 918: /* sthbrx */
241			case 439: /* sthux */
242			case 407: /* sthx */
243			case 661: /* stswx */
244			case 662: /* stwbrx */
245			case 150: /* stwcx. */
246			case 183: /* stwux */
247			case 151: /* stwx */
248			case 135: /* stvebx */
249			case 167: /* stvehx */
250			case 199: /* stvewx */
251			case 231: /* stvx */
252			case 487: /* stvxl */
253			tmp = EXTRACT_REGA(instr);
254			if(tmp > 0)
255			baseA = regs[tmp];
256			baseB = regs[EXTRACT_REGC(instr)];
257			/* determine Altivec alignment mask */
258			switch(EXTRACT_OP2(instr)) {
259			case 167: /* stvehx */
260			alignmask = 0xFFFFFFFE;
261			break;
262			case 199: /* stvewx */
263			alignmask = 0xFFFFFFFC;
264			break;
265			case 231: /* stvx */
266			alignmask = 0xFFFFFFF0;
267			break;
268			case 487: /* stvxl */
269			alignmask = 0xFFFFFFF0;
270			break;
271			}
272			break;
273			case 725: /* stswi */
274			tmp = EXTRACT_REGA(instr);
275			if(tmp > 0)
276			baseA = regs[tmp];
277			break;
278			default: /* ignore instruction */
279			return 0;
280			break;
281			}
282			break;
283			default: /* ignore instruction */
284			return 0;
285			break;
286			}
287
288			addr = (baseA + baseB) + disp;
289			addr &= alignmask;
290			return (sigsegv_address_t)addr;
291			}
292			#endif
293			#endif
294	gbeauche	1.1	#endif
295
296	gbeauche	1.10	#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
297			// Decode and skip X86 instruction
298			#if (defined(i386) \|\| defined(__i386__))
299			#if defined(__linux__)
300			enum {
301			X86_REG_EIP = 14,
302			X86_REG_EAX = 11,
303			X86_REG_ECX = 10,
304			X86_REG_EDX = 9,
305			X86_REG_EBX = 8,
306			X86_REG_ESP = 7,
307			X86_REG_EBP = 6,
308			X86_REG_ESI = 5,
309			X86_REG_EDI = 4
310			};
311			#endif
312			// FIXME: this is partly redundant with the instruction decoding phase
313			// to discover transfer type and register number
314			static inline int ix86_step_over_modrm(unsigned char * p)
315			{
316			int mod = (p[0] >> 6) & 3;
317			int rm = p[0] & 7;
318			int offset = 0;
319
320			// ModR/M Byte
321			switch (mod) {
322			case 0: // [reg]
323			if (rm == 5) return 4; // disp32
324			break;
325			case 1: // disp8[reg]
326			offset = 1;
327			break;
328			case 2: // disp32[reg]
329			offset = 4;
330			break;
331			case 3: // register
332			return 0;
333			}
334
335			// SIB Byte
336			if (rm == 4) {
337			if (mod == 0 && (p[1] & 7) == 5)
338			offset = 5; // disp32[index]
339			else
340			offset++;
341			}
342
343			return offset;
344			}
345
346			static bool ix86_skip_instruction(sigsegv_address_t fault_instruction, unsigned long * regs)
347			{
348			unsigned char * eip = (unsigned char *)fault_instruction;
349
350			if (eip == 0)
351			return false;
352
353			// Transfer type
354			enum {
355			TYPE_UNKNOWN,
356			TYPE_LOAD,
357			TYPE_STORE
358			} transfer_type = TYPE_UNKNOWN;
359
360			// Transfer size
361			enum {
362			SIZE_BYTE,
363			SIZE_WORD,
364			SIZE_LONG
365			} transfer_size = SIZE_LONG;
366
367			int reg = -1;
368			int len = 0;
369
370			// Operand size prefix
371			if (*eip == 0x66) {
372			eip++;
373			len++;
374			transfer_size = SIZE_WORD;
375			}
376
377			// Decode instruction
378			switch (eip[0]) {
379			case 0x8a: // MOV r8, r/m8
380			transfer_size = SIZE_BYTE;
381			case 0x8b: // MOV r32, r/m32 (or 16-bit operation)
382			switch (eip[1] & 0xc0) {
383			case 0x80:
384			reg = (eip[1] >> 3) & 7;
385			transfer_type = TYPE_LOAD;
386			break;
387			case 0x40:
388			reg = (eip[1] >> 3) & 7;
389			transfer_type = TYPE_LOAD;
390			break;
391			case 0x00:
392			reg = (eip[1] >> 3) & 7;
393			transfer_type = TYPE_LOAD;
394			break;
395			}
396			len += 2 + ix86_step_over_modrm(eip + 1);
397			break;
398			case 0x88: // MOV r/m8, r8
399			transfer_size = SIZE_BYTE;
400			case 0x89: // MOV r/m32, r32 (or 16-bit operation)
401			switch (eip[1] & 0xc0) {
402			case 0x80:
403			reg = (eip[1] >> 3) & 7;
404			transfer_type = TYPE_STORE;
405			break;
406			case 0x40:
407			reg = (eip[1] >> 3) & 7;
408			transfer_type = TYPE_STORE;
409			break;
410			case 0x00:
411			reg = (eip[1] >> 3) & 7;
412			transfer_type = TYPE_STORE;
413			break;
414			}
415			len += 2 + ix86_step_over_modrm(eip + 1);
416			break;
417			}
418
419			if (transfer_type == TYPE_UNKNOWN) {
420			// Unknown machine code, let it crash. Then patch the decoder
421			return false;
422			}
423
424			if (transfer_type == TYPE_LOAD && reg != -1) {
425			static const int x86_reg_map[8] = {
426			X86_REG_EAX, X86_REG_ECX, X86_REG_EDX, X86_REG_EBX,
427			X86_REG_ESP, X86_REG_EBP, X86_REG_ESI, X86_REG_EDI
428			};
429
430			if (reg < 0 \|\| reg >= 8)
431			return false;
432
433			int rloc = x86_reg_map[reg];
434			switch (transfer_size) {
435			case SIZE_BYTE:
436			regs[rloc] = (regs[rloc] & ~0xff);
437			break;
438			case SIZE_WORD:
439			regs[rloc] = (regs[rloc] & ~0xffff);
440			break;
441			case SIZE_LONG:
442			regs[rloc] = 0;
443			break;
444			}
445			}
446
447			#if DEBUG
448			printf("%08x: %s %s access", regs[X86_REG_EIP],
449			transfer_size == SIZE_BYTE ? "byte" : transfer_size == SIZE_WORD ? "word" : "long",
450			transfer_type == TYPE_LOAD ? "read" : "write");
451
452			if (reg != -1) {
453			static const char * x86_reg_str_map[8] = {
454			"eax", "ecx", "edx", "ebx",
455			"esp", "ebp", "esi", "edi"
456			};
457			printf(" %s register %%%s", transfer_type == TYPE_LOAD ? "to" : "from", x86_reg_str_map[reg]);
458			}
459			printf(", %d bytes instruction\n", len);
460			#endif
461
462			regs[X86_REG_EIP] += len;
463			return true;
464			}
465			#endif
466			#endif
467
468	gbeauche	1.1	// Fallbacks
469			#ifndef SIGSEGV_FAULT_INSTRUCTION
470			#define SIGSEGV_FAULT_INSTRUCTION SIGSEGV_INVALID_PC
471			#endif
472
473	gbeauche	1.2	// SIGSEGV recovery supported ?
474			#if defined(SIGSEGV_ALL_SIGNALS) && defined(SIGSEGV_FAULT_HANDLER_ARGLIST) && defined(SIGSEGV_FAULT_ADDRESS)
475			#define HAVE_SIGSEGV_RECOVERY
476			#endif
477
478	gbeauche	1.1
479			/*
480			* SIGSEGV global handler
481			*/
482
483	gbeauche	1.2	#ifdef HAVE_SIGSEGV_RECOVERY
484	gbeauche	1.1	static void sigsegv_handler(SIGSEGV_FAULT_HANDLER_ARGLIST)
485			{
486	gbeauche	1.10	sigsegv_address_t fault_address = (sigsegv_address_t)SIGSEGV_FAULT_ADDRESS;
487			sigsegv_address_t fault_instruction = (sigsegv_address_t)SIGSEGV_FAULT_INSTRUCTION;
488			bool fault_recovered = false;
489
490	gbeauche	1.1	// Call user's handler and reinstall the global handler, if required
491	gbeauche	1.12	if (sigsegv_fault_handler(fault_address, fault_instruction)) {
492	gbeauche	1.1	#if (defined(HAVE_SIGACTION) ? defined(SIGACTION_NEED_REINSTALL) : defined(SIGNAL_NEED_REINSTALL))
493			sigsegv_do_install_handler(sig);
494			#endif
495	gbeauche	1.10	fault_recovered = true;
496	gbeauche	1.1	}
497	gbeauche	1.10	#if HAVE_SIGSEGV_SKIP_INSTRUCTION
498			else if (sigsegv_ignore_fault) {
499			// Call the instruction skipper with the register file available
500			if (SIGSEGV_SKIP_INSTRUCTION(fault_instruction, SIGSEGV_REGISTER_FILE))
501			fault_recovered = true;
502			}
503			#endif
504
505			if (!fault_recovered) {
506	gbeauche	1.1	// FAIL: reinstall default handler for "safe" crash
507			#define FAULT_HANDLER(sig) signal(sig, SIG_DFL);
508			SIGSEGV_ALL_SIGNALS
509			#undef FAULT_HANDLER
510	gbeauche	1.10
511			// We can't do anything with the fault_address, dump state?
512	gbeauche	1.12	if (sigsegv_state_dumper != 0)
513			sigsegv_state_dumper(fault_address, fault_instruction);
514	gbeauche	1.1	}
515			}
516	gbeauche	1.2	#endif
517	gbeauche	1.1
518
519			/*
520			* SIGSEGV handler initialization
521			*/
522
523			#if defined(HAVE_SIGINFO_T)
524			static bool sigsegv_do_install_handler(int sig)
525			{
526			// Setup SIGSEGV handler to process writes to frame buffer
527			#ifdef HAVE_SIGACTION
528			struct sigaction vosf_sa;
529			sigemptyset(&vosf_sa.sa_mask);
530			vosf_sa.sa_sigaction = sigsegv_handler;
531			vosf_sa.sa_flags = SA_SIGINFO;
532			return (sigaction(sig, &vosf_sa, 0) == 0);
533			#else
534			return (signal(sig, (signal_handler)sigsegv_handler) != SIG_ERR);
535			#endif
536			}
537	gbeauche	1.2	#endif
538
539			#if defined(HAVE_SIGCONTEXT_SUBTERFUGE)
540	gbeauche	1.1	static bool sigsegv_do_install_handler(int sig)
541			{
542			// Setup SIGSEGV handler to process writes to frame buffer
543			#ifdef HAVE_SIGACTION
544			struct sigaction vosf_sa;
545			sigemptyset(&vosf_sa.sa_mask);
546			vosf_sa.sa_handler = (signal_handler)sigsegv_handler;
547			#if !EMULATED_68K && defined(__NetBSD__)
548			sigaddset(&vosf_sa.sa_mask, SIGALRM);
549			vosf_sa.sa_flags = SA_ONSTACK;
550			#else
551			vosf_sa.sa_flags = 0;
552			#endif
553			return (sigaction(sig, &vosf_sa, 0) == 0);
554			#else
555			return (signal(sig, (signal_handler)sigsegv_handler) != SIG_ERR);
556			#endif
557			}
558			#endif
559
560	gbeauche	1.12	bool sigsegv_install_handler(sigsegv_fault_handler_t handler)
561	gbeauche	1.1	{
562	gbeauche	1.2	#ifdef HAVE_SIGSEGV_RECOVERY
563	gbeauche	1.12	sigsegv_fault_handler = handler;
564	gbeauche	1.1	bool success = true;
565			#define FAULT_HANDLER(sig) success = success && sigsegv_do_install_handler(sig);
566			SIGSEGV_ALL_SIGNALS
567			#undef FAULT_HANDLER
568			return success;
569			#else
570			// FAIL: no siginfo_t nor sigcontext subterfuge is available
571			return false;
572			#endif
573			}
574
575
576			/*
577			* SIGSEGV handler deinitialization
578			*/
579
580			void sigsegv_deinstall_handler(void)
581			{
582	gbeauche	1.2	#ifdef HAVE_SIGSEGV_RECOVERY
583	gbeauche	1.12	sigsegv_fault_handler = 0;
584	gbeauche	1.1	#define FAULT_HANDLER(sig) signal(sig, SIG_DFL);
585			SIGSEGV_ALL_SIGNALS
586			#undef FAULT_HANDLER
587	gbeauche	1.2	#endif
588	gbeauche	1.1	}
589
590	gbeauche	1.10
591			/*
592			* SIGSEGV ignore state modifier
593			*/
594
595			void sigsegv_set_ignore_state(bool ignore_fault)
596			{
597			sigsegv_ignore_fault = ignore_fault;
598			}
599
600
601			/*
602			* Set callback function when we cannot handle the fault
603			*/
604
605	gbeauche	1.12	void sigsegv_set_dump_state(sigsegv_state_dumper_t handler)
606	gbeauche	1.10	{
607	gbeauche	1.12	sigsegv_state_dumper = handler;
608	gbeauche	1.10	}
609
610
611	gbeauche	1.1	/*
612			* Test program used for configure/test
613			*/
614
615	gbeauche	1.4	#ifdef CONFIGURE_TEST_SIGSEGV_RECOVERY
616	gbeauche	1.1	#include <stdio.h>
617			#include <stdlib.h>
618			#include <fcntl.h>
619			#include <sys/mman.h>
620	gbeauche	1.4	#include "vm_alloc.h"
621	gbeauche	1.1
622			static int page_size;
623	gbeauche	1.3	static volatile char * page = 0;
624			static volatile int handler_called = 0;
625	gbeauche	1.1
626			static bool sigsegv_test_handler(sigsegv_address_t fault_address, sigsegv_address_t instruction_address)
627			{
628			handler_called++;
629			if ((fault_address - 123) != page)
630			exit(1);
631	gbeauche	1.4	if (vm_protect((char *)((unsigned long)fault_address & -page_size), page_size, VM_PAGE_READ \| VM_PAGE_WRITE) != 0)
632	gbeauche	1.1	exit(1);
633			return true;
634			}
635
636	gbeauche	1.10	#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
637			static bool sigsegv_insn_handler(sigsegv_address_t fault_address, sigsegv_address_t instruction_address)
638			{
639			return false;
640			}
641			#endif
642
643	gbeauche	1.1	int main(void)
644			{
645	gbeauche	1.4	if (vm_init() < 0)
646	gbeauche	1.1	return 1;
647
648			page_size = getpagesize();
649	gbeauche	1.4	if ((page = (char *)vm_acquire(page_size)) == VM_MAP_FAILED)
650			return 1;
651
652			if (vm_protect((char *)page, page_size, VM_PAGE_READ) < 0)
653	gbeauche	1.1	return 1;
654
655			if (!sigsegv_install_handler(sigsegv_test_handler))
656			return 1;
657
658			page[123] = 45;
659			page[123] = 45;
660
661			if (handler_called != 1)
662			return 1;
663	gbeauche	1.10
664			#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
665			if (!sigsegv_install_handler(sigsegv_insn_handler))
666			return 1;
667
668			if (vm_protect((char *)page, page_size, VM_PAGE_WRITE) < 0)
669			return 1;
670
671			for (int i = 0; i < page_size; i++)
672			page[i] = (i + 1) % page_size;
673
674			if (vm_protect((char *)page, page_size, VM_PAGE_NOACCESS) < 0)
675			return 1;
676
677			sigsegv_set_ignore_state(true);
678
679			#define TEST_SKIP_INSTRUCTION(TYPE) do { \
680			const unsigned int TAG = 0x12345678; \
681			TYPE data = ((TYPE )(page + sizeof(TYPE))); \
682			volatile unsigned int effect = data + TAG; \
683			if (effect != TAG) \
684			return 1; \
685			} while (0)
686
687			TEST_SKIP_INSTRUCTION(unsigned char);
688			TEST_SKIP_INSTRUCTION(unsigned short);
689			TEST_SKIP_INSTRUCTION(unsigned int);
690			#endif
691	gbeauche	1.1
692	gbeauche	1.4	vm_exit();
693	gbeauche	1.1	return 0;
694			}
695			#endif