modffi.c 11.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
#include <assert.h>
#include <string.h>
#include <errno.h>
#include <dlfcn.h>
#include <ffi.h>

#include "nlr.h"
#include "misc.h"
#include "mpconfig.h"
#include "qstr.h"
#include "obj.h"
#include "runtime.h"
13
#include "binary.h"
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

typedef struct _mp_obj_opaque_t {
    mp_obj_base_t base;
    void *val;
} mp_obj_opaque_t;

typedef struct _mp_obj_ffimod_t {
    mp_obj_base_t base;
    void *handle;
} mp_obj_ffimod_t;

typedef struct _mp_obj_ffivar_t {
    mp_obj_base_t base;
    void *var;
    char type;
//    ffi_type *type;
} mp_obj_ffivar_t;

typedef struct _mp_obj_ffifunc_t {
    mp_obj_base_t base;
    void *func;
    char rettype;
    ffi_cif cif;
    ffi_type *params[];
} mp_obj_ffifunc_t;

typedef struct _mp_obj_fficallback_t {
    mp_obj_base_t base;
    void *func;
    ffi_closure *clo;
    char rettype;
    ffi_cif cif;
    ffi_type *params[];
} mp_obj_fficallback_t;

49
50
51
52
53
//STATIC const mp_obj_type_t opaque_type;
STATIC const mp_obj_type_t ffimod_type;
STATIC const mp_obj_type_t ffifunc_type;
STATIC const mp_obj_type_t fficallback_type;
STATIC const mp_obj_type_t ffivar_type;
54

55
STATIC ffi_type *char2ffi_type(char c)
56
57
58
59
60
61
62
63
{
    switch (c) {
        case 'b': return &ffi_type_schar;
        case 'B': return &ffi_type_uchar;
        case 'i': return &ffi_type_sint;
        case 'I': return &ffi_type_uint;
        case 'l': return &ffi_type_slong;
        case 'L': return &ffi_type_ulong;
Paul Sokolovsky's avatar
Paul Sokolovsky committed
64
65
        case 'f': return &ffi_type_float;
        case 'd': return &ffi_type_double;
66
67
68
69
70
71
72
        case 'p':
        case 's': return &ffi_type_pointer;
        case 'v': return &ffi_type_void;
        default: return NULL;
    }
}

73
STATIC ffi_type *get_ffi_type(mp_obj_t o_in)
74
75
76
{
    if (MP_OBJ_IS_STR(o_in)) {
        uint len;
77
        const char *s = mp_obj_str_get_data(o_in, &len);
78
79
80
81
82
83
84
        ffi_type *t = char2ffi_type(*s);
        if (t != NULL) {
            return t;
        }
    }
    // TODO: Support actual libffi type objects

85
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Unknown type"));
86
87
}

88
STATIC mp_obj_t return_ffi_value(ffi_arg val, char type)
89
90
91
92
93
94
95
96
{
    switch (type) {
        case 's': {
            const char *s = (const char *)val;
            return mp_obj_new_str((const byte *)s, strlen(s), false);
        }
        case 'v':
            return mp_const_none;
Paul Sokolovsky's avatar
Paul Sokolovsky committed
97
98
99
100
101
102
103
104
        case 'f': {
            float *p = (float*)&val;
            return mp_obj_new_float(*p);
        }
        case 'd': {
            double *p = (double*)&val;
            return mp_obj_new_float(*p);
        }
105
106
107
108
109
110
111
        default:
            return mp_obj_new_int(val);
    }
}

// FFI module

112
STATIC void ffimod_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
113
114
115
116
    mp_obj_ffimod_t *self = self_in;
    print(env, "<ffimod %p>", self->handle);
}

117
STATIC mp_obj_t ffimod_close(mp_obj_t self_in) {
118
119
120
121
    mp_obj_ffimod_t *self = self_in;
    dlclose(self->handle);
    return mp_const_none;
}
122
STATIC MP_DEFINE_CONST_FUN_OBJ_1(ffimod_close_obj, ffimod_close);
123

