add module msgpack

This commit is contained in:
Bernhard Boser 2020-11-08 18:39:20 -08:00 committed by Scott Shawcroft
parent 5b3c930e38
commit 90c203a3dd
No known key found for this signature in database
GPG Key ID: 0DFD512649C052DA
6 changed files with 443 additions and 0 deletions

View File

@ -52,6 +52,8 @@ MCU_SUB_VARIANT = nrf52840
# Fits on nrf52840 but space is tight on nrf52833.
CIRCUITPY_AESIO ?= 1
CIRCUITPY_MSGPACK ?= 1
SD ?= s140
SOFTDEV_VERSION ?= 6.1.0

View File

@ -283,6 +283,9 @@ endif
ifeq ($(CIRCUITPY_PEW),1)
SRC_PATTERNS += _pew/%
endif
ifeq ($(CIRCUITPY_MSGPACK),1)
SRC_PATTERNS += msgpack/%
endif
# All possible sources are listed here, and are filtered by SRC_PATTERNS in SRC_COMMON_HAL
SRC_COMMON_HAL_ALL = \
@ -396,6 +399,7 @@ $(filter $(SRC_PATTERNS), \
fontio/Glyph.c \
math/__init__.c \
microcontroller/RunMode.c \
msgpack/__init__.c \
)
SRC_BINDINGS_ENUMS += \

View File

@ -754,6 +754,13 @@ extern const struct _mp_obj_module_t wifi_module;
#define WIFI_MODULE
#endif
#if CIRCUITPY_MSGPACK
extern const struct _mp_obj_module_t msgpack_module;
#define MSGPACK_MODULE { MP_ROM_QSTR(MP_QSTR_msgpack), MP_ROM_PTR(&msgpack_module) },
#else
#define MSGPACK_MODULE
#endif
// Define certain native modules with weak links so they can be replaced with Python
// implementations. This list may grow over time.
#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS \
@ -839,6 +846,7 @@ extern const struct _mp_obj_module_t wifi_module;
USTACK_MODULE \
WATCHDOG_MODULE \
WIFI_MODULE \
MSGPACK_MODULE \
// If weak links are enabled, just include strong links in the main list of modules,
// and also include the underscore alternate names.

View File

@ -296,3 +296,7 @@ CFLAGS += -DCIRCUITPY_WIFI=$(CIRCUITPY_WIFI)
# Enabled micropython.native decorator (experimental)
CIRCUITPY_ENABLE_MPY_NATIVE ?= 0
CFLAGS += -DCIRCUITPY_ENABLE_MPY_NATIVE=$(CIRCUITPY_ENABLE_MPY_NATIVE)
CIRCUITPY_MSGPACK ?= 0
CFLAGS += -DCIRCUITPY_MSGPACK=$(CIRCUITPY_MSGPACK)

View File

