10000 py/persistentcode.h: Split the native and bytecode ABI version. by jimmo · Pull Request #9303 · micropython/micropython · GitHub
[go: up one dir, main page]
Skip to content

py/persistentcode.h: Split the native and bytecode ABI version. #9303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

py/persistentcode.h: Split the native and bytecode ABI version. #9303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mpy-cross/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ MP_NOINLINE int main_(int argc, char **argv) {
a += 1;
} else if (strcmp(argv[a], "--version") == 0) {
printf("MicroPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE
"; mpy-cross emitting mpy v" MP_STRINGIFY(MPY_VERSION) "\n");
"; mpy-cross emitting mpy v" MP_STRINGIFY(MPY_VERSION_BYTECODE) "-v" MP_STRINGIFY(MPY_VERSION_NATIVE) "\n");
return 0;
} else if (strcmp(argv[a], "-v") == 0) {
mp_verbose_flag++;
Expand Down
10 changes: 6 additions & 4 deletions py/persistentcode.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,14 +393,15 @@ STATIC mp_raw_code_t *load_raw_code(mp_reader_t *reader, mp_module_context_t *co
mp_compiled_module_t mp_raw_code_load(mp_reader_t *reader, mp_module_context_t *context) {
byte header[4];
read_bytes(reader, header, sizeof(header));
byte arch = MPY_FEATURE_DECODE_ARCH(header[2]);
if (header[0] != 'M'
|| header[1] != MPY_VERSION
|| (arch == MP_NATIVE_ARCH_NONE && (header[1] < MPY_VERSION_BYTECODE || header[1] > MPY_VERSION_NATIVE))
|| (arch != MP_NATIVE_ARCH_NONE && header[1] != MPY_VERSION_NATIVE)
|| MPY_FEATURE_DECODE_FLAGS(header[2]) != MPY_FEATURE_FLAGS
|| header[3] > MP_SMALL_INT_BITS) {
mp_raise_ValueError(MP_ERROR_TEXT("incompatible .mpy file"));
}
if (MPY_FEATURE_DECODE_ARCH(header[2]) != MP_NATIVE_ARCH_NONE) {
byte arch = MPY_FEATURE_DECODE_ARCH(header[2]);
if (arch != MP_NATIVE_ARCH_NONE) {
if (!MPY_FEATURE_ARCH_TEST(arch)) {
if (MPY_FEATURE_ARCH_TEST(MP_NATIVE_ARCH_NONE)) {
// On supported ports this can be resolved by enabling feature, eg
Expand Down Expand Up @@ -595,7 +596,7 @@ void mp_raw_code_save(mp_compiled_module_t *cm, mp_print_t *print) {
// byte number of bits in a small int
byte header[4] = {
'M',
MPY_VERSION,
MPY_VERSION_BYTECODE,
MPY_FEATURE_ENCODE_FLAGS(MPY_FEATURE_FLAGS_DYNAMIC),
#if MICROPY_DYNAMIC_COMPILER
mp_dynamic_compiler.small_int_bits,
Expand All @@ -604,6 +605,7 @@ void mp_raw_code_save(mp_compiled_module_t *cm, mp_print_t *print) {
#endif
};
if (cm->has_native) {
header[1] = MPY_VERSION_NATIVE;
header[2] |= MPY_FEATURE_ENCODE_ARCH(MPY_FEATURE_ARCH_DYNAMIC);
}
mp_print_bytes(print, header, sizeof(header));
Expand Down
14 changes: 11 additions & 3 deletions py/persistentcode.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,16 @@
#include "py/reader.h"
#include "py/emitglue.h"

// The current version of .mpy files
#define MPY_VERSION 6
// The current version of .mpy files. For a bytecode only .mpy file (i.e. arch
// set to 0), we will load any file with a version between MPY_VERSION_BYTECODE
// and MPY_VERSION_NATIVE. When an arch is set (i.e. it used emit=native, or the
// native dectorator, or was a dynamic native module), then it must exactly
// match MPY_VERSION_NATIVE.
// This lets us advance the native ABI (e.g. dynruntime.h) without needing
// to break compatibility for bytecode-only .mpy files.
// Must be kept in sync with tools/mpy-tool.py and tools/mpy_ld.py.
#define MPY_VERSION_BYTECODE 6
#define MPY_VERSION_NATIVE 6

// Macros to encode/decode flags to/from the feature byte
#define MPY_FEATURE_ENCODE_FLAGS(flags) (flags)
Expand Down Expand Up @@ -81,7 +89,7 @@
#endif

// 16-bit little-endian integer with the second and third bytes of supported .mpy files
#define MPY_FILE_HEADER_INT (MPY_VERSION \
#define MPY_FILE_HEADER_INT (MPY_VERSION_NATIVE \
| (MPY_FEATURE_ENCODE_FLAGS(MPY_FEATURE_FLAGS) | MPY_FEATURE_ENCODE_ARCH(MPY_FEATURE_ARCH)) << 8)

enum {
Expand Down
18 changes: 13 additions & 5 deletions tools/mpy-tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,10 @@ def __str__(self):


class Config:
MPY_VERSION = 6
# Must be kept in sync with py/persistentcode.h.
# See comments there for bytecode vs native version.
MPY_VERSION_BYTECODE = 6
MPY_VERSION_NATIVE = 6
MICROPY_LONGINT_IMPL_NONE = 0
MICROPY_LONGINT_IMPL_LONGLONG = 1
MICROPY_LONGINT_IMPL_MPZ = 2
Expand Down Expand Up @@ -1330,11 +1333,14 @@ def read_mpy(filename):
header = reader.read_bytes(4)
if header[0] != ord("M"):
raise MPYReadError(filename, "not a valid .mpy file")
if header[1] != config.MPY_VERSION:
raise MPYReadError(filename, "incompatible .mpy version")
feature_byte = header[2]
mpy_native_arch = feature_byte >> 2
if mpy_native_arch != MP_NATIVE_ARCH_NONE:
if mpy_native_arch == MP_NATIVE_ARCH_NONE:
if header[1] < config.MPY_VERSION_BYTECODE or header[1] > config.MPY_VERSION_NATIVE:
raise MPYReadError(filename, "incompatible bytecode .mpy version")
else:
if header[1] != config.MPY_VERSION_NATIVE:
raise MPYReadError(filename, "incompatible native .mpy version")
if config.native_arch == MP_NATIVE_ARCH_NONE:
config.native_arch = mpy_native_arch
elif config.native_arch != mpy_native_arch:
Expand Down Expand Up @@ -1669,7 +1675,9 @@ def merge_mpy(compiled_modules, output_file):

header = bytearray(4)
header[0] = ord("M")
header[1] = config.MPY_VERSION
header[1] = (
config.MPY_VERSION_NATIVE if config.native_arch else config.MPY_VERSION_BYTECODE
)
header[2] = config.native_arch << 2
header[3] = config.mp_small_int_bits
merged_mpy.extend(header)
Expand Down
10 changes: 8 additions & 2 deletions tools/mpy_ld.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,12 @@
sys.path.append(os.path.dirname(__file__) + "/../py")
import makeqstrdata as qstrutil

# Must be kept in sync with py/persistentcode.h.
# See comments there for bytecode vs native version.
MPY_VERSION_BYTECODE = 6
MPY_VERSION_NATIVE = 6

# MicroPython constants
MPY_VERSION = 6
MP_CODE_BYTECODE = 2
MP_CODE_NATIVE_VIPER = 4
MP_NATIVE_ARCH_X86 = 1
Expand Down Expand Up @@ -917,7 +921,9 @@ def build_mpy(env, entry_offset, fmpy, native_qstr_vals, native_qstr_objs):
out.open(fmpy)

# MPY: header
out.write_bytes(bytearray([ord("M"), MPY_VERSION, env.arch.mpy_feature, MP_SMALL_INT_BITS]))
out.write_bytes(
bytearray([ord("M"), MPY_VERSION_NATIVE, env.arch.mpy_feature, MP_SMALL_INT_BITS])
)

# MPY: n_qstr
out.write_uint(1 + len(native_qstr_vals))
Expand Down
0