LCOV - code coverage report
Current view: top level - ports/unix - modusocket.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.19.1-740-gbf49a087b.info Lines: 109 324 33.6 %
Date: 2022-12-09 11:55:04 Functions: 8 23 34.8 %
Branches: 28 139 20.1 %

           Branch data     Line data    Source code
       1                 :            : /*
       2                 :            :  * This file is part of the MicroPython project, http://micropython.org/
       3                 :            :  *
       4                 :            :  * The MIT License (MIT)
       5                 :            :  *
       6                 :            :  * Copyright (c) 2014-2018 Paul Sokolovsky
       7                 :            :  * Copyright (c) 2014-2019 Damien P. George
       8                 :            :  *
       9                 :            :  * Permission is hereby granted, free of charge, to any person obtaining a copy
      10                 :            :  * of this software and associated documentation files (the "Software"), to deal
      11                 :            :  * in the Software without restriction, including without limitation the rights
      12                 :            :  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      13                 :            :  * copies of the Software, and to permit persons to whom the Software is
      14                 :            :  * furnished to do so, subject to the following conditions:
      15                 :            :  *
      16                 :            :  * The above copyright notice and this permission notice shall be included in
      17                 :            :  * all copies or substantial portions of the Software.
      18                 :            :  *
      19                 :            :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      20                 :            :  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      21                 :            :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      22                 :            :  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      23                 :            :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      24                 :            :  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      25                 :            :  * THE SOFTWARE.
      26                 :            :  */
      27                 :            : 
      28                 :            : #include <stdio.h>
      29                 :            : #include <assert.h>
      30                 :            : #include <string.h>
      31                 :            : #include <unistd.h>
      32                 :            : #include <fcntl.h>
      33                 :            : #include <sys/stat.h>
      34                 :            : #include <sys/types.h>
      35                 :            : #include <sys/socket.h>
      36                 :            : #include <netinet/in.h>
      37                 :            : #include <arpa/inet.h>
      38                 :            : #include <netdb.h>
      39                 :            : #include <errno.h>
      40                 :            : #include <math.h>
      41                 :            : 
      42                 :            : #include "py/objtuple.h"
      43                 :            : #include "py/objstr.h"
      44                 :            : #include "py/runtime.h"
      45                 :            : #include "py/stream.h"
      46                 :            : #include "py/builtin.h"
      47                 :            : #include "py/mphal.h"
      48                 :            : #include "py/mpthread.h"
      49                 :            : #include "extmod/vfs.h"
      50                 :            : #include <poll.h>
      51                 :            : 
      52                 :            : #if MICROPY_PY_SOCKET
      53                 :            : 
      54                 :            : /*
      55                 :            :   The idea of this module is to implement reasonable minimum of
      56                 :            :   socket-related functions to write typical clients and servers.
      57                 :            :   The module named "usocket" on purpose, to allow to make
      58                 :            :   Python-level module more (or fully) compatible with CPython
      59                 :            :   "socket", e.g.:
      60                 :            :   ---- socket.py ----
      61                 :            :   from usocket import *
      62                 :            :   from socket_more_funcs import *
      63                 :            :   from socket_more_funcs2 import *
      64                 :            :   -------------------
      65                 :            :   I.e. this module should stay lean, and more functions (if needed)
      66                 :            :   should be add to separate modules (C or Python level).
      67                 :            :  */
      68                 :            : 
      69                 :            : // This type must "inherit" from mp_obj_fdfile_t, i.e. matching subset of
      70                 :            : // fields should have the same layout.
      71                 :            : typedef struct _mp_obj_socket_t {
      72                 :            :     mp_obj_base_t base;
      73                 :            :     int fd;
      74                 :            :     bool blocking;
      75                 :            : } mp_obj_socket_t;
      76                 :            : 
      77                 :            : const mp_obj_type_t mp_type_socket;
      78                 :            : 
      79                 :            : // Helper functions
      80                 :          0 : static inline mp_obj_t mp_obj_from_sockaddr(const struct sockaddr *addr, socklen_t len) {
      81                 :          0 :     return mp_obj_new_bytes((const byte *)addr, len);
      82                 :            : }
      83                 :            : 
      84                 :          8 : STATIC mp_obj_socket_t *socket_new(int fd) {
      85                 :          8 :     mp_obj_socket_t *o = mp_obj_malloc(mp_obj_socket_t, &mp_type_socket);
      86                 :          8 :     o->fd = fd;
      87                 :          8 :     o->blocking = true;
      88                 :          8 :     return o;
      89                 :            : }
      90                 :            : 
      91                 :            : 
      92                 :          0 : STATIC void socket_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
      93                 :          0 :     (void)kind;
      94                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
      95                 :          0 :     mp_printf(print, "<_socket %d>", self->fd);
      96                 :          0 : }
      97                 :            : 
      98                 :          0 : STATIC mp_uint_t socket_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
      99                 :          0 :     mp_obj_socket_t *o = MP_OBJ_TO_PTR(o_in);
     100                 :          0 :     ssize_t r;
     101   [ #  #  #  #  :          0 :     MP_HAL_RETRY_SYSCALL(r, read(o->fd, buf, size), {
             #  #  #  # ]
     102                 :            :         // On blocking socket, we get EAGAIN in case SO_RCVTIMEO/SO_SNDTIMEO
     103                 :            :         // timed out, and need to convert that to ETIMEDOUT.
     104                 :            :         if (err == EAGAIN && o->blocking) {
     105                 :            :             err = MP_ETIMEDOUT;
     106                 :            :         }
     107                 :            : 
     108                 :            :         *errcode = err;
     109                 :            :         return MP_STREAM_ERROR;
     110                 :          0 :     });
     111                 :          0 :     return (mp_uint_t)r;
     112                 :            : }
     113                 :            : 
     114                 :          0 : STATIC mp_uint_t socket_write(mp_obj_t o_in, const void *buf, mp_uint_t size, int *errcode) {
     115                 :          0 :     mp_obj_socket_t *o = MP_OBJ_TO_PTR(o_in);
     116                 :          0 :     ssize_t r;
     117   [ #  #  #  #  :          0 :     MP_HAL_RETRY_SYSCALL(r, write(o->fd, buf, size), {
             #  #  #  # ]
     118                 :            :         // On blocking socket, we get EAGAIN in case SO_RCVTIMEO/SO_SNDTIMEO
     119                 :            :         // timed out, and need to convert that to ETIMEDOUT.
     120                 :            :         if (err == EAGAIN && o->blocking) {
     121                 :            :             err = MP_ETIMEDOUT;
     122                 :            :         }
     123                 :            : 
     124                 :            :         *errcode = err;
     125                 :            :         return MP_STREAM_ERROR;
     126                 :          0 :     });
     127                 :          0 :     return (mp_uint_t)r;
     128                 :            : }
     129                 :            : 
     130                 :         18 : STATIC mp_uint_t socket_ioctl(mp_obj_t o_in, mp_uint_t request, uintptr_t arg, int *errcode) {
     131                 :         18 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(o_in);
     132                 :         18 :     (void)arg;
     133      [ +  +  - ]:         18 :     switch (request) {
     134                 :          2 :         case MP_STREAM_CLOSE:
     135                 :            :             // There's a POSIX drama regarding return value of close in general,
     136                 :            :             // and EINTR error in particular. See e.g.
     137                 :            :             // http://lwn.net/Articles/576478/
     138                 :            :             // http://austingroupbugs.net/view.php?id=529
     139                 :            :             // The rationale MicroPython follows is that close() just releases
     140                 :            :             // file descriptor. If you're interested to catch I/O errors before
     141                 :            :             // closing fd, fsync() it.
     142                 :          2 :             MP_THREAD_GIL_EXIT();
     143                 :          2 :             close(self->fd);
     144                 :          2 :             MP_THREAD_GIL_ENTER();
     145                 :          2 :             return 0;
     146                 :            : 
     147                 :         16 :         case MP_STREAM_GET_FILENO:
     148                 :         16 :             return self->fd;
     149                 :            : 
     150                 :            :         #if MICROPY_PY_USELECT
     151                 :            :         case MP_STREAM_POLL: {
     152                 :            :             mp_uint_t ret = 0;
     153                 :            :             uint8_t pollevents = 0;
     154                 :            :             if (arg & MP_STREAM_POLL_RD) {
     155                 :            :                 pollevents |= POLLIN;
     156                 :            :             }
     157                 :            :             if (arg & MP_STREAM_POLL_WR) {
     158                 :            :                 pollevents |= POLLOUT;
     159                 :            :             }
     160                 :            :             struct pollfd pfd = { .fd = self->fd, .events = pollevents };
     161                 :            :             if (poll(&pfd, 1, 0) > 0) {
     162                 :            :                 if (pfd.revents & POLLIN) {
     163                 :            :                     ret |= MP_STREAM_POLL_RD;
     164                 :            :                 }
     165                 :            :                 if (pfd.revents & POLLOUT) {
     166                 :            :                     ret |= MP_STREAM_POLL_WR;
     167                 :            :                 }
     168                 :            :             }
     169                 :            :             return ret;
     170                 :            :         }
     171                 :            :         #endif
     172                 :            : 
     173                 :          0 :         default:
     174                 :          0 :             *errcode = MP_EINVAL;
     175                 :          0 :             return MP_STREAM_ERROR;
     176                 :            :     }
     177                 :            : }
     178                 :            : 
     179                 :          0 : STATIC mp_obj_t socket_fileno(mp_obj_t self_in) {
     180                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     181                 :          0 :     return MP_OBJ_NEW_SMALL_INT(self->fd);
     182                 :            : }
     183                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_fileno_obj, socket_fileno);
     184                 :            : 
     185                 :          0 : STATIC mp_obj_t socket_connect(mp_obj_t self_in, mp_obj_t addr_in) {
     186                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     187                 :          0 :     mp_buffer_info_t bufinfo;
     188                 :          0 :     mp_get_buffer_raise(addr_in, &bufinfo, MP_BUFFER_READ);
     189                 :            : 
     190                 :            :     // special case of PEP 475 to retry only if blocking so we can't use
     191                 :            :     // MP_HAL_RETRY_SYSCALL() here
     192                 :          0 :     for (;;) {
     193                 :          0 :         MP_THREAD_GIL_EXIT();
     194                 :          0 :         int r = connect(self->fd, (const struct sockaddr *)bufinfo.buf, bufinfo.len);
     195                 :          0 :         MP_THREAD_GIL_ENTER();
     196         [ #  # ]:          0 :         if (r == -1) {
     197                 :          0 :             int err = errno;
     198         [ #  # ]:          0 :             if (self->blocking) {
     199         [ #  # ]:          0 :                 if (err == EINTR) {
     200                 :          0 :                     mp_handle_pending(true);
     201                 :          0 :                     continue;
     202                 :            :                 }
     203                 :            :                 // EINPROGRESS on a blocking socket means the operation timed out
     204         [ #  # ]:          0 :                 if (err == EINPROGRESS) {
     205                 :          0 :                     err = MP_ETIMEDOUT;
     206                 :            :                 }
     207                 :            :             }
     208                 :          0 :             mp_raise_OSError(err);
     209                 :            :         }
     210                 :          0 :         return mp_const_none;
     211                 :            :     }
     212                 :            : }
     213                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_connect_obj, socket_connect);
     214                 :            : 
     215                 :          4 : STATIC mp_obj_t socket_bind(mp_obj_t self_in, mp_obj_t addr_in) {
     216                 :          4 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     217                 :          4 :     mp_buffer_info_t bufinfo;
     218                 :          4 :     mp_get_buffer_raise(addr_in, &bufinfo, MP_BUFFER_READ);
     219                 :          4 :     MP_THREAD_GIL_EXIT();
     220                 :          4 :     int r = bind(self->fd, (const struct sockaddr *)bufinfo.buf, bufinfo.len);
     221                 :          4 :     MP_THREAD_GIL_ENTER();
     222         [ -  + ]:          4 :     RAISE_ERRNO(r, errno);
     223                 :          4 :     return mp_const_none;
     224                 :            : }
     225                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_bind_obj, socket_bind);
     226                 :            : 
     227                 :            : // method socket.listen([backlog])
     228                 :          0 : STATIC mp_obj_t socket_listen(size_t n_args, const mp_obj_t *args) {
     229                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     230                 :            : 
     231                 :          0 :     int backlog = MICROPY_PY_USOCKET_LISTEN_BACKLOG_DEFAULT;
     232         [ #  # ]:          0 :     if (n_args > 1) {
     233                 :          0 :         backlog = (int)mp_obj_get_int(args[1]);
     234                 :          0 :         backlog = (backlog < 0) ? 0 : backlog;
     235                 :            :     }
     236                 :            : 
     237                 :          0 :     MP_THREAD_GIL_EXIT();
     238                 :          0 :     int r = listen(self->fd, backlog);
     239                 :          0 :     MP_THREAD_GIL_ENTER();
     240         [ #  # ]:          0 :     RAISE_ERRNO(r, errno);
     241                 :          0 :     return mp_const_none;
     242                 :            : }
     243                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_listen_obj, 1, 2, socket_listen);
     244                 :            : 
     245                 :          0 : STATIC mp_obj_t socket_accept(mp_obj_t self_in) {
     246                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     247                 :            :     // sockaddr_storage isn't stack-friendly (129 bytes or so)
     248                 :            :     // struct sockaddr_storage addr;
     249                 :          0 :     byte addr[32];
     250                 :          0 :     socklen_t addr_len = sizeof(addr);
     251                 :          0 :     int fd;
     252   [ #  #  #  #  :          0 :     MP_HAL_RETRY_SYSCALL(fd, accept(self->fd, (struct sockaddr *)&addr, &addr_len), {
             #  #  #  # ]
     253                 :            :         // EAGAIN on a blocking socket means the operation timed out
     254                 :            :         if (self->blocking && err == EAGAIN) {
     255                 :            :             err = MP_ETIMEDOUT;
     256                 :            :         }
     257                 :            :         mp_raise_OSError(err);
     258                 :          0 :     });
     259                 :            : 
     260                 :          0 :     mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
     261                 :          0 :     t->items[0] = MP_OBJ_FROM_PTR(socket_new(fd));
     262                 :          0 :     t->items[1] = mp_obj_new_bytearray(addr_len, &addr);
     263                 :            : 
     264                 :          0 :     return MP_OBJ_FROM_PTR(t);
     265                 :            : }
     266                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_accept_obj, socket_accept);
     267                 :            : 
     268                 :            : // Note: besides flag param, this differs from read() in that
     269                 :            : // this does not swallow blocking errors (EAGAIN, EWOULDBLOCK) -
     270                 :            : // these would be thrown as exceptions.
     271                 :          4 : STATIC mp_obj_t socket_recv(size_t n_args, const mp_obj_t *args) {
     272                 :          4 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     273                 :          4 :     int sz = MP_OBJ_SMALL_INT_VALUE(args[1]);
     274                 :          4 :     int flags = 0;
     275                 :            : 
     276         [ -  + ]:          4 :     if (n_args > 2) {
     277                 :          0 :         flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
     278                 :            :     }
     279                 :            : 
     280                 :          4 :     byte *buf = m_new(byte, sz);
     281                 :          4 :     ssize_t out_sz;
     282   [ +  -  -  + ]:          4 :     MP_HAL_RETRY_SYSCALL(out_sz, recv(self->fd, buf, sz, flags), mp_raise_OSError(err));
     283                 :          0 :     mp_obj_t ret = mp_obj_new_str_of_type(&mp_type_bytes, buf, out_sz);
     284                 :          0 :     m_del(char, buf, sz);
     285                 :          0 :     return ret;
     286                 :            : }
     287                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_recv_obj, 2, 3, socket_recv);
     288                 :            : 
     289                 :          0 : STATIC mp_obj_t socket_recvfrom(size_t n_args, const mp_obj_t *args) {
     290                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     291                 :          0 :     int sz = MP_OBJ_SMALL_INT_VALUE(args[1]);
     292                 :          0 :     int flags = 0;
     293                 :            : 
     294         [ #  # ]:          0 :     if (n_args > 2) {
     295                 :          0 :         flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
     296                 :            :     }
     297                 :            : 
     298                 :          0 :     struct sockaddr_storage addr;
     299                 :          0 :     socklen_t addr_len = sizeof(addr);
     300                 :            : 
     301                 :          0 :     byte *buf = m_new(byte, sz);
     302                 :          0 :     ssize_t out_sz;
     303   [ #  #  #  # ]:          0 :     MP_HAL_RETRY_SYSCALL(out_sz, recvfrom(self->fd, buf, sz, flags, (struct sockaddr *)&addr, &addr_len),
     304                 :          0 :         mp_raise_OSError(err));
     305                 :          0 :     mp_obj_t buf_o = mp_obj_new_str_of_type(&mp_type_bytes, buf, out_sz);
     306                 :          0 :     m_del(char, buf, sz);
     307                 :            : 
     308                 :          0 :     mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
     309                 :          0 :     t->items[0] = buf_o;
     310                 :          0 :     t->items[1] = mp_obj_from_sockaddr((struct sockaddr *)&addr, addr_len);
     311                 :            : 
     312                 :          0 :     return MP_OBJ_FROM_PTR(t);
     313                 :            : }
     314                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_recvfrom_obj, 2, 3, socket_recvfrom);
     315                 :            : 
     316                 :            : // Note: besides flag param, this differs from write() in that
     317                 :            : // this does not swallow blocking errors (EAGAIN, EWOULDBLOCK) -
     318                 :            : // these would be thrown as exceptions.
     319                 :          0 : STATIC mp_obj_t socket_send(size_t n_args, const mp_obj_t *args) {
     320                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     321                 :          0 :     int flags = 0;
     322                 :            : 
     323         [ #  # ]:          0 :     if (n_args > 2) {
     324                 :          0 :         flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
     325                 :            :     }
     326                 :            : 
     327                 :          0 :     mp_buffer_info_t bufinfo;
     328                 :          0 :     mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
     329                 :          0 :     ssize_t out_sz;
     330   [ #  #  #  # ]:          0 :     MP_HAL_RETRY_SYSCALL(out_sz, send(self->fd, bufinfo.buf, bufinfo.len, flags),
     331                 :          0 :         mp_raise_OSError(err));
     332                 :          0 :     return MP_OBJ_NEW_SMALL_INT(out_sz);
     333                 :            : }
     334                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_send_obj, 2, 3, socket_send);
     335                 :            : 
     336                 :          0 : STATIC mp_obj_t socket_sendto(size_t n_args, const mp_obj_t *args) {
     337                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     338                 :          0 :     int flags = 0;
     339                 :            : 
     340                 :          0 :     mp_obj_t dst_addr = args[2];
     341         [ #  # ]:          0 :     if (n_args > 3) {
     342                 :          0 :         flags = MP_OBJ_SMALL_INT_VALUE(args[2]);
     343                 :          0 :         dst_addr = args[3];
     344                 :            :     }
     345                 :            : 
     346                 :          0 :     mp_buffer_info_t bufinfo, addr_bi;
     347                 :          0 :     mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
     348                 :          0 :     mp_get_buffer_raise(dst_addr, &addr_bi, MP_BUFFER_READ);
     349                 :          0 :     ssize_t out_sz;
     350   [ #  #  #  # ]:          0 :     MP_HAL_RETRY_SYSCALL(out_sz, sendto(self->fd, bufinfo.buf, bufinfo.len, flags,
     351                 :          0 :         (struct sockaddr *)addr_bi.buf, addr_bi.len), mp_raise_OSError(err));
     352                 :          0 :     return MP_OBJ_NEW_SMALL_INT(out_sz);
     353                 :            : }
     354                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_sendto_obj, 3, 4, socket_sendto);
     355                 :            : 
     356                 :          0 : STATIC mp_obj_t socket_setsockopt(size_t n_args, const mp_obj_t *args) {
     357                 :          0 :     (void)n_args; // always 4
     358                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     359                 :          0 :     int level = MP_OBJ_SMALL_INT_VALUE(args[1]);
     360                 :          0 :     int option = mp_obj_get_int(args[2]);
     361                 :            : 
     362                 :          0 :     const void *optval;
     363                 :          0 :     socklen_t optlen;
     364                 :          0 :     int val;
     365   [ #  #  #  #  :          0 :     if (mp_obj_is_int(args[3])) {
                   #  # ]
     366                 :          0 :         val = mp_obj_int_get_truncated(args[3]);
     367                 :          0 :         optval = &val;
     368                 :          0 :         optlen = sizeof(val);
     369                 :            :     } else {
     370                 :          0 :         mp_buffer_info_t bufinfo;
     371                 :          0 :         mp_get_buffer_raise(args[3], &bufinfo, MP_BUFFER_READ);
     372                 :          0 :         optval = bufinfo.buf;
     373                 :          0 :         optlen = bufinfo.len;
     374                 :            :     }
     375                 :          0 :     MP_THREAD_GIL_EXIT();
     376                 :          0 :     int r = setsockopt(self->fd, level, option, optval, optlen);
     377                 :          0 :     MP_THREAD_GIL_ENTER();
     378         [ #  # ]:          0 :     RAISE_ERRNO(r, errno);
     379                 :          0 :     return mp_const_none;
     380                 :            : }
     381                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_setsockopt_obj, 4, 4, socket_setsockopt);
     382                 :            : 
     383                 :          2 : STATIC mp_obj_t socket_setblocking(mp_obj_t self_in, mp_obj_t flag_in) {
     384                 :          2 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     385                 :          2 :     int val = mp_obj_is_true(flag_in);
     386                 :          2 :     MP_THREAD_GIL_EXIT();
     387                 :          2 :     int flags = fcntl(self->fd, F_GETFL, 0);
     388         [ -  + ]:          2 :     if (flags == -1) {
     389                 :          0 :         MP_THREAD_GIL_ENTER();
     390                 :          0 :         RAISE_ERRNO(flags, errno);
     391                 :            :     }
     392         [ -  + ]:          2 :     if (val) {
     393                 :          0 :         flags &= ~O_NONBLOCK;
     394                 :            :     } else {
     395                 :          2 :         flags |= O_NONBLOCK;
     396                 :            :     }
     397                 :          2 :     flags = fcntl(self->fd, F_SETFL, flags);
     398                 :          2 :     MP_THREAD_GIL_ENTER();
     399         [ -  + ]:          2 :     RAISE_ERRNO(flags, errno);
     400                 :          2 :     self->blocking = val;
     401                 :          2 :     return mp_const_none;
     402                 :            : }
     403                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_setblocking_obj, socket_setblocking);
     404                 :            : 
     405                 :          2 : STATIC mp_obj_t socket_settimeout(mp_obj_t self_in, mp_obj_t timeout_in) {
     406                 :          2 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(self_in);
     407                 :          2 :     struct timeval tv = {0, };
     408                 :          2 :     bool new_blocking = true;
     409                 :            : 
     410                 :            :     // Timeout of None means no timeout, which in POSIX is signified with 0 timeout,
     411                 :            :     // and that's how 'tv' is initialized above
     412         [ +  - ]:          2 :     if (timeout_in != mp_const_none) {
     413                 :            :         #if MICROPY_PY_BUILTINS_FLOAT
     414                 :          2 :         mp_float_t val = mp_obj_get_float(timeout_in);
     415                 :          2 :         mp_float_t ipart;
     416                 :          2 :         tv.tv_usec = (time_t)MICROPY_FLOAT_C_FUN(round)(MICROPY_FLOAT_C_FUN(modf)(val, &ipart) * MICROPY_FLOAT_CONST(1000000.));
     417                 :          2 :         tv.tv_sec = (suseconds_t)ipart;
     418                 :            :         #else
     419                 :            :         tv.tv_sec = mp_obj_get_int(timeout_in);
     420                 :            :         #endif
     421                 :            : 
     422                 :            :         // For SO_RCVTIMEO/SO_SNDTIMEO, zero timeout means infinity, but
     423                 :            :         // for Python API it means non-blocking.
     424   [ +  -  +  - ]:          2 :         if (tv.tv_sec == 0 && tv.tv_usec == 0) {
     425                 :          2 :             new_blocking = false;
     426                 :            :         }
     427                 :            :     }
     428                 :            : 
     429                 :          2 :     if (new_blocking) {
     430                 :          0 :         int r;
     431                 :          0 :         MP_THREAD_GIL_EXIT();
     432                 :          0 :         r = setsockopt(self->fd, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(struct timeval));
     433         [ #  # ]:          0 :         if (r == -1) {
     434                 :          0 :             MP_THREAD_GIL_ENTER();
     435                 :          0 :             RAISE_ERRNO(r, errno);
     436                 :            :         }
     437                 :          0 :         r = setsockopt(self->fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(struct timeval));
     438                 :          0 :         MP_THREAD_GIL_ENTER();
     439         [ #  # ]:          0 :         RAISE_ERRNO(r, errno);
     440                 :            :     }
     441                 :            : 
     442         [ +  - ]:          2 :     if (self->blocking != new_blocking) {
     443         [ +  - ]:          4 :         socket_setblocking(self_in, mp_obj_new_bool(new_blocking));
     444                 :            :     }
     445                 :            : 
     446                 :          2 :     return mp_const_none;
     447                 :            : }
     448                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_settimeout_obj, socket_settimeout);
     449                 :            : 
     450                 :          0 : STATIC mp_obj_t socket_makefile(size_t n_args, const mp_obj_t *args) {
     451                 :            :     // TODO: CPython explicitly says that closing returned object doesn't close
     452                 :            :     // the original socket (Python2 at all says that fd is dup()ed). But we
     453                 :            :     // save on the bloat.
     454                 :          0 :     mp_obj_socket_t *self = MP_OBJ_TO_PTR(args[0]);
     455                 :          0 :     mp_obj_t *new_args = alloca(n_args * sizeof(mp_obj_t));
     456                 :          0 :     memcpy(new_args + 1, args + 1, (n_args - 1) * sizeof(mp_obj_t));
     457                 :          0 :     new_args[0] = MP_OBJ_NEW_SMALL_INT(self->fd);
     458                 :          0 :     return mp_vfs_open(n_args, new_args, (mp_map_t *)&mp_const_empty_map);
     459                 :            : }
     460                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_makefile_obj, 1, 3, socket_makefile);
     461                 :            : 
     462                 :          8 : STATIC mp_obj_t socket_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
     463                 :          8 :     (void)type_in;
     464                 :          8 :     (void)n_kw;
     465                 :            : 
     466                 :          8 :     int family = AF_INET;
     467                 :          8 :     int type = SOCK_STREAM;
     468                 :          8 :     int proto = 0;
     469                 :            : 
     470         [ +  + ]:          8 :     if (n_args > 0) {
     471         [ -  + ]:          4 :         assert(mp_obj_is_small_int(args[0]));
     472                 :          4 :         family = MP_OBJ_SMALL_INT_VALUE(args[0]);
     473         [ +  - ]:          4 :         if (n_args > 1) {
     474         [ -  + ]:          4 :             assert(mp_obj_is_small_int(args[1]));
     475                 :          4 :             type = MP_OBJ_SMALL_INT_VALUE(args[1]);
     476         [ -  + ]:          4 :             if (n_args > 2) {
     477         [ #  # ]:          0 :                 assert(mp_obj_is_small_int(args[2]));
     478                 :          0 :                 proto = MP_OBJ_SMALL_INT_VALUE(args[2]);
     479                 :            :             }
     480                 :            :         }
     481                 :            :     }
     482                 :            : 
     483                 :          8 :     MP_THREAD_GIL_EXIT();
     484                 :          8 :     int fd = socket(family, type, proto);
     485                 :          8 :     MP_THREAD_GIL_ENTER();
     486         [ -  + ]:          8 :     RAISE_ERRNO(fd, errno);
     487                 :          8 :     return MP_OBJ_FROM_PTR(socket_new(fd));
     488                 :            : }
     489                 :            : 
     490                 :            : STATIC const mp_rom_map_elem_t usocket_locals_dict_table[] = {
     491                 :            :     { MP_ROM_QSTR(MP_QSTR_fileno), MP_ROM_PTR(&socket_fileno_obj) },
     492                 :            :     { MP_ROM_QSTR(MP_QSTR_makefile), MP_ROM_PTR(&socket_makefile_obj) },
     493                 :            :     { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
     494                 :            :     { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
     495                 :            :     { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
     496                 :            :     { MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mp_stream_write_obj) },
     497                 :            :     { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&socket_connect_obj) },
     498                 :            :     { MP_ROM_QSTR(MP_QSTR_bind), MP_ROM_PTR(&socket_bind_obj) },
     499                 :            :     { MP_ROM_QSTR(MP_QSTR_listen), MP_ROM_PTR(&socket_listen_obj) },
     500                 :            :     { MP_ROM_QSTR(MP_QSTR_accept), MP_ROM_PTR(&socket_accept_obj) },
     501                 :            :     { MP_ROM_QSTR(MP_QSTR_recv), MP_ROM_PTR(&socket_recv_obj) },
     502                 :            :     { MP_ROM_QSTR(MP_QSTR_recvfrom), MP_ROM_PTR(&socket_recvfrom_obj) },
     503                 :            :     { MP_ROM_QSTR(MP_QSTR_send), MP_ROM_PTR(&socket_send_obj) },
     504                 :            :     { MP_ROM_QSTR(MP_QSTR_sendto), MP_ROM_PTR(&socket_sendto_obj) },
     505                 :            :     { MP_ROM_QSTR(MP_QSTR_setsockopt), MP_ROM_PTR(&socket_setsockopt_obj) },
     506                 :            :     { MP_ROM_QSTR(MP_QSTR_setblocking), MP_ROM_PTR(&socket_setblocking_obj) },
     507                 :            :     { MP_ROM_QSTR(MP_QSTR_settimeout), MP_ROM_PTR(&socket_settimeout_obj) },
     508                 :            :     { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
     509                 :            : };
     510                 :            : 
     511                 :            : STATIC MP_DEFINE_CONST_DICT(usocket_locals_dict, usocket_locals_dict_table);
     512                 :            : 
     513                 :            : STATIC const mp_stream_p_t usocket_stream_p = {
     514                 :            :     .read = socket_read,
     515                 :            :     .write = socket_write,
     516                 :            :     .ioctl = socket_ioctl,
     517                 :            : };
     518                 :            : 
     519                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     520                 :            :     mp_type_socket,
     521                 :            :     MP_QSTR_socket,
     522                 :            :     MP_TYPE_FLAG_NONE,
     523                 :            :     make_new, socket_make_new,
     524                 :            :     print, socket_print,
     525                 :            :     protocol, &usocket_stream_p,
     526                 :            :     locals_dict, &usocket_locals_dict
     527                 :            :     );
     528                 :            : 
     529                 :            : #define BINADDR_MAX_LEN sizeof(struct in6_addr)
     530                 :          0 : STATIC mp_obj_t mod_socket_inet_pton(mp_obj_t family_in, mp_obj_t addr_in) {
     531                 :          0 :     int family = mp_obj_get_int(family_in);
     532                 :          0 :     byte binaddr[BINADDR_MAX_LEN];
     533                 :          0 :     int r = inet_pton(family, mp_obj_str_get_str(addr_in), binaddr);
     534         [ #  # ]:          0 :     RAISE_ERRNO(r, errno);
     535         [ #  # ]:          0 :     if (r == 0) {
     536                 :          0 :         mp_raise_OSError(MP_EINVAL);
     537                 :            :     }
     538                 :          0 :     int binaddr_len = 0;
     539      [ #  #  # ]:          0 :     switch (family) {
     540                 :          0 :         case AF_INET:
     541                 :          0 :             binaddr_len = sizeof(struct in_addr);
     542                 :          0 :             break;
     543                 :          0 :         case AF_INET6:
     544                 :          0 :             binaddr_len = sizeof(struct in6_addr);
     545                 :          0 :             break;
     546                 :            :     }
     547                 :          0 :     return mp_obj_new_bytes(binaddr, binaddr_len);
     548                 :            : }
     549                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_socket_inet_pton_obj, mod_socket_inet_pton);
     550                 :            : 
     551                 :          0 : STATIC mp_obj_t mod_socket_inet_ntop(mp_obj_t family_in, mp_obj_t binaddr_in) {
     552                 :          0 :     int family = mp_obj_get_int(family_in);
     553                 :          0 :     mp_buffer_info_t bufinfo;
     554                 :          0 :     mp_get_buffer_raise(binaddr_in, &bufinfo, MP_BUFFER_READ);
     555                 :          0 :     vstr_t vstr;
     556         [ #  # ]:          0 :     vstr_init_len(&vstr, family == AF_INET ? INET_ADDRSTRLEN : INET6_ADDRSTRLEN);
     557         [ #  # ]:          0 :     if (inet_ntop(family, bufinfo.buf, vstr.buf, vstr.len) == NULL) {
     558                 :          0 :         mp_raise_OSError(errno);
     559                 :            :     }
     560                 :          0 :     vstr.len = strlen(vstr.buf);
     561                 :          0 :     return mp_obj_new_str_from_utf8_vstr(&vstr);
     562                 :            : }
     563                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_socket_inet_ntop_obj, mod_socket_inet_ntop);
     564                 :            : 
     565                 :          4 : STATIC mp_obj_t mod_socket_getaddrinfo(size_t n_args, const mp_obj_t *args) {
     566                 :            : 
     567                 :          4 :     const char *host = mp_obj_str_get_str(args[0]);
     568                 :          4 :     const char *serv = NULL;
     569                 :          4 :     struct addrinfo hints;
     570                 :          4 :     char buf[6];
     571                 :          4 :     memset(&hints, 0, sizeof(hints));
     572                 :            :     // getaddrinfo accepts port in string notation, so however
     573                 :            :     // it may seem stupid, we need to convert int to str
     574         [ +  - ]:          4 :     if (mp_obj_is_small_int(args[1])) {
     575                 :          4 :         unsigned port = (unsigned short)MP_OBJ_SMALL_INT_VALUE(args[1]);
     576                 :          4 :         snprintf(buf, sizeof(buf), "%u", port);
     577                 :          4 :         serv = buf;
     578                 :          4 :         hints.ai_flags = AI_NUMERICSERV;
     579                 :            :         #ifdef __UCLIBC_MAJOR__
     580                 :            :         #if __UCLIBC_MAJOR__ == 0 && (__UCLIBC_MINOR__ < 9 || (__UCLIBC_MINOR__ == 9 && __UCLIBC_SUBLEVEL__ <= 32))
     581                 :            : // "warning" requires -Wno-cpp which is a relatively new gcc option, so we choose not to use it.
     582                 :            : // #warning Working around uClibc bug with numeric service name
     583                 :            :         // Older versions og uClibc have bugs when numeric ports in service
     584                 :            :         // arg require also hints.ai_socktype (or hints.ai_protocol) != 0
     585                 :            :         // This actually was fixed in 0.9.32.1, but uClibc doesn't allow to
     586                 :            :         // test for that.
     587                 :            :         // http://git.uclibc.org/uClibc/commit/libc/inet/getaddrinfo.c?id=bc3be18145e4d5
     588                 :            :         // Note that this is crude workaround, precluding UDP socket addresses
     589                 :            :         // to be returned. TODO: set only if not set by Python args.
     590                 :            :         hints.ai_socktype = SOCK_STREAM;
     591                 :            :         #endif
     592                 :            :         #endif
     593                 :            :     } else {
     594                 :          0 :         serv = mp_obj_str_get_str(args[1]);
     595                 :            :     }
     596                 :            : 
     597         [ -  + ]:          4 :     if (n_args > 2) {
     598                 :          0 :         hints.ai_family = MP_OBJ_SMALL_INT_VALUE(args[2]);
     599         [ #  # ]:          0 :         if (n_args > 3) {
     600                 :          0 :             hints.ai_socktype = MP_OBJ_SMALL_INT_VALUE(args[3]);
     601         [ #  # ]:          0 :             if (n_args > 4) {
     602                 :          0 :                 hints.ai_protocol = MP_OBJ_SMALL_INT_VALUE(args[4]);
     603         [ #  # ]:          0 :                 if (n_args > 5) {
     604                 :          0 :                     hints.ai_flags = MP_OBJ_SMALL_INT_VALUE(args[5]);
     605                 :            :                 }
     606                 :            :             }
     607                 :            :         }
     608                 :            :     }
     609                 :            : 
     610                 :          4 :     struct addrinfo *addr_list;
     611                 :          4 :     MP_THREAD_GIL_EXIT();
     612                 :          4 :     int res = getaddrinfo(host, serv, &hints, &addr_list);
     613                 :          4 :     MP_THREAD_GIL_ENTER();
     614                 :            : 
     615         [ -  + ]:          4 :     if (res != 0) {
     616                 :            :         // CPython: socket.gaierror
     617                 :          0 :         mp_raise_msg_varg(&mp_type_OSError, MP_ERROR_TEXT("[addrinfo error %d]"), res);
     618                 :            :     }
     619         [ -  + ]:          4 :     assert(addr_list);
     620                 :            : 
     621                 :          4 :     mp_obj_t list = mp_obj_new_list(0, NULL);
     622         [ +  + ]:         16 :     for (struct addrinfo *addr = addr_list; addr; addr = addr->ai_next) {
     623                 :         12 :         mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(5, NULL));
     624                 :         12 :         t->items[0] = MP_OBJ_NEW_SMALL_INT(addr->ai_family);
     625                 :         12 :         t->items[1] = MP_OBJ_NEW_SMALL_INT(addr->ai_socktype);
     626                 :         12 :         t->items[2] = MP_OBJ_NEW_SMALL_INT(addr->ai_protocol);
     627                 :            :         // "canonname will be a string representing the canonical name of the host
     628                 :            :         // if AI_CANONNAME is part of the flags argument; else canonname will be empty." ??
     629         [ -  + ]:         12 :         if (addr->ai_canonname) {
     630                 :          0 :             t->items[3] = MP_OBJ_NEW_QSTR(qstr_from_str(addr->ai_canonname));
     631                 :            :         } else {
     632                 :         12 :             t->items[3] = mp_const_none;
     633                 :            :         }
     634                 :         12 :         t->items[4] = mp_obj_new_bytearray(addr->ai_addrlen, addr->ai_addr);
     635                 :         12 :         mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
     636                 :            :     }
     637                 :          4 :     freeaddrinfo(addr_list);
     638                 :          4 :     return list;
     639                 :            : }
     640                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_socket_getaddrinfo_obj, 2, 6, mod_socket_getaddrinfo);
     641                 :            : 
     642                 :          0 : STATIC mp_obj_t mod_socket_sockaddr(mp_obj_t sockaddr_in) {
     643                 :          0 :     mp_buffer_info_t bufinfo;
     644                 :          0 :     mp_get_buffer_raise(sockaddr_in, &bufinfo, MP_BUFFER_READ);
     645      [ #  #  # ]:          0 :     switch (((struct sockaddr *)bufinfo.buf)->sa_family) {
     646                 :          0 :         case AF_INET: {
     647                 :          0 :             struct sockaddr_in *sa = (struct sockaddr_in *)bufinfo.buf;
     648                 :          0 :             mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(3, NULL));
     649                 :          0 :             t->items[0] = MP_OBJ_NEW_SMALL_INT(AF_INET);
     650                 :          0 :             t->items[1] = mp_obj_new_bytes((byte *)&sa->sin_addr, sizeof(sa->sin_addr));
     651                 :          0 :             t->items[2] = MP_OBJ_NEW_SMALL_INT(ntohs(sa->sin_port));
     652                 :          0 :             return MP_OBJ_FROM_PTR(t);
     653                 :            :         }
     654                 :          0 :         case AF_INET6: {
     655                 :          0 :             struct sockaddr_in6 *sa = (struct sockaddr_in6 *)bufinfo.buf;
     656                 :          0 :             mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(5, NULL));
     657                 :          0 :             t->items[0] = MP_OBJ_NEW_SMALL_INT(AF_INET6);
     658                 :          0 :             t->items[1] = mp_obj_new_bytes((byte *)&sa->sin6_addr, sizeof(sa->sin6_addr));
     659                 :          0 :             t->items[2] = MP_OBJ_NEW_SMALL_INT(ntohs(sa->sin6_port));
     660                 :          0 :             t->items[3] = MP_OBJ_NEW_SMALL_INT(ntohl(sa->sin6_flowinfo));
     661                 :          0 :             t->items[4] = MP_OBJ_NEW_SMALL_INT(ntohl(sa->sin6_scope_id));
     662                 :          0 :             return MP_OBJ_FROM_PTR(t);
     663                 :            :         }
     664                 :          0 :         default: {
     665                 :          0 :             struct sockaddr *sa = (struct sockaddr *)bufinfo.buf;
     666                 :          0 :             mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
     667                 :          0 :             t->items[0] = MP_OBJ_NEW_SMALL_INT(sa->sa_family);
     668                 :          0 :             t->items[1] = mp_obj_new_bytes((byte *)sa->sa_data, bufinfo.len - offsetof(struct sockaddr, sa_data));
     669                 :          0 :             return MP_OBJ_FROM_PTR(t);
     670                 :            :         }
     671                 :            :     }
     672                 :            :     return mp_const_none;
     673                 :            : }
     674                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_socket_sockaddr_obj, mod_socket_sockaddr);
     675                 :            : 
     676                 :            : STATIC const mp_rom_map_elem_t mp_module_socket_globals_table[] = {
     677                 :            :     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_usocket) },
     678                 :            :     { MP_ROM_QSTR(MP_QSTR_socket), MP_ROM_PTR(&mp_type_socket) },
     679                 :            :     { MP_ROM_QSTR(MP_QSTR_getaddrinfo), MP_ROM_PTR(&mod_socket_getaddrinfo_obj) },
     680                 :            :     { MP_ROM_QSTR(MP_QSTR_inet_pton), MP_ROM_PTR(&mod_socket_inet_pton_obj) },
     681                 :            :     { MP_ROM_QSTR(MP_QSTR_inet_ntop), MP_ROM_PTR(&mod_socket_inet_ntop_obj) },
     682                 :            :     { MP_ROM_QSTR(MP_QSTR_sockaddr), MP_ROM_PTR(&mod_socket_sockaddr_obj) },
     683                 :            : 
     684                 :            : #define C(name) { MP_ROM_QSTR(MP_QSTR_##name), MP_ROM_INT(name) }
     685                 :            :     C(AF_UNIX),
     686                 :            :     C(AF_INET),
     687                 :            :     C(AF_INET6),
     688                 :            :     C(SOCK_STREAM),
     689                 :            :     C(SOCK_DGRAM),
     690                 :            :     C(SOCK_RAW),
     691                 :            : 
     692                 :            :     C(MSG_DONTROUTE),
     693                 :            :     C(MSG_DONTWAIT),
     694                 :            : 
     695                 :            :     C(SOL_SOCKET),
     696                 :            :     C(SO_BROADCAST),
     697                 :            :     C(SO_ERROR),
     698                 :            :     C(SO_KEEPALIVE),
     699                 :            :     C(SO_LINGER),
     700                 :            :     C(SO_REUSEADDR),
     701                 :            : #undef C
     702                 :            : };
     703                 :            : 
     704                 :            : STATIC MP_DEFINE_CONST_DICT(mp_module_socket_globals, mp_module_socket_globals_table);
     705                 :            : 
     706                 :            : const mp_obj_module_t mp_module_socket = {
     707                 :            :     .base = { &mp_type_module },
     708                 :            :     .globals = (mp_obj_dict_t *)&mp_module_socket_globals,
     709                 :            : };
     710                 :            : 
     711                 :            : MP_REGISTER_MODULE(MP_QSTR_usocket, mp_module_socket);
     712                 :            : 
     713                 :            : #endif // MICROPY_PY_SOCKET

Generated by: LCOV version 1.15-5-g462f71d