124
STATIC mp_obj_t ffimod_func(uint n_args, const mp_obj_t *args) {
125
126
127
128
129
130
    mp_obj_ffimod_t *self = args[0];
    const char *rettype = mp_obj_str_get_str(args[1]);
    const char *symname = mp_obj_str_get_str(args[2]);

    void *sym = dlsym(self->handle, symname);
    if (sym == NULL) {
131
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
132
133
134
135
136
137
138
139
    }
    int nparams = MP_OBJ_SMALL_INT_VALUE(mp_obj_len_maybe(args[3]));
    mp_obj_ffifunc_t *o = m_new_obj_var(mp_obj_ffifunc_t, ffi_type*, nparams);
    o->base.type = &ffifunc_type;

    o->func = sym;
    o->rettype = *rettype;

Damien George's avatar
Damien George committed
140
    mp_obj_t iterable = mp_getiter(args[3]);
141
142
    mp_obj_t item;
    int i = 0;
Damien George's avatar
Damien George committed
143
    while ((item = mp_iternext(iterable)) != MP_OBJ_NULL) {
144
145
146
147
148
        o->params[i++] = get_ffi_type(item);
    }

    int res = ffi_prep_cif(&o->cif, FFI_DEFAULT_ABI, nparams, char2ffi_type(*rettype), o->params);
    if (res != FFI_OK) {
149
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Error in ffi_prep_cif"));
150
151
152
153
154
155
    }

    return o;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(ffimod_func_obj, 4, 4, ffimod_func);

156
STATIC void call_py_func(ffi_cif *cif, void *ret, void** args, mp_obj_t func) {
157
158
159
160
    mp_obj_t pyargs[cif->nargs];
    for (int i = 0; i < cif->nargs; i++) {
        pyargs[i] = mp_obj_new_int(*(int*)args[i]);
    }
Damien George's avatar
Damien George committed
161
    mp_obj_t res = mp_call_function_n_kw(func, cif->nargs, 0, pyargs);
162
163
164
165

    *(ffi_arg*)ret = mp_obj_int_get(res);
}

166
STATIC mp_obj_t mod_ffi_callback(mp_obj_t rettype_in, mp_obj_t func_in, mp_obj_t paramtypes_in) {
167
168
169
170
171
172
173
174
175
176
    const char *rettype = mp_obj_str_get_str(rettype_in);

    int nparams = MP_OBJ_SMALL_INT_VALUE(mp_obj_len_maybe(paramtypes_in));
    mp_obj_fficallback_t *o = m_new_obj_var(mp_obj_fficallback_t, ffi_type*, nparams);
    o->base.type = &fficallback_type;

    o->clo = ffi_closure_alloc(sizeof(ffi_closure), &o->func);

    o->rettype = *rettype;

Damien George's avatar
Damien George committed
177
    mp_obj_t iterable = mp_getiter(paramtypes_in);
178
179
    mp_obj_t item;
    int i = 0;
Damien George's avatar
Damien George committed
180
    while ((item = mp_iternext(iterable)) != MP_OBJ_NULL) {
181
182
183
184
185
        o->params[i++] = get_ffi_type(item);
    }

    int res = ffi_prep_cif(&o->cif, FFI_DEFAULT_ABI, nparams, char2ffi_type(*rettype), o->params);
    if (res != FFI_OK) {
186
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Error in ffi_prep_cif"));
187
188
189
190
    }

    res = ffi_prep_closure_loc(o->clo, &o->cif, call_py_func, func_in, o->func);
    if (res != FFI_OK) {
191
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "ffi_prep_closure_loc"));
192
193
194
195
196
197
    }

    return o;
}
MP_DEFINE_CONST_FUN_OBJ_3(mod_ffi_callback_obj, mod_ffi_callback);

