1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* ss.h: STACK SCANNING
 *
 * $Id: //info.ravenbrook.com/project/mps/version/1.117/code/ss.h#1 $
 * Copyright (c) 2001 Ravenbrook Limited.  See end of file for license.
 *
 * This module saves the mutator context on entry to the MPS, and
 * provides functions for decoding the context and scanning the root
 * registers. See <design/stack-scan/>.
 */

#ifndef ss_h
#define ss_h

#include "mpm.h"

     
/* StackContext -- some of the mutator's state
 *
 * The jumpBuffer is used to capture most of the mutator's state on
 * entry to the MPS, but can't capture it all.  See
 * design.mps.stack-scan.sol.setjmp.scan.
 */

#include <setjmp.h>

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;


/* StackHot -- capture a hot stack pointer
 *
 * Sets *stackOut to a stack pointer that includes the current frame.
 */

void StackHot(void **stackOut);


/* STACK_CONTEXT_BEGIN -- save context */

#define STACK_CONTEXT_BEGIN(arena) \
  BEGIN \
    StackContextStruct _sc; \
    STACK_CONTEXT_SAVE(&_sc); \
    AVER(arena->stackWarm == NULL); \
    StackHot(&arena->stackWarm); \
    AVER(arena->stackWarm < (void *)&_sc); /* <code/ss.c#assume.desc> */ \
    BEGIN


/* STACK_CONTEXT_END -- clear context */

#define STACK_CONTEXT_END(arena) \
    END; \
    AVER(arena->stackWarm != NULL); \
    arena->stackWarm = NULL; \
  END


/* STACK_CONTEXT_SAVE -- save the callee-saves and stack pointer */

#if defined(MPS_OS_XC)

/* We call _setjmp rather than setjmp because we can be confident what
 * it does via the source code at
 * <http://www.opensource.apple.com/source/Libc/Libc-825.24/i386/sys/_setjmp.s>,
 * and because _setjmp saves only the register set and the stack while
 * setjmp also saves the signal mask, which we don't care about. See
 * _setjmp(2). */

#define STACK_CONTEXT_SAVE(sc) ((void)_setjmp((sc)->jumpBuffer))

#else  /* other platforms */

#define STACK_CONTEXT_SAVE(sc) ((void)setjmp((sc)->jumpBuffer))

#endif /* platform defines */


/* StackScan -- scan the mutator's stack and registers
 *
 * This must be called between STACK_CONTEXT_BEGIN and
 * STACK_CONTEXT_END.
 */

extern Res StackScan(ScanState ss, void *stackCold,
                      mps_area_scan_t scan_area, void *closure);


#endif /* ss_h */


/* C. COPYRIGHT AND LICENSE
 *
 * Copyright (C) 2001-2002 Ravenbrook Limited <http://www.ravenbrook.com/>.
 * All rights reserved.  This is an open source license.  Contact
 * Ravenbrook for commercial licensing options.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * 3. Redistributions in any form must be accompanied by information on how
 * to obtain complete source code for this software and any accompanying
 * software that uses this software.  The source code must either be
 * included in the distribution or be available for no more than the cost
 * of distribution plus a nominal fee, and must be freely redistributable
 * under reasonable conditions.  For an executable file, complete source
 * code means the source code for all modules it contains. It does not
 * include source code for modules or files that typically accompany the
 * major components of the operating system on which the executable file
 * runs.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */