1*1fd5a2e1SPrashanth Swaminathan /*
2*1fd5a2e1SPrashanth Swaminathan * Copyright (c) 2013 Miodrag Vallat. <[email protected]>
3*1fd5a2e1SPrashanth Swaminathan *
4*1fd5a2e1SPrashanth Swaminathan * Permission is hereby granted, free of charge, to any person obtaining
5*1fd5a2e1SPrashanth Swaminathan * a copy of this software and associated documentation files (the
6*1fd5a2e1SPrashanth Swaminathan * ``Software''), to deal in the Software without restriction, including
7*1fd5a2e1SPrashanth Swaminathan * without limitation the rights to use, copy, modify, merge, publish,
8*1fd5a2e1SPrashanth Swaminathan * distribute, sublicense, and/or sell copies of the Software, and to
9*1fd5a2e1SPrashanth Swaminathan * permit persons to whom the Software is furnished to do so, subject to
10*1fd5a2e1SPrashanth Swaminathan * the following conditions:
11*1fd5a2e1SPrashanth Swaminathan *
12*1fd5a2e1SPrashanth Swaminathan * The above copyright notice and this permission notice shall be included
13*1fd5a2e1SPrashanth Swaminathan * in all copies or substantial portions of the Software.
14*1fd5a2e1SPrashanth Swaminathan *
15*1fd5a2e1SPrashanth Swaminathan * THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND,
16*1fd5a2e1SPrashanth Swaminathan * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17*1fd5a2e1SPrashanth Swaminathan * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18*1fd5a2e1SPrashanth Swaminathan * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19*1fd5a2e1SPrashanth Swaminathan * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20*1fd5a2e1SPrashanth Swaminathan * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21*1fd5a2e1SPrashanth Swaminathan * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22*1fd5a2e1SPrashanth Swaminathan */
23*1fd5a2e1SPrashanth Swaminathan
24*1fd5a2e1SPrashanth Swaminathan /*
25*1fd5a2e1SPrashanth Swaminathan * vax Foreign Function Interface
26*1fd5a2e1SPrashanth Swaminathan *
27*1fd5a2e1SPrashanth Swaminathan * This file attempts to provide all the FFI entry points which can reliably
28*1fd5a2e1SPrashanth Swaminathan * be implemented in C.
29*1fd5a2e1SPrashanth Swaminathan */
30*1fd5a2e1SPrashanth Swaminathan
31*1fd5a2e1SPrashanth Swaminathan #include <ffi.h>
32*1fd5a2e1SPrashanth Swaminathan #include <ffi_common.h>
33*1fd5a2e1SPrashanth Swaminathan
34*1fd5a2e1SPrashanth Swaminathan #include <stdlib.h>
35*1fd5a2e1SPrashanth Swaminathan #include <unistd.h>
36*1fd5a2e1SPrashanth Swaminathan
37*1fd5a2e1SPrashanth Swaminathan #define CIF_FLAGS_CHAR 1 /* for struct only */
38*1fd5a2e1SPrashanth Swaminathan #define CIF_FLAGS_SHORT 2 /* for struct only */
39*1fd5a2e1SPrashanth Swaminathan #define CIF_FLAGS_INT 4
40*1fd5a2e1SPrashanth Swaminathan #define CIF_FLAGS_DINT 8
41*1fd5a2e1SPrashanth Swaminathan
42*1fd5a2e1SPrashanth Swaminathan /*
43*1fd5a2e1SPrashanth Swaminathan * Foreign Function Interface API
44*1fd5a2e1SPrashanth Swaminathan */
45*1fd5a2e1SPrashanth Swaminathan
46*1fd5a2e1SPrashanth Swaminathan void ffi_call_elfbsd (extended_cif *, unsigned, unsigned, void *,
47*1fd5a2e1SPrashanth Swaminathan void (*) ());
48*1fd5a2e1SPrashanth Swaminathan void *ffi_prep_args (extended_cif *ecif, void *stack);
49*1fd5a2e1SPrashanth Swaminathan
50*1fd5a2e1SPrashanth Swaminathan void *
ffi_prep_args(extended_cif * ecif,void * stack)51*1fd5a2e1SPrashanth Swaminathan ffi_prep_args (extended_cif *ecif, void *stack)
52*1fd5a2e1SPrashanth Swaminathan {
53*1fd5a2e1SPrashanth Swaminathan unsigned int i;
54*1fd5a2e1SPrashanth Swaminathan void **p_argv;
55*1fd5a2e1SPrashanth Swaminathan char *argp;
56*1fd5a2e1SPrashanth Swaminathan ffi_type **p_arg;
57*1fd5a2e1SPrashanth Swaminathan void *struct_value_ptr;
58*1fd5a2e1SPrashanth Swaminathan
59*1fd5a2e1SPrashanth Swaminathan argp = stack;
60*1fd5a2e1SPrashanth Swaminathan
61*1fd5a2e1SPrashanth Swaminathan if (ecif->cif->rtype->type == FFI_TYPE_STRUCT
62*1fd5a2e1SPrashanth Swaminathan && !ecif->cif->flags)
63*1fd5a2e1SPrashanth Swaminathan struct_value_ptr = ecif->rvalue;
64*1fd5a2e1SPrashanth Swaminathan else
65*1fd5a2e1SPrashanth Swaminathan struct_value_ptr = NULL;
66*1fd5a2e1SPrashanth Swaminathan
67*1fd5a2e1SPrashanth Swaminathan p_argv = ecif->avalue;
68*1fd5a2e1SPrashanth Swaminathan
69*1fd5a2e1SPrashanth Swaminathan for (i = ecif->cif->nargs, p_arg = ecif->cif->arg_types;
70*1fd5a2e1SPrashanth Swaminathan i != 0;
71*1fd5a2e1SPrashanth Swaminathan i--, p_arg++)
72*1fd5a2e1SPrashanth Swaminathan {
73*1fd5a2e1SPrashanth Swaminathan size_t z;
74*1fd5a2e1SPrashanth Swaminathan
75*1fd5a2e1SPrashanth Swaminathan z = (*p_arg)->size;
76*1fd5a2e1SPrashanth Swaminathan if (z < sizeof (int))
77*1fd5a2e1SPrashanth Swaminathan {
78*1fd5a2e1SPrashanth Swaminathan switch ((*p_arg)->type)
79*1fd5a2e1SPrashanth Swaminathan {
80*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_SINT8:
81*1fd5a2e1SPrashanth Swaminathan *(signed int *) argp = (signed int) *(SINT8 *) *p_argv;
82*1fd5a2e1SPrashanth Swaminathan break;
83*1fd5a2e1SPrashanth Swaminathan
84*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_UINT8:
85*1fd5a2e1SPrashanth Swaminathan *(unsigned int *) argp = (unsigned int) *(UINT8 *) *p_argv;
86*1fd5a2e1SPrashanth Swaminathan break;
87*1fd5a2e1SPrashanth Swaminathan
88*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_SINT16:
89*1fd5a2e1SPrashanth Swaminathan *(signed int *) argp = (signed int) *(SINT16 *) *p_argv;
90*1fd5a2e1SPrashanth Swaminathan break;
91*1fd5a2e1SPrashanth Swaminathan
92*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_UINT16:
93*1fd5a2e1SPrashanth Swaminathan *(unsigned int *) argp = (unsigned int) *(UINT16 *) *p_argv;
94*1fd5a2e1SPrashanth Swaminathan break;
95*1fd5a2e1SPrashanth Swaminathan
96*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_STRUCT:
97*1fd5a2e1SPrashanth Swaminathan memcpy (argp, *p_argv, z);
98*1fd5a2e1SPrashanth Swaminathan break;
99*1fd5a2e1SPrashanth Swaminathan
100*1fd5a2e1SPrashanth Swaminathan default:
101*1fd5a2e1SPrashanth Swaminathan FFI_ASSERT (0);
102*1fd5a2e1SPrashanth Swaminathan }
103*1fd5a2e1SPrashanth Swaminathan z = sizeof (int);
104*1fd5a2e1SPrashanth Swaminathan }
105*1fd5a2e1SPrashanth Swaminathan else
106*1fd5a2e1SPrashanth Swaminathan {
107*1fd5a2e1SPrashanth Swaminathan memcpy (argp, *p_argv, z);
108*1fd5a2e1SPrashanth Swaminathan
109*1fd5a2e1SPrashanth Swaminathan /* Align if necessary. */
110*1fd5a2e1SPrashanth Swaminathan if ((sizeof(int) - 1) & z)
111*1fd5a2e1SPrashanth Swaminathan z = FFI_ALIGN(z, sizeof(int));
112*1fd5a2e1SPrashanth Swaminathan }
113*1fd5a2e1SPrashanth Swaminathan
114*1fd5a2e1SPrashanth Swaminathan p_argv++;
115*1fd5a2e1SPrashanth Swaminathan argp += z;
116*1fd5a2e1SPrashanth Swaminathan }
117*1fd5a2e1SPrashanth Swaminathan
118*1fd5a2e1SPrashanth Swaminathan return struct_value_ptr;
119*1fd5a2e1SPrashanth Swaminathan }
120*1fd5a2e1SPrashanth Swaminathan
121*1fd5a2e1SPrashanth Swaminathan ffi_status
ffi_prep_cif_machdep(ffi_cif * cif)122*1fd5a2e1SPrashanth Swaminathan ffi_prep_cif_machdep (ffi_cif *cif)
123*1fd5a2e1SPrashanth Swaminathan {
124*1fd5a2e1SPrashanth Swaminathan /* Set the return type flag */
125*1fd5a2e1SPrashanth Swaminathan switch (cif->rtype->type)
126*1fd5a2e1SPrashanth Swaminathan {
127*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_VOID:
128*1fd5a2e1SPrashanth Swaminathan cif->flags = 0;
129*1fd5a2e1SPrashanth Swaminathan break;
130*1fd5a2e1SPrashanth Swaminathan
131*1fd5a2e1SPrashanth Swaminathan case FFI_TYPE_STRUCT:
132*1fd5a2e1SPrashanth Swaminathan if (cif->rtype->elements[0]->type == FFI_TYPE_STRUCT &&
133*1fd5a2e1SPrashanth Swaminathan cif->rtype->elements[1])
134*1fd5a2e1SPrashanth Swaminathan {
135*1fd5a2e1SPrashanth Swaminathan cif->flags = 0;
136*1fd5a2e1SPrashanth Swaminathan break;
137*1fd5a2e1SPrashanth Swaminathan }
138*1fd5a2e1SPrashanth Swaminathan
139*1fd5a2e1SPrashanth Swaminathan if (cif->rtype->size == sizeof (char))
140*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_CHAR;
141*1fd5a2e1SPrashanth Swaminathan else if (cif->rtype->size == sizeof (short))
142*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_SHORT;
143*1fd5a2e1SPrashanth Swaminathan else if (cif->rtype->size == sizeof (int))
144*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_INT;
145*1fd5a2e1SPrashanth Swaminathan else if (cif->rtype->size == 2 * sizeof (int))
146*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_DINT;
147*1fd5a2e1SPrashanth Swaminathan else
148*1fd5a2e1SPrashanth Swaminathan cif->flags = 0;
149*1fd5a2e1SPrashanth Swaminathan break;
150*1fd5a2e1SPrashanth Swaminathan
151*1fd5a2e1SPrashanth Swaminathan default:
152*1fd5a2e1SPrashanth Swaminathan if (cif->rtype->size <= sizeof (int))
153*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_INT;
154*1fd5a2e1SPrashanth Swaminathan else
155*1fd5a2e1SPrashanth Swaminathan cif->flags = CIF_FLAGS_DINT;
156*1fd5a2e1SPrashanth Swaminathan break;
157*1fd5a2e1SPrashanth Swaminathan }
158*1fd5a2e1SPrashanth Swaminathan
159*1fd5a2e1SPrashanth Swaminathan return FFI_OK;
160*1fd5a2e1SPrashanth Swaminathan }
161*1fd5a2e1SPrashanth Swaminathan
162*1fd5a2e1SPrashanth Swaminathan void
ffi_call(ffi_cif * cif,void (* fn)(),void * rvalue,void ** avalue)163*1fd5a2e1SPrashanth Swaminathan ffi_call (ffi_cif *cif, void (*fn) (), void *rvalue, void **avalue)
164*1fd5a2e1SPrashanth Swaminathan {
165*1fd5a2e1SPrashanth Swaminathan extended_cif ecif;
166*1fd5a2e1SPrashanth Swaminathan
167*1fd5a2e1SPrashanth Swaminathan ecif.cif = cif;
168*1fd5a2e1SPrashanth Swaminathan ecif.avalue = avalue;
169*1fd5a2e1SPrashanth Swaminathan
170*1fd5a2e1SPrashanth Swaminathan /* If the return value is a struct and we don't have a return value
171*1fd5a2e1SPrashanth Swaminathan address then we need to make one. */
172*1fd5a2e1SPrashanth Swaminathan
173*1fd5a2e1SPrashanth Swaminathan if (rvalue == NULL
174*1fd5a2e1SPrashanth Swaminathan && cif->rtype->type == FFI_TYPE_STRUCT
175*1fd5a2e1SPrashanth Swaminathan && cif->flags == 0)
176*1fd5a2e1SPrashanth Swaminathan ecif.rvalue = alloca (cif->rtype->size);
177*1fd5a2e1SPrashanth Swaminathan else
178*1fd5a2e1SPrashanth Swaminathan ecif.rvalue = rvalue;
179*1fd5a2e1SPrashanth Swaminathan
180*1fd5a2e1SPrashanth Swaminathan switch (cif->abi)
181*1fd5a2e1SPrashanth Swaminathan {
182*1fd5a2e1SPrashanth Swaminathan case FFI_ELFBSD:
183*1fd5a2e1SPrashanth Swaminathan ffi_call_elfbsd (&ecif, cif->bytes, cif->flags, ecif.rvalue, fn);
184*1fd5a2e1SPrashanth Swaminathan break;
185*1fd5a2e1SPrashanth Swaminathan
186*1fd5a2e1SPrashanth Swaminathan default:
187*1fd5a2e1SPrashanth Swaminathan FFI_ASSERT (0);
188*1fd5a2e1SPrashanth Swaminathan break;
189*1fd5a2e1SPrashanth Swaminathan }
190*1fd5a2e1SPrashanth Swaminathan }
191*1fd5a2e1SPrashanth Swaminathan
192*1fd5a2e1SPrashanth Swaminathan /*
193*1fd5a2e1SPrashanth Swaminathan * Closure API
194*1fd5a2e1SPrashanth Swaminathan */
195*1fd5a2e1SPrashanth Swaminathan
196*1fd5a2e1SPrashanth Swaminathan void ffi_closure_elfbsd (void);
197*1fd5a2e1SPrashanth Swaminathan void ffi_closure_struct_elfbsd (void);
198*1fd5a2e1SPrashanth Swaminathan unsigned int ffi_closure_elfbsd_inner (ffi_closure *, void *, char *);
199*1fd5a2e1SPrashanth Swaminathan
200*1fd5a2e1SPrashanth Swaminathan static void
ffi_prep_closure_elfbsd(ffi_cif * cif,void ** avalue,char * stackp)201*1fd5a2e1SPrashanth Swaminathan ffi_prep_closure_elfbsd (ffi_cif *cif, void **avalue, char *stackp)
202*1fd5a2e1SPrashanth Swaminathan {
203*1fd5a2e1SPrashanth Swaminathan unsigned int i;
204*1fd5a2e1SPrashanth Swaminathan void **p_argv;
205*1fd5a2e1SPrashanth Swaminathan ffi_type **p_arg;
206*1fd5a2e1SPrashanth Swaminathan
207*1fd5a2e1SPrashanth Swaminathan p_argv = avalue;
208*1fd5a2e1SPrashanth Swaminathan
209*1fd5a2e1SPrashanth Swaminathan for (i = cif->nargs, p_arg = cif->arg_types; i != 0; i--, p_arg++)
210*1fd5a2e1SPrashanth Swaminathan {
211*1fd5a2e1SPrashanth Swaminathan size_t z;
212*1fd5a2e1SPrashanth Swaminathan
213*1fd5a2e1SPrashanth Swaminathan z = (*p_arg)->size;
214*1fd5a2e1SPrashanth Swaminathan *p_argv = stackp;
215*1fd5a2e1SPrashanth Swaminathan
216*1fd5a2e1SPrashanth Swaminathan /* Align if necessary */
217*1fd5a2e1SPrashanth Swaminathan if ((sizeof (int) - 1) & z)
218*1fd5a2e1SPrashanth Swaminathan z = FFI_ALIGN(z, sizeof (int));
219*1fd5a2e1SPrashanth Swaminathan
220*1fd5a2e1SPrashanth Swaminathan p_argv++;
221*1fd5a2e1SPrashanth Swaminathan stackp += z;
222*1fd5a2e1SPrashanth Swaminathan }
223*1fd5a2e1SPrashanth Swaminathan }
224*1fd5a2e1SPrashanth Swaminathan
225*1fd5a2e1SPrashanth Swaminathan unsigned int
ffi_closure_elfbsd_inner(ffi_closure * closure,void * resp,char * stack)226*1fd5a2e1SPrashanth Swaminathan ffi_closure_elfbsd_inner (ffi_closure *closure, void *resp, char *stack)
227*1fd5a2e1SPrashanth Swaminathan {
228*1fd5a2e1SPrashanth Swaminathan ffi_cif *cif;
229*1fd5a2e1SPrashanth Swaminathan void **arg_area;
230*1fd5a2e1SPrashanth Swaminathan
231*1fd5a2e1SPrashanth Swaminathan cif = closure->cif;
232*1fd5a2e1SPrashanth Swaminathan arg_area = (void **) alloca (cif->nargs * sizeof (void *));
233*1fd5a2e1SPrashanth Swaminathan
234*1fd5a2e1SPrashanth Swaminathan ffi_prep_closure_elfbsd (cif, arg_area, stack);
235*1fd5a2e1SPrashanth Swaminathan
236*1fd5a2e1SPrashanth Swaminathan (closure->fun) (cif, resp, arg_area, closure->user_data);
237*1fd5a2e1SPrashanth Swaminathan
238*1fd5a2e1SPrashanth Swaminathan return cif->flags;
239*1fd5a2e1SPrashanth Swaminathan }
240*1fd5a2e1SPrashanth Swaminathan
241*1fd5a2e1SPrashanth Swaminathan ffi_status
ffi_prep_closure_loc(ffi_closure * closure,ffi_cif * cif,void (* fun)(ffi_cif *,void *,void **,void *),void * user_data,void * codeloc)242*1fd5a2e1SPrashanth Swaminathan ffi_prep_closure_loc (ffi_closure *closure, ffi_cif *cif,
243*1fd5a2e1SPrashanth Swaminathan void (*fun)(ffi_cif *, void *, void **, void *),
244*1fd5a2e1SPrashanth Swaminathan void *user_data, void *codeloc)
245*1fd5a2e1SPrashanth Swaminathan {
246*1fd5a2e1SPrashanth Swaminathan char *tramp = (char *) codeloc;
247*1fd5a2e1SPrashanth Swaminathan void *fn;
248*1fd5a2e1SPrashanth Swaminathan
249*1fd5a2e1SPrashanth Swaminathan FFI_ASSERT (cif->abi == FFI_ELFBSD);
250*1fd5a2e1SPrashanth Swaminathan
251*1fd5a2e1SPrashanth Swaminathan /* entry mask */
252*1fd5a2e1SPrashanth Swaminathan *(unsigned short *)(tramp + 0) = 0x0000;
253*1fd5a2e1SPrashanth Swaminathan /* movl #closure, r0 */
254*1fd5a2e1SPrashanth Swaminathan tramp[2] = 0xd0;
255*1fd5a2e1SPrashanth Swaminathan tramp[3] = 0x8f;
256*1fd5a2e1SPrashanth Swaminathan *(unsigned int *)(tramp + 4) = (unsigned int) closure;
257*1fd5a2e1SPrashanth Swaminathan tramp[8] = 0x50;
258*1fd5a2e1SPrashanth Swaminathan
259*1fd5a2e1SPrashanth Swaminathan if (cif->rtype->type == FFI_TYPE_STRUCT
260*1fd5a2e1SPrashanth Swaminathan && !cif->flags)
261*1fd5a2e1SPrashanth Swaminathan fn = &ffi_closure_struct_elfbsd;
262*1fd5a2e1SPrashanth Swaminathan else
263*1fd5a2e1SPrashanth Swaminathan fn = &ffi_closure_elfbsd;
264*1fd5a2e1SPrashanth Swaminathan
265*1fd5a2e1SPrashanth Swaminathan /* jmpl #fn */
266*1fd5a2e1SPrashanth Swaminathan tramp[9] = 0x17;
267*1fd5a2e1SPrashanth Swaminathan tramp[10] = 0xef;
268*1fd5a2e1SPrashanth Swaminathan *(unsigned int *)(tramp + 11) = (unsigned int)fn + 2 -
269*1fd5a2e1SPrashanth Swaminathan (unsigned int)tramp - 9 - 6;
270*1fd5a2e1SPrashanth Swaminathan
271*1fd5a2e1SPrashanth Swaminathan closure->cif = cif;
272*1fd5a2e1SPrashanth Swaminathan closure->user_data = user_data;
273*1fd5a2e1SPrashanth Swaminathan closure->fun = fun;
274*1fd5a2e1SPrashanth Swaminathan
275*1fd5a2e1SPrashanth Swaminathan return FFI_OK;
276*1fd5a2e1SPrashanth Swaminathan }
277