198
STATIC mp_obj_t ffimod_var(mp_obj_t self_in, mp_obj_t vartype_in, mp_obj_t symname_in) {
199
200
201
202
203
204
    mp_obj_ffimod_t *self = self_in;
    const char *rettype = mp_obj_str_get_str(vartype_in);
    const char *symname = mp_obj_str_get_str(symname_in);

    void *sym = dlsym(self->handle, symname);
    if (sym == NULL) {
205
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
206
207
208
209
210
211
212
213
214
215
    }
    mp_obj_ffivar_t *o = m_new_obj(mp_obj_ffivar_t);
    o->base.type = &ffivar_type;

    o->var = sym;
    o->type = *rettype;
    return o;
}
MP_DEFINE_CONST_FUN_OBJ_3(ffimod_var_obj, ffimod_var);

216
STATIC mp_obj_t ffimod_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
217
218
219
220
    const char *fname = mp_obj_str_get_str(args[0]);
    void *mod = dlopen(fname, RTLD_NOW | RTLD_LOCAL);

    if (mod == NULL) {
221
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
222
223
224
225
226
227
228
    }
    mp_obj_ffimod_t *o = m_new_obj(mp_obj_ffimod_t);
    o->base.type = type_in;
    o->handle = mod;
    return o;
}

229
STATIC const mp_map_elem_t ffimod_locals_dict_table[] = {
230
231
232
    { MP_OBJ_NEW_QSTR(MP_QSTR_func), (mp_obj_t) &ffimod_func_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_var), (mp_obj_t) &ffimod_var_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t) &ffimod_close_obj },
233
234
};

235
236
STATIC MP_DEFINE_CONST_DICT(ffimod_locals_dict, ffimod_locals_dict_table);

237
STATIC const mp_obj_type_t ffimod_type = {
238
239
    { &mp_type_type },
    .name = MP_QSTR_ffimod,
240
241
    .print = ffimod_print,
    .make_new = ffimod_make_new,
242
    .locals_dict = (mp_obj_t)&ffimod_locals_dict,
243
244
245
246
};

// FFI function

247
STATIC void ffifunc_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
248
249
250
251
252
253
254
255
256
    mp_obj_ffifunc_t *self = self_in;
    print(env, "<ffifunc %p>", self->func);
}

mp_obj_t ffifunc_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
    mp_obj_ffifunc_t *self = self_in;
    assert(n_kw == 0);
    assert(n_args == self->cif.nargs);

257
    ffi_arg values[n_args];
258
259
260
261
262
263
264
265
    void *valueptrs[n_args];
    int i;
    for (i = 0; i < n_args; i++) {
        mp_obj_t a = args[i];
        if (a == mp_const_none) {
            values[i] = 0;
        } else if (MP_OBJ_IS_INT(a)) {
            values[i] = mp_obj_int_get(a);
266
        } else if (MP_OBJ_IS_STR(a)) {
267
            const char *s = mp_obj_str_get_str(a);
268
            values[i] = (ffi_arg)s;
269
270
271
272
273
274
275
276
        } else if (((mp_obj_base_t*)a)->type->buffer_p.get_buffer != NULL) {
            mp_obj_base_t *o = (mp_obj_base_t*)a;
            buffer_info_t bufinfo;
            o->type->buffer_p.get_buffer(o, &bufinfo, BUFFER_READ); // TODO: BUFFER_READ?
            if (bufinfo.buf == NULL) {
                goto error;
            }
            values[i] = (ffi_arg)bufinfo.buf;
277
278
        } else if (MP_OBJ_IS_TYPE(a, &fficallback_type)) {
            mp_obj_fficallback_t *p = a;
279
            values[i] = (ffi_arg)p->func;
280
        } else {
281
            goto error;
282
283
284
285
        }
        valueptrs[i] = &values[i];
    }

286
    ffi_arg retval;
287
288
    ffi_call(&self->cif, self->func, &retval, valueptrs);
    return return_ffi_value(retval, self->rettype);
