-
Notifications
You must be signed in to change notification settings - Fork 5
/
SDI_hook.h
315 lines (295 loc) · 16.5 KB
/
SDI_hook.h
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
#ifndef SDI_HOOK_H
#define SDI_HOOK_H
/* Includeheader
Name: SDI_hook.h
Versionstring: $VER: SDI_hook.h 1.27 (04.04.2015)
Authors: Dirk Stoecker, Jens Maus
Distribution: PD
Project page: https://github.com/adtools/SDI
Description: defines to hide compiler specific hook stuff
1.0 21.06.02 : based on the work made for freeciv and YAM with
additional texts partly taken from YAM_hook.h changes made
by Jens Langner, largely reworked the mechanism
1.1 07.10.02 : added HOOKPROTONP and HOOKPROTONONP requested by Jens
1.2 18.10.02 : reverted to old MorphOS-method for GCC
1.3 08.02.04 : modified to get it compatible to AmigaOS4
1.4 17.02.04 : modified to get compatible to latest SDI_compiler.h changes
1.5 02.03.04 : added UNUSED define to OS4 hook specification so that the
compiler can ignore some warnings.
1.6 02.03.04 : added (APTR) casts to MorphOS prototype definition to
reduce compiler warnings.
1.7 04.07.04 : removed static from all DISPATCHERPROTO definitions as there
may be dispatchers that are of course non static.
1.8 07.04.05 : added MakeHookWithData (Sebastian Bauer)
1.9 08.04.05 : changed MorphOS hooks to use HookEntry (Ilkka Lehtoranta)
1.10 16.05.05 : simplified and fixed for vbcc/MorphOS (Frank Wille)
1.11 17.05.05 : changed cast in DISPATCHERPROTO from (void(*)()) to APTR
cause SDI version of the EmulLibEntry uses APTR for easy
usage.
Added #ifndef SDI_TRAP_LIB to avoid double defines when
combining with SDI_interrupt.h or SDI_misc.h (Guido
Mersmann)
1.12 18.05.05 : DISPATCHERPROTO wasn't working, because of the missing REG_Ax
definitions. Added include <emul/emulregs.h> (Guido Mersmann)
1.13 11.12.05 : fixed a minor typo in the PPC HOOKPROTONP macro.
(Jens Langner)
1.14 20.04.06 : unified static of MorphOs with non-MorphOS vesion
1.15 30.04.06 : modified to get it compatible to AROS. (Guido Mersmann)
1.16 06.10.06 : added new DISPATCHER() macro and separated it from the
DISPATCHERPROTO() definition. Now the DISPATCHERPROTO() should
only be used to get the correct prototype and the plain
DISPATCHER() for defining the dispatcher itself.
1.17 14.07.08 : added "_" to all UNUSED variable specifications to make sure
a user does not use those definition on accident.
1.18 20.03.09 : modified macros to be somewhat more compatible for an AROS
usage (Pavel Fedin)
1.19 25.03.09 : fixed the DISPATCHERPROTO() macros for x86_64 AROS.
1.20 26.03.09 : fixed m68k define checks.
1.21 19.05.09 : added SDISPATCHER() to generate a static dispatcher.
1.22 24.06.10 : fixed AROS macros (Matthias Rustler).
1.23 12.08.10 : added missing proto/alib.h include for AROS
1.24 03.03.11 : fixed AROS macros for m68k (Jason McMullan)
1.25 18.07.12 : added crosscall macros for functions with 1 and 2 parameters.
These macros are to be used in case i.e. PPC code is to be called
from m68k code. The function pointer must be passed with ENTRY().
1.26 17.10.12 : added crosscall macros for functions with 1 and 2 parameters but
no return value.
1.27 04.04.15 : fixed HOOKPROTO for vbcc (Fredrik Wikstrom)
1.28 12.07.16 : fixed HOOKPROTO for vbcc (O. Sezer)
*/
/*
** This is PD (Public Domain). This means you can do with it whatever you want
** without any restrictions. I only ask you to tell me improvements, so I may
** fix the main line of this files as well.
**
** To keep confusion level low: When changing this file, please note it in
** above history list and indicate that the change was not made by myself
** (e.g. add your name or nick name).
**
** Find the latest version of this file at:
** https://github.com/adtools/SDI
**
** Jens Maus <mail@jens-maus.de>
** Dirk Stoecker <soft@dstoecker.de>
*/
#include "SDI_compiler.h"
/*
** Hook macros to handle the creation of Hooks/Dispatchers for different
** Operating System versions.
** Currently AmigaOS, AROS, and MorphOS are supported.
**
** For more information about hooks see include file <utility/hooks.h> or
** the relevant descriptions in utility.library autodocs.
**
** Example:
**
** Creates a hook with the name "TestHook" that calls a corresponding
** function "TestFunc" that will be called with a pointer "text"
** (in register A1) and returns a long.
**
** HOOKPROTONHNO(TestFunc, LONG, STRPTR text)
** {
** Printf(text);
** return 0;
** }
** MakeHook(TestHook, TestFunc);
**
** Every function that is created with HOOKPROTO* must have a MakeHook() or
** MakeStaticHook() to create the corresponding hook. Best is to call this
** directly after the hook function. This is required by the GCC macros.
**
** The naming convention for the Hook Prototype macros is as followed:
**
** HOOKPROTO[NH][NO][NP]
** ^^ ^^ ^^
** NoHook | NoParameter
** NoObject
**
** So a plain HOOKPROTO() creates you a Hook function that requires
** 4 parameters, the "name" of the hookfunction, the "obj" in REG_A2,
** the "param" in REG_A1 and a "hook" in REG_A0. Usually you will always
** use NH, as the hook structure itself is nearly never required.
**
** The DISPATCHERPROTO macro is for MUI dispatcher functions. It gets the
** functionname as argument. To supply this function for use by MUI, use
** The ENTRY macro, which also gets the function name as argument.
*/
#if !defined(__AROS__) && (defined(_M68000) || defined(__M68000) || defined(__mc68000) || defined(__M68K__))
#define HOOKPROTO(name, ret, obj, param) static SAVEDS ASM ret \
name(REG(a0, struct Hook *hook), REG(a2, obj), REG(a1, param))
#define HOOKPROTONO(name, ret, param) static SAVEDS ASM ret \
name(REG(a0, struct Hook *hook), REG(a1, param))
#define HOOKPROTONP(name, ret, obj) static SAVEDS ASM ret \
name(REG(a0, struct Hook *hook), REG(a2, obj))
#define HOOKPROTONONP(name, ret) static SAVEDS ASM ret \
name(REG(a0, struct Hook *hook))
#define HOOKPROTONH(name, ret, obj, param) static SAVEDS ASM ret \
name(REG(a2, obj), REG(a1, param))
#define HOOKPROTONHNO(name, ret, param) static SAVEDS ASM ret \
name(REG(a1, param))
#define HOOKPROTONHNP(name, ret, obj) static SAVEDS ASM ret \
name(REG(a2, obj))
#define HOOKPROTONHNONP(name, ret) static SAVEDS ret name(void)
#else
/* NOTE: This is fine for AROS, since HookEntry will handle stack params
*/
#define HOOKPROTO(name, ret, obj, param) static SAVEDS ret \
name(struct Hook *hook, obj, param)
#define HOOKPROTONO(name, ret, param) static SAVEDS ret \
name(struct Hook *hook, UNUSED APTR _obj, param)
#define HOOKPROTONP(name, ret, obj) static SAVEDS ret \
name(struct Hook *hook, obj, UNUSED APTR _param)
#define HOOKPROTONONP(name, ret) static SAVEDS ret \
name(struct Hook *hook, UNUSED APTR _obj, UNUSED APTR _param)
#define HOOKPROTONH(name, ret, obj, param) static SAVEDS ret \
name(UNUSED struct Hook *_hook, obj, param)
#define HOOKPROTONHNO(name, ret, param) static SAVEDS ret \
name(UNUSED struct Hook *_hook, UNUSED APTR _obj, param)
#define HOOKPROTONHNP(name, ret, obj) static SAVEDS ret \
name(UNUSED struct Hook *_hook, obj, UNUSED APTR _param)
#define HOOKPROTONHNONP(name, ret) static SAVEDS ret name(void)
#endif
#ifdef __MORPHOS__
#ifndef SDI_TRAP_LIB /* avoid defining this twice */
#include <proto/alib.h>
#include <emul/emulregs.h>
#define SDI_TRAP_LIB 0xFF00 /* SDI prefix to reduce conflicts */
struct SDI_EmulLibEntry
{
UWORD Trap;
UWORD pad;
APTR Func;
};
#endif
#define MakeHook(hookname, funcname) struct Hook hookname = {{NULL, NULL}, \
(HOOKFUNC)HookEntry, (HOOKFUNC)funcname, NULL}
#define MakeHookWithData(hookname, funcname, data) struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)HookEntry, (HOOKFUNC)funcname, (APTR)data}
#define MakeStaticHook(hookname, funcname) static struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)HookEntry, (HOOKFUNC)funcname, NULL}
#define DISPATCHERPROTO(name) ULONG name(struct IClass * cl, Object * obj, \
Msg msg); \
extern const struct SDI_EmulLibEntry Gate_##name
#define DISPATCHER(name) \
struct IClass; \
ULONG name(struct IClass * cl, Object * obj, Msg msg); \
static ULONG Trampoline_##name(void) {return name((struct IClass *) \
REG_A0, (Object *) REG_A2, (Msg) REG_A1);} \
const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
ULONG name(struct IClass * cl, Object * obj, Msg msg)
#define SDISPATCHER(name) \
struct IClass; \
static ULONG name(struct IClass * cl, Object * obj, Msg msg); \
static ULONG Trampoline_##name(void) {return name((struct IClass *) \
REG_A0, (Object *) REG_A2, (Msg) REG_A1);} \
static const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
static ULONG name(struct IClass * cl, Object * obj, Msg msg)
#define CROSSCALL1(name, ret, type1, param1) \
static STDARGS SAVEDS ret name(type1 param1); \
static ret Trampoline_##name(void) \
{ \
ULONG *stk = (ULONG *)REG_A7; \
type1 param1 = (type1)stk[1]; \
return name(param1); \
} \
static const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
static STDARGS SAVEDS ret name(type1 param1, type2 param2)
#define CROSSCALL1NR(name, type1, param1) \
static STDARGS SAVEDS void name(type1 param1); \
static void Trampoline_##name(void) \
{ \
ULONG *stk = (ULONG *)REG_A7; \
type1 param1 = (type1)stk[1]; \
name(param1); \
} \
static const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
static STDARGS SAVEDS void name(type1 param1)
#define CROSSCALL2(name, ret, type1, param1, type2, param2) \
static STDARGS SAVEDS ret name(type1 param1, type2 param2); \
static ret Trampoline_##name(void) \
{ \
ULONG *stk = (ULONG *)REG_A7; \
type1 param1 = (type1)stk[1]; \
type2 param2 = (type2)stk[2]; \
return name(param1, param2); \
} \
static const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
static STDARGS SAVEDS ret name(type1 param1, type2 param2)
#define CROSSCALL2NR(name, type1, param1, type2, param2) \
static STDARGS SAVEDS void name(type1 param1, type2 param2); \
static void Trampoline_##name(void) \
{ \
ULONG *stk = (ULONG *)REG_A7; \
type1 param1 = (type1)stk[1]; \
type2 param2 = (type2)stk[2]; \
name(param1, param2); \
} \
static const struct SDI_EmulLibEntry Gate_##name = {SDI_TRAP_LIB, 0, \
(APTR) Trampoline_##name}; \
static STDARGS SAVEDS void name(type1 param1, type2 param2)
#define ENTRY(func) (APTR)&Gate_##func
#elif defined(__AROS__)
#include <proto/alib.h>
#define MakeHook(hookname, funcname) struct Hook hookname = {{NULL, NULL}, \
(HOOKFUNC)HookEntry, (HOOKFUNC)funcname, NULL}
#define MakeHookWithData(hookname, funcname, data) struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)HookEntry, (HOOKFUNC)funcname, (APTR)data}
#define MakeStaticHook(hookname, funcname) static struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)HookEntry, (HOOKFUNC)funcname, NULL}
#define DISPATCHERPROTO(name) \
IPTR name(struct IClass * cl, Object * obj, Msg msg); \
AROS_UFP3(IPTR, Gate_##name, \
AROS_UFPA(struct IClass *, cl, A0), \
AROS_UFPA(Object *, obj, A2), \
AROS_UFPA(Msg, msg, A1))
#define DISPATCHERx(x,name) \
x IPTR name(struct IClass * cl, Object * obj, Msg msg); \
x AROS_UFH3(IPTR, Gate_##name, \
AROS_UFHA(struct IClass *, cl, A0), \
AROS_UFHA(Object *, obj, A2), \
AROS_UFHA(Msg, msg, A1)) \
{ AROS_USERFUNC_INIT \
return name(cl, obj, msg); \
AROS_USERFUNC_EXIT \
} \
x IPTR name(struct IClass * cl, Object * obj, Msg msg)
#define DISPATCHER(name) DISPATCHERx(,name)
#define SDISPATCHER(name) DISPATCHERx(static,name)
#define CROSSCALL1(name, ret, type1, param1) \
static STDARGS SAVEDS ret Gate_##name(type1 param1)
#define CROSSCALL1NR(name, type1, param1) \
static STDARGS SAVEDS void Gate_##name(type1 param1)
#define CROSSCALL2(name, ret, type1, param1, type2, param2) \
static STDARGS SAVEDS ret Gate_##name(type1 param1, type2 param2)
#define CROSSCALL2NR(name, type1, param1, type2, param2) \
static STDARGS SAVEDS void Gate_##name(type1 param1, type2 param2)
#define ENTRY(func) (APTR)Gate_##func
#else /* !__MORPHOS__ && !__AROS__*/
#define MakeHook(hookname, funcname) struct Hook hookname = {{NULL, NULL}, \
(HOOKFUNC)funcname, NULL, NULL}
#define MakeHookWithData(hookname, funcname, data) struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)funcname, NULL, (APTR)data}
#define MakeStaticHook(hookname, funcname) static struct Hook hookname = \
{{NULL, NULL}, (HOOKFUNC)funcname, NULL, NULL}
#define DISPATCHERPROTO(name) SAVEDS ASM IPTR name(REG(a0, \
struct IClass * cl), REG(a2, Object * obj), REG(a1, Msg msg))
#define DISPATCHER(name) DISPATCHERPROTO(name)
#define SDISPATCHER(name) static DISPATCHERPROTO(name)
#define CROSSCALL1(name, ret, type1, param1) \
static STDARGS SAVEDS ret name(type1 param1)
#define CROSSCALL1NR(name, type1, param1) \
static STDARGS SAVEDS void name(type1 param1)
#define CROSSCALL2(name, ret, type1, param1, type2, param2) \
static STDARGS SAVEDS ret name(type1 param1, type2 param2)
#define CROSSCALL2NR(name, type1, param1, type2, param2) \
static STDARGS SAVEDS void name(type1 param1, type2 param2)
#define ENTRY(func) (APTR)func
#endif
#define InitHook(hook, orighook, data) ((hook)->h_Entry = (orighook).h_Entry,\
(hook)->h_SubEntry = (orighook).h_SubEntry,(hook)->h_Data = (APTR)(data))
#endif /* SDI_HOOK_H */