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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/* sc.h: STACK CONTEXT
 *
 * $Id: //info.ravenbrook.com/project/mps/custom/cet/branch/2016-09-13/job004006/code/sc.h#1 $
 * Copyright (c) 2012 Ravenbrook Limited.  See end of file for license.
 *
 * Provides a context to hold the registers and stack pointer
 * 
 * This file provide wrappers for using setjmp or some similar mechanism
 * to save the current callee-saves on the stack.
 *
 * See http://info.ravenbrook.com/mail/2012/08/03/14-36-35/0/ and the rest of
 * the thread for the origin of the idea.
 * 
 * TODO: Make StackScan take a StackContext
 */

#ifndef sc_h
#define sc_h

#include "mpm.h"

     
/* StackContext -- holds the registers including a stack pointer
 *
 * This contains the callee-save registers and the stack pointer.
 *
 * This is used to save the registers after or on entry to the arena so that
 * they can be scanned.
 */

/* STACK_CONTEXT_SAVE - save the callee-saves and stack pointer
 * 
 * This macro saves the callee-saves and stack pointer for the
 * current function into the passed StackContext.  The StackContext
 * is no longer valid after the function returns.
 *
 * This needs to be a macro because the compiler may need to do
 * setjmp magic.
 */
 
/* StackContextStackHot - return the hot end of the stack from the stack context
 * 
 * We assume the stack is full.  In other words the stack top points at
 * a word that contains a potential Ref.
 */


/* Mac OS X on 32-bit Intel built with Clang or GCC */

#if defined(MPS_PF_XCI3LL) || defined(MPS_PF_XCI3GC)

#include <setjmp.h>

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;

/* See the implementation of _setjmp in
 * <http://www.opensource.apple.com/source/Libc/Libc-825.24/i386/sys/_setjmp.s> */

#define JB_ESP 36 /* offset into the jmp_buf in bytes as defined in _setjmp.s */

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

#define StackContextSP(sc) ((Addr *)(sc)->jumpBuffer[JB_ESP/sizeof(int)])

/* On MacOS X the stackPointer can end up pointing above the StackContext
 * which we assume to be stored on the stack because it is no longer
 * needed once we have _longjmp()ed back. So take the minimum of the 
 * SP and the base of the StackContext structure. */
#define StackContextStackHot(sc) \
  (StackContextSP(sc) < (Addr*)(sc) ? StackContextSP(sc) : (Addr*)(sc))


/* Mac OS X on 64-bit Intel build with Clang or GCC */

#elif defined(MPS_PF_XCI6LL) || defined(MPS_PF_XCI6GC)

#include <setjmp.h>

/* We could use getcontext() from libunwind but that produces
 * deprecation warnings.  See
 * <http://stackoverflow.com/questions/3592914/how-can-i-implement-cooperative-lightweight-threading-with-c-on-mac-os-x>
 */

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;

/* See the implementation of _setjmp in
 * <http://www.opensource.apple.com/source/Libc/Libc-825.24/x86_64/sys/_setjmp.s> */

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

#define JB_RSP 16 /* offset into the jmp_buf in bytes as defined in _setjmp.s */

/* jmp_buf is an int[] but the stack pointer is 8 bytes so we need a cast */
/* FIXME: possible aliasing problem */
#define StackContextSP(sc) \
  (*(Addr **)((char *)(sc)->jumpBuffer+JB_RSP))

/* On MacOS X the stackPointer can end up pointing above the StackContext
 * which we assume to be stored on the stack because it is no longer
 * needed once we have _longjmp()ed back. So take the minimum of the 
 * SP and the base of the StackContext structure. */
#define StackContextStackHot(sc) \
  (StackContextSP(sc) < (Addr*)(sc) ? StackContextSP(sc) : (Addr*)(sc))


/* Windows on 32-bit Intel with Microsoft Visual Studio */

#elif defined(MPS_PF_W3I3MV)

#include <setjmp.h>

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;

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

#define StackContextStackHot(sc) \
  ((Addr *)((_JUMP_BUFFER *)(sc)->jumpBuffer)->Esp)


/* Windows on 64-bit Intel with Microsoft Visual Studio */

#elif defined(MPS_PF_W3I6MV)

#include <setjmp.h>

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;

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

#define StackContextStackHot(sc) \
  ((Addr *)((_JUMP_BUFFER *)(sc)->jumpBuffer)->Rsp)


#else

/* TODO: implement this on other platforms in a safer way.
 * Potentially the callee saves from the calling function could be spilled
 * underneath the jmp_buf so returning the address of the jmp_buf for the
 * stack top is not completely safe.  
 */

#include <setjmp.h>

typedef struct StackContextStruct {
  jmp_buf jumpBuffer;
} StackContextStruct;

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

#define StackContextStackHot(sc) ((Addr *)(sc)->jumpBuffer)


#endif /* platform defines */

#endif /* sc_h */


/* C. COPYRIGHT AND LICENSE
 *
 * Copyright (C) 2001-2012 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.
 */