modffi.c 11.1 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
64
65
66
67
68
69
70
{
    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;
        case 'p':
        case 's': return &ffi_type_pointer;
        case 'v': return &ffi_type_void;
        default: return NULL;
    }
}

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

83
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Unknown type"));
84
85
}

86
STATIC mp_obj_t return_ffi_value(ffi_arg val, char type)
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
{
    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;
        default:
            return mp_obj_new_int(val);
    }
}

// FFI module

102
STATIC void ffimod_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
103
104
105
106
    mp_obj_ffimod_t *self = self_in;
    print(env, "<ffimod %p>", self->handle);
}

107
STATIC mp_obj_t ffimod_close(mp_obj_t self_in) {
108
109
110
111
    mp_obj_ffimod_t *self = self_in;
    dlclose(self->handle);
    return mp_const_none;
}
112
STATIC MP_DEFINE_CONST_FUN_OBJ_1(ffimod_close_obj, ffimod_close);
113

114
STATIC mp_obj_t ffimod_func(uint n_args, const mp_obj_t *args) {
115
116
117
118
119
120
    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) {
121
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
122
123
124
125
126
127
128
129
    }
    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
130
    mp_obj_t iterable = mp_getiter(args[3]);
131
132
    mp_obj_t item;
    int i = 0;
Damien George's avatar
Damien George committed
133
    while ((item = mp_iternext(iterable)) != MP_OBJ_NULL) {
134
135
136
137
138
        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) {
139
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Error in ffi_prep_cif"));
140
141
142
143
144
145
    }

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

146
STATIC void call_py_func(ffi_cif *cif, void *ret, void** args, mp_obj_t func) {
147
148
149
150
    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
151
    mp_obj_t res = mp_call_function_n_kw(func, cif->nargs, 0, pyargs);
152
153
154
155

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

156
STATIC mp_obj_t mod_ffi_callback(mp_obj_t rettype_in, mp_obj_t func_in, mp_obj_t paramtypes_in) {
157
158
159
160
161
162
163
164
165
166
    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
167
    mp_obj_t iterable = mp_getiter(paramtypes_in);
168
169
    mp_obj_t item;
    int i = 0;
Damien George's avatar
Damien George committed
170
    while ((item = mp_iternext(iterable)) != MP_OBJ_NULL) {
171
172
173
174
175
        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) {
176
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Error in ffi_prep_cif"));
177
178
179
180
    }

    res = ffi_prep_closure_loc(o->clo, &o->cif, call_py_func, func_in, o->func);
    if (res != FFI_OK) {
181
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "ffi_prep_closure_loc"));
182
183
184
185
186
187
    }

    return o;
}
MP_DEFINE_CONST_FUN_OBJ_3(mod_ffi_callback_obj, mod_ffi_callback);

188
STATIC mp_obj_t ffimod_var(mp_obj_t self_in, mp_obj_t vartype_in, mp_obj_t symname_in) {
189
190
191
192
193
194
    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) {
195
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
196
197
198
199
200
201
202
203
204
205
    }
    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);

206
STATIC mp_obj_t ffimod_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
207
208
209
210
    const char *fname = mp_obj_str_get_str(args[0]);
    void *mod = dlopen(fname, RTLD_NOW | RTLD_LOCAL);

    if (mod == NULL) {
211
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[Errno %d]", errno));
212
213
214
215
216
217
218
    }
    mp_obj_ffimod_t *o = m_new_obj(mp_obj_ffimod_t);
    o->base.type = type_in;
    o->handle = mod;
    return o;
}

219
STATIC const mp_map_elem_t ffimod_locals_dict_table[] = {
220
221
222
    { 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 },
223
224
};

225
226
STATIC MP_DEFINE_CONST_DICT(ffimod_locals_dict, ffimod_locals_dict_table);

227
STATIC const mp_obj_type_t ffimod_type = {
228
229
    { &mp_type_type },
    .name = MP_QSTR_ffimod,
230
231
    .print = ffimod_print,
    .make_new = ffimod_make_new,
232
    .locals_dict = (mp_obj_t)&ffimod_locals_dict,
233
234
235
236
};

// FFI function

237
STATIC void ffifunc_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
238
239
240
241
242
243
244
245
246
    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);

247
    ffi_arg values[n_args];
248
249
250
251
252
253
254
255
    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);
256
        } else if (MP_OBJ_IS_STR(a)) {
257
            const char *s = mp_obj_str_get_str(a);
258
            values[i] = (ffi_arg)s;
259
260
261
262
263
264
265
266
        } 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;
267
268
        } else if (MP_OBJ_IS_TYPE(a, &fficallback_type)) {
            mp_obj_fficallback_t *p = a;
269
            values[i] = (ffi_arg)p->func;
270
        } else {
271
            goto error;
272
273
274
275
        }
        valueptrs[i] = &values[i];
    }

276
    ffi_arg retval;
277
278
    ffi_call(&self->cif, self->func, &retval, valueptrs);
    return return_ffi_value(retval, self->rettype);
279
280
281

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

284
STATIC const mp_obj_type_t ffifunc_type = {
285
286
    { &mp_type_type },
    .name = MP_QSTR_ffifunc,
287
288
289
290
291
292
    .print = ffifunc_print,
    .call = ffifunc_call,
};

// FFI callback for Python function

293
STATIC void fficallback_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
294
295
296
297
    mp_obj_fficallback_t *self = self_in;
    print(env, "<fficallback %p>", self->func);
}

298
STATIC const mp_obj_type_t fficallback_type = {
299
300
    { &mp_type_type },
    .name = MP_QSTR_fficallback,
301
302
303
304
305
    .print = fficallback_print,
};

// FFI variable

306
STATIC void ffivar_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
307
308
309
310
    mp_obj_ffivar_t *self = self_in;
    print(env, "<ffivar @%p: 0x%x>", self->var, *(int*)self->var);
}

311
STATIC mp_obj_t ffivar_get(mp_obj_t self_in) {
312
313
314
315
316
    mp_obj_ffivar_t *self = self_in;
    return mp_binary_get_val(self->type, self->var, 0);
}
MP_DEFINE_CONST_FUN_OBJ_1(ffivar_get_obj, ffivar_get);

317
STATIC mp_obj_t ffivar_set(mp_obj_t self_in, mp_obj_t val_in) {
318
319
320
321
322
323
    mp_obj_ffivar_t *self = self_in;
    mp_binary_set_val(self->type, self->var, 0, val_in);
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_2(ffivar_set_obj, ffivar_set);

324
325
326
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 },
327
328
};

329
330
331
STATIC MP_DEFINE_CONST_DICT(ffivar_locals_dict, ffivar_locals_dict_table);

STATIC const mp_obj_type_t ffivar_type = {
332
333
    { &mp_type_type },
    .name = MP_QSTR_ffivar,
334
    .print = ffivar_print,
335
    .locals_dict = (mp_obj_t)&ffivar_locals_dict,
336
337
};

338
// Generic opaque storage object (unused)
339

340
/*
341
STATIC const mp_obj_type_t opaque_type = {
342
343
    { &mp_type_type },
    .name = MP_QSTR_opaqueval,
344
345
//    .print = opaque_print,
};
346
*/
347
348
349
350
351
352
353
354
355
356
357
358
359
360

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
361
362
    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);
363
    // there would be as_bytes, but bytes currently is value, not reference type!
Damien George's avatar
Damien George committed
364
    mp_store_attr(m, QSTR_FROM_STR_STATIC("as_bytearray"), (mp_obj_t)&mod_ffi_as_bytearray_obj);
365
}