annotate dyncallback/dyncall_thunk.h @ 0:3e629dc19168

initial from svn dyncall-1745
author Daniel Adler
date Thu, 19 Mar 2015 22:24:28 +0100
parents
children 1ce60358fbad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 /*
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3 Package: dyncall
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 Library: dyncallback
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 File: dyncallback/dyncall_thunk.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6 Description: Thunk - Interface
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 License:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9 Copyright (c) 2007-2015 Daniel Adler <dadler@uni-goettingen.de>,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10 Tassilo Philipp <tphilipp@potion-studios.com>
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12 Permission to use, copy, modify, and distribute this software for any
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 purpose with or without fee is hereby granted, provided that the above
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14 copyright notice and this permission notice appear in all copies.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 */
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 #ifndef DYNCALL_THUNK_H
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 #define DYNCALL_THUNK_H
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 /**
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 ** dyncall thunks
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 ** thunks are small-size hybrid code/data objects, created at run-time to
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34 ** be used as function pointers with associated data and entry functions.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 ** The header contains code, that does load its address into a designated scratch
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 ** register and will jump to a thunk function.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 ** Thunk entry procedures are compiled functions, that are called as a result of
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 ** a thunk function.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 ** There is one thunk entry currently for supporting callbacks.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43 ** Thunk context register ( ::= an available scratch register in the calling convention):
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 ** x86: eax
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46 ** x64: rax
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47 ** ppc: r2
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 ** arm: r12
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 ** arm64: x9
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
50 **
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51 **/
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53 #include "dyncall_macros.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
55 typedef struct DCThunk_ DCThunk;
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
56
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
57 #ifdef __cplusplus
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
58 extern "C" {
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
59 #endif
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
60
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
61 void dcbInitThunk(DCThunk* p, void (*entry)());
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
62
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
63 #if defined(DC__Arch_Intel_x86)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
64 #include "dyncall_thunk_x86.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
65 #elif defined (DC__Arch_AMD64)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
66 #include "dyncall_thunk_x64.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
67 #elif defined (DC__Arch_PPC32)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
68 #include "dyncall_thunk_ppc32.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
69 #elif defined (DC__Arch_PPC64)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
70 #include "dyncall_thunk_ppc64.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
71 #elif defined (DC__Arch_ARM_ARM)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
72 #include "dyncall_thunk_arm32_arm.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
73 #elif defined (DC__Arch_ARM_THUMB)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
74 #include "dyncall_thunk_arm32_thumb.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
75 #elif defined (DC__Arch_MIPS)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
76 #include "dyncall_thunk_mips.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
77 #elif defined (DC__Arch_Sparc)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
78 #include "dyncall_thunk_sparc32.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
79 #elif defined (DC__Arch_Sparcv9)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
80 #include "dyncall_thunk_sparc64.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
81 #elif defined (DC__Arch_ARM64)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
82 #include "dyncall_thunk_arm64.h"
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
83 #endif
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
84
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
85 #ifdef __cplusplus
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
86 }
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
87 #endif
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
88
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
89
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
90 #endif /* DYNCALL_THUNK_H */