@ -0,0 +1,391 @@
/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2019 Bernhard Boser
*
* 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.
*/
#include <stdio.h>
#include "py/binary.h"
#include "py/objarray.h"
#include "py/objlist.h"
#include "py/objstringio.h"
#include "py/parsenum.h"
#include "py/runtime.h"
#include "py/stream.h"
#include "supervisor/shared/translate.h"
////////////////////////////////////////////////////////////////
// stream management
typedef struct _msgpack_stream_t {
mp_obj_t stream_obj;
mp_uint_t (*read)(mp_obj_t obj, void *buf, mp_uint_t size, int *errcode);
mp_uint_t (*write)(mp_obj_t obj, const void *buf, mp_uint_t size, int *errcode);
int errcode;
} msgpack_stream_t;
STATIC msgpack_stream_t get_stream(mp_obj_t stream_obj, int flags) {
const mp_stream_p_t *stream_p = mp_get_stream_raise(stream_obj, flags);
msgpack_stream_t s = {stream_obj, stream_p->read, stream_p->write, 0};
return s;
}
////////////////////////////////////////////////////////////////
// readers
STATIC void read(msgpack_stream_t *s, void *buf, mp_uint_t size) {
if (size == 0) return;
mp_uint_t ret = s->read(s->stream_obj, buf, size, &s->errcode);
if (s->errcode != 0) {
mp_raise_OSError(s->errcode);
}
if (ret == 0) {
mp_raise_msg(&mp_type_EOFError, NULL);
}
}
STATIC uint32_t read_bytes(msgpack_stream_t *s, mp_uint_t n_bytes) {
uint32_t res = 0;
read(s, &res, n_bytes);
return res;
}
size_t read_size(msgpack_stream_t *s, uint8_t len_index) {
size_t n_bytes = 4;
switch (len_index) {
case 0: n_bytes = 1; break;
case 1: n_bytes = 2; break;
case 2: n_bytes = 4; break;
}
size_t res = 0;
read(s, &res, n_bytes);
return res;
}
////////////////////////////////////////////////////////////////
// writers
STATIC void write(msgpack_stream_t *s, const void *buf, mp_uint_t size) {
mp_uint_t ret = s->write(s->stream_obj, buf, size, &s->errcode);
if (s->errcode != 0) {
mp_raise_OSError(s->errcode);
}
if (ret == 0) {
mp_raise_msg(&mp_type_EOFError, NULL);
}
}
STATIC void write_bytes(msgpack_stream_t *s, mp_uint_t n_bytes, uint32_t obj) {
write(s, &obj, n_bytes);
}
void write_size(msgpack_stream_t *s, uint8_t code, size_t size) {
if ((uint8_t)size == size) {
write_bytes(s, 1, code);
write_bytes(s, 1, size);
} else if ((uint16_t)size == size) {
write_bytes(s, 1, code+1);
write_bytes(s, 2, size);
} else {
write_bytes(s, 1, code+2);
write_bytes(s, 4, size);
}
}
////////////////////////////////////////////////////////////////
// packers
// This is a helper function to iterate through a dictionary. The state of
// the iteration is held in *cur and should be initialised with zero for the
// first call. Will return NULL when no more elements are available.
STATIC mp_map_elem_t *dict_iter_next(mp_obj_dict_t *dict, size_t *cur) {
size_t max = dict->map.alloc;
mp_map_t *map = &dict->map;
for (size_t i = *cur; i < max; i++) {
if (MP_MAP_SLOT_IS_FILLED(map, i)) {
*cur = i + 1;
return &(map->table[i]);
}
}
return NULL;
}
STATIC void pack_int(msgpack_stream_t *s, int32_t x) {
if (x > -32 && x < 128) {
write_bytes(s, 1, x);
} else if ((int8_t)x == x) {
write_bytes(s, 1, 0xd0);
write_bytes(s, 1, x);
} else if ((int16_t)x == x) {
write_bytes(s, 1, 0xd1);
write_bytes(s, 2, x);
} else {
write_bytes(s, 1, 0xd2);
write_bytes(s, 4, x);
}
}
void pack_bin(msgpack_stream_t *s, const uint8_t* data, size_t len) {
write_size(s, 0xc4, len);
for (size_t i=0; i<len; i++) {
write_bytes(s, 1, data[i]);
}
}
void pack_str(msgpack_stream_t *s, const char* str, size_t len) {
// size_t len = strlen(str);
if (len < 32) {
write_bytes(s, 1, 0b10100000 | (uint8_t)len);
} else {
write_size(s, 0xd9, len);
}
for (size_t l=0; l<len; l++) {
write_bytes(s, 1, str[l]);
}
}
void pack_array(msgpack_stream_t *s, size_t len) {
// only writes the header, manually write the objects after calling pack_array!
if (len < 16) {
write_bytes(s, 1, 0b10010000 | (uint8_t)len);
} else if (len < 0x10000) {
write_bytes(s, 1, 0xdc);
write_bytes(s, 2, len);
} else {
write_bytes(s, 1, 0xdd);
write_bytes(s, 4, len);
}
}
void pack_dict(msgpack_stream_t *s, size_t len) {
// only writes the header, manually write the objects after calling pack_array!
if (len < 16) {
write_bytes(s, 1, 0b10000000 | (uint8_t)len);
} else if (len < 0x10000) {
write_bytes(s, 1, 0xde);
write_bytes(s, 2, len);
} else {
write_bytes(s, 1, 0xdf);
write_bytes(s, 4, len);
}
}
// Write obj to stream in msgpack format
STATIC void _pack(mp_obj_t obj, msgpack_stream_t *s) {
if (MP_OBJ_IS_SMALL_INT(obj)) {
// int
int32_t x = MP_OBJ_SMALL_INT_VALUE(obj);
pack_int(s, x);
} else if (MP_OBJ_IS_STR(obj)) {
// string
size_t len;
const char *data = mp_obj_str_get_data(obj, &len);
pack_str(s, data, len);
} else if (MP_OBJ_IS_TYPE(obj, &mp_type_bytes)) {
// bytes
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(obj, &bufinfo, MP_BUFFER_READ);
pack_bin(s, bufinfo.buf, bufinfo.len);
} else if (MP_OBJ_IS_TYPE(obj, &mp_type_tuple)) {
// tuple
mp_obj_tuple_t *self = MP_OBJ_TO_PTR(obj);
pack_array(s, self->len);
for (size_t i=0; i<self->len; i++) {
_pack(self->items[i], s);
}
} else if (MP_OBJ_IS_TYPE(obj, &mp_type_list)) {
// list (layout differs from tuple)
mp_obj_list_t *self = MP_OBJ_TO_PTR(obj);
pack_array(s, self->len);
for (size_t i=0; i<self->len; i++) {
_pack(self->items[i], s);
}
} else if (MP_OBJ_IS_TYPE(obj, &mp_type_dict)) {
// dict
mp_obj_dict_t *self = MP_OBJ_TO_PTR(obj);
pack_dict(s, self->map.used);
size_t cur = 0;
mp_map_elem_t *next = NULL;
while ((next = dict_iter_next(self, &cur)) != NULL) {
_pack(next->key, s);
_pack(next->value, s);
}
} else if (mp_obj_is_float(obj)) {
mp_float_t f = mp_obj_float_get(obj);
write_bytes(s, 1, 0xca);
write(s, &f, 4);
} else if (obj == mp_const_none) {
write_bytes(s, 1, 0xc0);
} else if (obj == mp_const_false) {
write_bytes(s, 1, 0xc2);
} else if (obj == mp_const_true) {
write_bytes(s, 1, 0xc3);
} else {
mp_raise_ValueError(translate("no packer"));
}
}
// Write obj to stream in msgpack format
STATIC mp_obj_t mod_msgpack_pack(mp_obj_t obj, mp_obj_t stream_obj) {
msgpack_stream_t s = get_stream(stream_obj, MP_STREAM_OP_WRITE);
_pack(obj, &s);
return mp_const_none;
}
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_msgpack_pack_obj, mod_msgpack_pack);
////////////////////////////////////////////////////////////////
// un-packers
STATIC mp_obj_t _unpack(msgpack_stream_t *s) {
uint8_t code = read_bytes(s, 1);
if (((code & 0b10000000) == 0) || ((code & 0b11100000) == 0b11100000)) {
// int
return MP_OBJ_NEW_SMALL_INT((int8_t)code);
}
if ((code & 0b11100000) == 0b10100000) {
// str
size_t len = code & 0b11111;
// allocate on stack; len < 32
char str[len];
read(s, &str, len);
return mp_obj_new_str(str, len);
}
if ((code & 0b11110000) == 0b10010000) {
// array (tuple)
size_t len = code & 0b1111;
mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(len, NULL));
for (size_t i=0; i<len; i++) {
t->items[i] = _unpack(s);
}
return MP_OBJ_FROM_PTR(t);
}
if ((code & 0b11110000) == 0b10000000) {
// map (dict)
size_t len = code & 0b1111;
mp_obj_dict_t *d = MP_OBJ_TO_PTR(mp_obj_new_dict(len));
for (size_t i=0; i<len; i++) {
mp_obj_dict_store(d, _unpack(s), _unpack(s));
}
return MP_OBJ_FROM_PTR(d);
}
switch (code) {
case 0xc0: return mp_const_none;
case 0xc2: return mp_const_false;
case 0xc3: return mp_const_true;
case 0xc4:
case 0xc5:
case 0xc6: {
// bin 8, 16, 32
size_t size = read_size(s, code-0xc4);
vstr_t vstr;
vstr_init_len(&vstr, size);
byte *p = (byte*)vstr.buf;
read(s, p, size);
return mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
}
case 0xca: {
float f;
read(s, &f, 4);
return mp_obj_new_float(f);
}
case 0xd0:
return MP_OBJ_NEW_SMALL_INT((int8_t)read_bytes(s, 1));
case 0xd1:
return MP_OBJ_NEW_SMALL_INT((int16_t)read_bytes(s, 2));
case 0xd2:
return MP_OBJ_NEW_SMALL_INT((int32_t)read_bytes(s, 4));
case 0xd9:
case 0xda:
case 0xdb: {
// str 8, 16, 32
size_t size = read_size(s, code-0xd9);
vstr_t vstr;
vstr_init_len(&vstr, size);
byte *p = (byte*)vstr.buf;
read(s, p, size);
return mp_obj_new_str_from_vstr(&mp_type_str, &vstr);
}
case 0xde:
case 0xdf: {
// map 16 & 32
size_t len = read_size(s, code - 0xde + 1);
mp_obj_dict_t *d = MP_OBJ_TO_PTR(mp_obj_new_dict(len));
for (size_t i=0; i<len; i++) {
mp_obj_dict_store(d, _unpack(s), _unpack(s));
}
return MP_OBJ_FROM_PTR(d);
}
case 0xdc:
case 0xdd: {
// array 16 & 32
size_t len = read_size(s, code - 0xdc + 1);
mp_obj_tuple_t *t = MP_OBJ_TO_PTR(mp_obj_new_tuple(len, NULL));
for (size_t i=0; i<len; i++) {
t->items[i] = _unpack(s);
}
return MP_OBJ_FROM_PTR(t);
}
case 0xc1: // never used
case 0xc7: // ext 8
case 0xc8: // ext 16
case 0xc9: // ext 32
case 0xcb: // float 64
case 0xcc: // uint 8
case 0xcd: // uint 16
case 0xce: // uint 32
case 0xcf: // uint 64
case 0xd3: // int 64
case 0xd4: // fixenxt 1
case 0xd5: // fixenxt 2
case 0xd6: // fixenxt 4
case 0xd7: // fixenxt 8
case 0xd8: // fixenxt 16
default:
mp_raise_ValueError(translate("no unpacker found"));
}
}
// Read msgpack encoded object from stream
STATIC mp_obj_t mod_msgpack_unpack(mp_obj_t stream_obj) {
msgpack_stream_t s = get_stream(stream_obj, MP_STREAM_OP_READ);
return _unpack(&s);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_msgpack_unpack_obj, mod_msgpack_unpack);
STATIC const mp_rom_map_elem_t msgpack_module_globals_table[] = {
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_msgpack) },
{ MP_ROM_QSTR(MP_QSTR_pack), MP_ROM_PTR(&mod_msgpack_pack_obj) },
{ MP_ROM_QSTR(MP_QSTR_unpack), MP_ROM_PTR(&mod_msgpack_unpack_obj) },
};
STATIC MP_DEFINE_CONST_DICT(msgpack_module_globals, msgpack_module_globals_table);
const mp_obj_module_t msgpack_module = {
.base = { &mp_type_module },
.globals = (mp_obj_dict_t*)&msgpack_module_globals,
};

View File

@ -0,0 +1,34 @@
/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
*
* 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.
*/
#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_MSGPACK___INIT___H
#define MICROPY_INCLUDED_SHARED_BINDINGS_MSGPACK___INIT___H
#include "py/obj.h"
// Nothing now.
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_MSGPACK___INIT___H