modsocket.c 16.3 KB
Newer Older
1
2
3
4
5
6
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
7
 * Copyright (c) 2014 Paul Sokolovsky
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

28
29
30
31
#include <stdio.h>
#include <assert.h>
#include <string.h>
#include <unistd.h>
32
#include <fcntl.h>
xbe's avatar
xbe committed
33
34
#include <sys/stat.h>
#include <sys/types.h>
35
#include <sys/socket.h>
xbe's avatar
xbe committed
36
#include <netinet/in.h>
37
38
39
40
#include <arpa/inet.h>
#include <netdb.h>
#include <errno.h>

41
#include "mpconfig.h"
42
43
#include "nlr.h"
#include "misc.h"
44
#include "qstr.h"
45
46
47
48
49
#include "obj.h"
#include "objtuple.h"
#include "objarray.h"
#include "runtime.h"
#include "stream.h"
50
#include "builtin.h"
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/*
  The idea of this module is to implement reasonable minimum of
  socket-related functions to write typical clients and servers.
  The module named "microsocket" on purpose, to allow to make
  Python-level module more (or fully) compatible with CPython
  "socket", e.g.:
  ---- socket.py ----
  from microsocket import *
  from socket_more_funcs import *
  from socket_more_funcs2 import *
  -------------------
  I.e. this module should stay lean, and more functions (if needed)
  should be add to seperate modules (C or Python level).
 */

67
68
69
70
71
72
73
#define MICROPY_SOCKET_EXTRA (0)

typedef struct _mp_obj_socket_t {
    mp_obj_base_t base;
    int fd;
} mp_obj_socket_t;

74
STATIC const mp_obj_type_t microsocket_type;
75
76
77
78

// Helper functions
#define RAISE_ERRNO(err_flag, error_val) \
    { if (err_flag == -1) \
79
        { nlr_raise(mp_obj_new_exception_arg1(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT((mp_int_t)error_val))); } }
80

81
STATIC mp_obj_socket_t *socket_new(int fd) {
82
    mp_obj_socket_t *o = m_new_obj(mp_obj_socket_t);
83
    o->base.type = &microsocket_type;
84
85
86
87
88
    o->fd = fd;
    return o;
}


89
STATIC void socket_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
90
91
92
93
    mp_obj_socket_t *self = self_in;
    print(env, "<_socket %d>", self->fd);
}

94
STATIC mp_uint_t socket_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
95
    mp_obj_socket_t *o = o_in;
96
    mp_int_t r = read(o->fd, buf, size);
97
98
    if (r == -1) {
        *errcode = errno;
99
        return MP_STREAM_ERROR;
100
101
102
103
    }
    return r;
}

104
STATIC mp_uint_t socket_write(mp_obj_t o_in, const void *buf, mp_uint_t size, int *errcode) {
105
    mp_obj_socket_t *o = o_in;
106
    mp_int_t r = write(o->fd, buf, size);
107
108
    if (r == -1) {
        *errcode = errno;
109
        return MP_STREAM_ERROR;
110
111
112
113
    }
    return r;
}

114
STATIC mp_obj_t socket_close(mp_obj_t self_in) {
115
116
117
118
    mp_obj_socket_t *self = self_in;
    close(self->fd);
    return mp_const_none;
}
119
STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_close_obj, socket_close);
120

121
STATIC mp_obj_t socket_fileno(mp_obj_t self_in) {
122
    mp_obj_socket_t *self = self_in;
123
    return MP_OBJ_NEW_SMALL_INT((mp_int_t)self->fd);
124
}
125
STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_fileno_obj, socket_fileno);
126

127
STATIC mp_obj_t socket_connect(mp_obj_t self_in, mp_obj_t addr_in) {
128
    mp_obj_socket_t *self = self_in;
129
    mp_buffer_info_t bufinfo;
130
    mp_get_buffer_raise(addr_in, &bufinfo, MP_BUFFER_READ);
131
132
133
134
    int r = connect(self->fd, (const struct sockaddr *)bufinfo.buf, bufinfo.len);
    RAISE_ERRNO(r, errno);
    return mp_const_none;
}
135
STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_connect_obj, socket_connect);
136