289
290
291

error:
    nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "Don't know how to pass object to native function"));
292
293
}

294
STATIC const mp_obj_type_t ffifunc_type = {
295
296
    { &mp_type_type },
    .name = MP_QSTR_ffifunc,
297
298
299
300
301
302
    .print = ffifunc_print,
    .call = ffifunc_call,
};

// FFI callback for Python function

303
STATIC void fficallback_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
304
305
306
307
    mp_obj_fficallback_t *self = self_in;
    print(env, "<fficallback %p>", self->func);
}

308
STATIC const mp_obj_type_t fficallback_type = {
309
310
    { &mp_type_type },
    .name = MP_QSTR_fficallback,
311
312
313
314
315
    .print = fficallback_print,
};

// FFI variable

316
STATIC void ffivar_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
317
318
319
320
    mp_obj_ffivar_t *self = self_in;
    print(env, "<ffivar @%p: 0x%x>", self->var, *(int*)self->var);
}

321
STATIC mp_obj_t ffivar_get(mp_obj_t self_in) {
322
    mp_obj_ffivar_t *self = self_in;
323
    return mp_binary_get_val_array(self->type, self->var, 0);
324
325
326
}
MP_DEFINE_CONST_FUN_OBJ_1(ffivar_get_obj, ffivar_get);

327
STATIC mp_obj_t ffivar_set(mp_obj_t self_in, mp_obj_t val_in) {
328
    mp_obj_ffivar_t *self = self_in;
329
    mp_binary_set_val_array(self->type, self->var, 0, val_in);
330
331
332
333
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_2(ffivar_set_obj, ffivar_set);

334
335
336
STATIC const mp_map_elem_t ffivar_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_get), (mp_obj_t)&ffivar_get_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_set), (mp_obj_t)&ffivar_set_obj },
337
338
};

339
340
341
STATIC MP_DEFINE_CONST_DICT(ffivar_locals_dict, ffivar_locals_dict_table);

STATIC const mp_obj_type_t ffivar_type = {
342
343
    { &mp_type_type },
    .name = MP_QSTR_ffivar,
344
    .print = ffivar_print,
345
    .locals_dict = (mp_obj_t)&ffivar_locals_dict,
346
347
};

348
// Generic opaque storage object (unused)
349

350
/*
351
STATIC const mp_obj_type_t opaque_type = {
352
353
    { &mp_type_type },
    .name = MP_QSTR_opaqueval,
354
355
//    .print = opaque_print,
};
356
*/
357
358
359
360
361
362
363
364
365
366
367
368
369
370

mp_obj_t mod_ffi_open(uint n_args, const mp_obj_t *args) {
    return ffimod_make_new((mp_obj_t)&ffimod_type, n_args, 0, args);
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_ffi_open_obj, 1, 2, mod_ffi_open);

mp_obj_t mod_ffi_as_bytearray(mp_obj_t ptr, mp_obj_t size) {
    return mp_obj_new_bytearray_by_ref(mp_obj_int_get(size), (void*)mp_obj_int_get(ptr));
}
MP_DEFINE_CONST_FUN_OBJ_2(mod_ffi_as_bytearray_obj, mod_ffi_as_bytearray);


void ffi_init() {
    mp_obj_t m = mp_obj_new_module(QSTR_FROM_STR_STATIC("ffi"));
Damien George's avatar
Damien George committed
371
372
    mp_store_attr(m, MP_QSTR_open, (mp_obj_t)&mod_ffi_open_obj);
    mp_store_attr(m, QSTR_FROM_STR_STATIC("callback"), (mp_obj_t)&mod_ffi_callback_obj);
373
    // there would be as_bytes, but bytes currently is value, not reference type!
Damien George's avatar
Damien George committed
374
    mp_store_attr(m, QSTR_FROM_STR_STATIC("as_bytearray"), (mp_obj_t)&mod_ffi_as_bytearray_obj);
375
}