137
STATIC mp_obj_t socket_bind(mp_obj_t self_in, mp_obj_t addr_in) {
138
    mp_obj_socket_t *self = self_in;
139
    mp_buffer_info_t bufinfo;
140
    mp_get_buffer_raise(addr_in, &bufinfo, MP_BUFFER_READ);
141
142
143
144
    int r = bind(self->fd, (const struct sockaddr *)bufinfo.buf, bufinfo.len);
    RAISE_ERRNO(r, errno);
    return mp_const_none;
}
145
STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_bind_obj, socket_bind);
146

147
STATIC mp_obj_t socket_listen(mp_obj_t self_in, mp_obj_t backlog_in) {
148
149
150
151
152
    mp_obj_socket_t *self = self_in;
    int r = listen(self->fd, MP_OBJ_SMALL_INT_VALUE(backlog_in));
    RAISE_ERRNO(r, errno);
    return mp_const_none;
}
153
STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_listen_obj, socket_listen);
154

155
STATIC mp_obj_t socket_accept(mp_obj_t self_in) {
156
157
158
159
160
161
162
163
164
165
166
167
    mp_obj_socket_t *self = self_in;
    struct sockaddr addr;
    socklen_t addr_len = sizeof(addr);
    int fd = accept(self->fd, &addr, &addr_len);
    RAISE_ERRNO(fd, errno);

    mp_obj_tuple_t *t = mp_obj_new_tuple(2, NULL);
    t->items[0] = socket_new(fd);
    t->items[1] = mp_obj_new_bytearray(addr_len, &addr);

    return t;
}
168
STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_accept_obj, socket_accept);
169

170
171
172
// Note: besides flag param, this differs from read() in that
// this does not swallow blocking errors (EAGAIN, EWOULDBLOCK) -
// these would be thrown as exceptions.
173
STATIC mp_obj_t socket_recv(uint n_args, const mp_obj_t *args) {
174
175
176
177
178
179
180
181
    mp_obj_socket_t *self = args[0];
    int sz = MP_OBJ_SMALL_INT_VALUE(args[1]);
    int flags = 0;

    if (n_args > 2) {
        flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
    }

182
    char *buf = m_new(char, sz);
183
184
185
    int out_sz = recv(self->fd, buf, sz, flags);
    RAISE_ERRNO(out_sz, errno);

186
187
188
    mp_obj_t ret = MP_OBJ_NEW_QSTR(qstr_from_strn(buf, out_sz));
    m_del(char, buf, sz);
    return ret;
189
}
190
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_recv_obj, 2, 3, socket_recv);
191

192
193
194
// Note: besides flag param, this differs from write() in that
// this does not swallow blocking errors (EAGAIN, EWOULDBLOCK) -
// these would be thrown as exceptions.
195
STATIC mp_obj_t socket_send(uint n_args, const mp_obj_t *args) {
196
197
198
199
200
201
202
    mp_obj_socket_t *self = args[0];
    int flags = 0;

    if (n_args > 2) {
        flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
    }

203
204
205
    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
    int out_sz = send(self->fd, bufinfo.buf, bufinfo.len, flags);
206
207
    RAISE_ERRNO(out_sz, errno);

208
    return MP_OBJ_NEW_SMALL_INT((mp_int_t)out_sz);
209
}
210
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_send_obj, 2, 3, socket_send);
211

212
STATIC mp_obj_t socket_setsockopt(uint n_args, const mp_obj_t *args) {
213
214
215
216
217
218
219
220
221
222
223
    mp_obj_socket_t *self = args[0];
    int level = MP_OBJ_SMALL_INT_VALUE(args[1]);
    int option = mp_obj_get_int(args[2]);

    const void *optval;
    socklen_t optlen;
    if (MP_OBJ_IS_INT(args[3])) {
        int val = mp_obj_int_get(args[3]);
        optval = &val;
        optlen = sizeof(val);
    } else {
224
        mp_buffer_info_t bufinfo;
225
        mp_get_buffer_raise(args[3], &bufinfo, MP_BUFFER_READ);
226
227
228
229
230
231
232
        optval = bufinfo.buf;
        optlen = bufinfo.len;
    }
    int r = setsockopt(self->fd, level, option, optval, optlen);
    RAISE_ERRNO(r, errno);
    return mp_const_none;
}
233
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_setsockopt_obj, 4, 4, socket_setsockopt);
234

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
STATIC mp_obj_t socket_setblocking(mp_obj_t self_in, mp_obj_t flag_in) {
    mp_obj_socket_t *self = self_in;
    int val = mp_obj_is_true(flag_in);
    int flags = fcntl(self->fd, F_GETFL, 0);
    RAISE_ERRNO(flags, errno);
    if (val) {
        flags &= ~O_NONBLOCK;
    } else {
        flags |= O_NONBLOCK;
    }
    flags = fcntl(self->fd, F_SETFL, flags);
    RAISE_ERRNO(flags, errno);
    return mp_const_none;
}
STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_setblocking_obj, socket_setblocking);

251
252
253
254
255
256
257
STATIC mp_obj_t socket_makefile(uint n_args, const mp_obj_t *args) {
    // TODO: CPython explicitly says that closing returned object doesn't close
    // the original socket (Python2 at all says that fd is dup()ed). But we
    // save on the bloat.
    mp_obj_socket_t *self = args[0];
    mp_obj_t *new_args = alloca(n_args * sizeof(mp_obj_t));
    memcpy(new_args + 1, args + 1, (n_args - 1) * sizeof(mp_obj_t));
258
    new_args[0] = MP_OBJ_NEW_SMALL_INT((mp_int_t)self->fd);
259
260
261
262
    return mp_builtin_open(n_args, new_args);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_makefile_obj, 1, 3, socket_makefile);

263
STATIC mp_obj_t socket_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
    int family = AF_INET;
    int type = SOCK_STREAM;
    int proto = 0;

    if (n_args > 0) {
        assert(MP_OBJ_IS_SMALL_INT(args[0]));
        family = MP_OBJ_SMALL_INT_VALUE(args[0]);
        if (n_args > 1) {
            assert(MP_OBJ_IS_SMALL_INT(args[1]));
            type = MP_OBJ_SMALL_INT_VALUE(args[1]);
            if (n_args > 2) {
                assert(MP_OBJ_IS_SMALL_INT(args[2]));
                proto = MP_OBJ_SMALL_INT_VALUE(args[2]);
            }
        }
    }

    int fd = socket(family, type, proto);
    RAISE_ERRNO(fd, errno);
    return socket_new(fd);
}

286
STATIC const mp_map_elem_t microsocket_locals_dict_table[] = {
287
    { MP_OBJ_NEW_QSTR(MP_QSTR_fileno), (mp_obj_t)&socket_fileno_obj },
288
    { MP_OBJ_NEW_QSTR(MP_QSTR_makefile), (mp_obj_t)&socket_makefile_obj },
289
290
291
292
293
294
295
296
297
298
299
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mp_stream_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_readall), (mp_obj_t)&mp_stream_readall_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_readline), (mp_obj_t)&mp_stream_unbuffered_readline_obj},
    { MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&mp_stream_write_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_connect), (mp_obj_t)&socket_connect_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_bind), (mp_obj_t)&socket_bind_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_listen), (mp_obj_t)&socket_listen_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_accept), (mp_obj_t)&socket_accept_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_recv), (mp_obj_t)&socket_recv_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_send), (mp_obj_t)&socket_send_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_setsockopt), (mp_obj_t)&socket_setsockopt_obj },
300
    { MP_OBJ_NEW_QSTR(MP_QSTR_setblocking), (mp_obj_t)&socket_setblocking_obj },
301
    { MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&socket_close_obj },
302
303
};

304
305
STATIC MP_DEFINE_CONST_DICT(microsocket_locals_dict, microsocket_locals_dict_table);

306
307
308
309
310
STATIC const mp_stream_p_t microsocket_stream_p = {
    .read = socket_read,
    .write = socket_write,
};

311
STATIC const mp_obj_type_t microsocket_type = {
312
    { &mp_type_type },
313
    .name = MP_QSTR_socket,
314
315
316
317
    .print = socket_print,
    .make_new = socket_make_new,
    .getiter = NULL,
    .iternext = NULL,
318
    .stream_p = &microsocket_stream_p,
319
    .locals_dict = (mp_obj_t)&microsocket_locals_dict,
320
321
};

322
#if MICROPY_SOCKET_EXTRA
323
STATIC mp_obj_t mod_socket_htons(mp_obj_t arg) {
324
    return MP_OBJ_NEW_SMALL_INT((mp_int_t)htons(MP_OBJ_SMALL_INT_VALUE(arg)));
325
}
326
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_socket_htons_obj, mod_socket_htons);
327

328
STATIC mp_obj_t mod_socket_inet_aton(mp_obj_t arg) {
329
    assert(MP_OBJ_IS_TYPE(arg, &mp_type_str));
330
    const char *s = mp_obj_str_get_str(arg);
331
332
    struct in_addr addr;
    if (!inet_aton(s, &addr)) {
333
        nlr_raise(mp_obj_new_exception_arg1(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT(EINVAL)));
334
335
336
337
    }

    return mp_obj_new_int(addr.s_addr);
}
338
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_socket_inet_aton_obj, mod_socket_inet_aton);
339

340
STATIC mp_obj_t mod_socket_gethostbyname(mp_obj_t arg) {
341
    assert(MP_OBJ_IS_TYPE(arg, &mp_type_str));
342
    const char *s = mp_obj_str_get_str(arg);
343
344
    struct hostent *h = gethostbyname(s);
    if (h == NULL) {
345
        // CPython: socket.herror
346
        nlr_raise(mp_obj_new_exception_arg1(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT((mp_int_t)h_errno)));
347
348
349
350
    }
    assert(h->h_length == 4);
    return mp_obj_new_int(*(int*)*h->h_addr_list);
}
351
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_socket_gethostbyname_obj, mod_socket_gethostbyname);
352
#endif // MICROPY_SOCKET_EXTRA
353

354
STATIC mp_obj_t mod_socket_getaddrinfo(uint n_args, const mp_obj_t *args) {
355
356
    // TODO: Implement all args
    assert(n_args == 2);
357
    assert(MP_OBJ_IS_STR(args[0]));
358

359
    const char *host = mp_obj_str_get_str(args[0]);
360
    const char *serv = NULL;
361
362
    struct addrinfo hints;
    memset(&hints, 0, sizeof(hints));
363
364
365
    // getaddrinfo accepts port in string notation, so however
    // it may seem stupid, we need to convert int to str
    if (MP_OBJ_IS_SMALL_INT(args[1])) {
366
367
        int port = (short)MP_OBJ_SMALL_INT_VALUE(args[1]);
        char buf[6];
368
369
        sprintf(buf, "%d", port);
        serv = buf;
370
        hints.ai_flags = AI_NUMERICSERV;
371
#ifdef __UCLIBC_MAJOR__
372
373
374
375
376
377
378
379
380
381
#if __UCLIBC_MAJOR__ == 0 && (__UCLIBC_MINOR__ < 9 || (__UCLIBC_MINOR__ == 9 && __UCLIBC_SUBLEVEL__ <= 32))
#warning Working around uClibc bug with numeric service name
        // Older versions og uClibc have bugs when numeric ports in service
        // arg require also hints.ai_socktype (or hints.ai_protocol) != 0
        // This actually was fixed in 0.9.32.1, but uClibc doesn't allow to
        // test for that.
        // http://git.uclibc.org/uClibc/commit/libc/inet/getaddrinfo.c?id=bc3be18145e4d5
        // Note that this is crude workaround, precluding UDP socket addresses
        // to be returned. TODO: set only if not set by Python args.
        hints.ai_socktype = SOCK_STREAM;
382
#endif
383
#endif
384
    } else {
385
        serv = mp_obj_str_get_str(args[1]);
386
387
    }

388
    struct addrinfo *addr_list;
389
    int res = getaddrinfo(host, serv, &hints, &addr_list);
390
391

    if (res != 0) {
392
        // CPython: socket.gaierror
393
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "[addrinfo error %d]", res));
394
    }
395
    assert(addr_list);
396

397
    mp_obj_t list = mp_obj_new_list(0, NULL);
398
    for (struct addrinfo *addr = addr_list; addr; addr = addr->ai_next) {
399
        mp_obj_tuple_t *t = mp_obj_new_tuple(5, NULL);
400
401
402
        t->items[0] = MP_OBJ_NEW_SMALL_INT((mp_int_t)addr->ai_family);
        t->items[1] = MP_OBJ_NEW_SMALL_INT((mp_int_t)addr->ai_socktype);
        t->items[2] = MP_OBJ_NEW_SMALL_INT((mp_int_t)addr->ai_protocol);
403
404
405
        // "canonname will be a string representing the canonical name of the host
        // if AI_CANONNAME is part of the flags argument; else canonname will be empty." ??
        if (addr->ai_canonname) {
406
            t->items[3] = MP_OBJ_NEW_QSTR(qstr_from_str(addr->ai_canonname));
407
408
409
410
        } else {
            t->items[3] = mp_const_none;
        }
        t->items[4] = mp_obj_new_bytearray(addr->ai_addrlen, addr->ai_addr);
411
        mp_obj_list_append(list, t);
412
    }
413
    freeaddrinfo(addr_list);
414
415
    return list;
}
416
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_socket_getaddrinfo_obj, 2, 6, mod_socket_getaddrinfo);
417
418
419

extern mp_obj_type_t sockaddr_in_type;

420
421
422
423
424
425
426
427
428
429
STATIC const mp_map_elem_t mp_module_socket_globals_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_microsocket) },
    { MP_OBJ_NEW_QSTR(MP_QSTR_socket), (mp_obj_t)&microsocket_type },
    { MP_OBJ_NEW_QSTR(MP_QSTR_getaddrinfo), (mp_obj_t)&mod_socket_getaddrinfo_obj },
#if MICROPY_SOCKET_EXTRA
    { MP_OBJ_NEW_QSTR(MP_QSTR_sockaddr_in), (mp_obj_t)&sockaddr_in_type },
    { MP_OBJ_NEW_QSTR(MP_QSTR_htons), (mp_obj_t)&mod_socket_htons_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_inet_aton), (mp_obj_t)&mod_socket_inet_aton_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_gethostbyname), (mp_obj_t)&mod_socket_gethostbyname_obj },
#endif
430

431
#define C(name) { MP_OBJ_NEW_QSTR(MP_QSTR_ ## name), MP_OBJ_NEW_SMALL_INT(name) }
432
433
434
435
436
437
    C(AF_UNIX),
    C(AF_INET),
    C(AF_INET6),
    C(SOCK_STREAM),
    C(SOCK_DGRAM),
    C(SOCK_RAW),
438
439
440
441
442
443
444
445
446
447

    C(MSG_DONTROUTE),
    C(MSG_DONTWAIT),

    C(SOL_SOCKET),
    C(SO_BROADCAST),
    C(SO_ERROR),
    C(SO_KEEPALIVE),
    C(SO_LINGER),
    C(SO_REUSEADDR),
448
#undef C
449
450
};

451
452
453
454
455
STATIC const mp_obj_dict_t mp_module_socket_globals = {
    .base = {&mp_type_dict},
    .map = {
        .all_keys_are_qstrs = 1,
        .table_is_fixed_array = 1,
456
457
        .used = MP_ARRAY_SIZE(mp_module_socket_globals_table),
        .alloc = MP_ARRAY_SIZE(mp_module_socket_globals_table),
458
459
460
        .table = (mp_map_elem_t*)mp_module_socket_globals_table,
    },
};
461

462
463
464
465
466
const mp_obj_module_t mp_module_socket = {
    .base = { &mp_type_module },
    .name = MP_QSTR_microsocket,
    .globals = (mp_obj_dict_t*)&mp_module_socket_globals,
};