forked from emscripten-core/emscripten
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use third_party leb128 implementation. NFC (emscripten-core#13833)
Our implementation lacks support for signed LEBs and rather than add it locally just include third_party MIT-licenced implementation.
- Loading branch information
Showing
4 changed files
with
174 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Mohanson | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# LEB128 | ||
|
||
LEB128 or Little Endian Base 128 is a form of variable-length code compression used to store an arbitrarily large integer in a small number of bytes. LEB128 is used in the DWARF debug file format and the WebAssembly binary encoding for all integer literals. | ||
|
||
```sh | ||
$ pip3 install leb128 | ||
``` | ||
|
||
`leb128` is used in [pywasm](https://github.com/mohanson/pywasm), which the WebAssembly virtual machine. | ||
|
||
# Example | ||
|
||
```py | ||
import io | ||
import leb128 | ||
|
||
# unsigned leb128 | ||
assert leb128.u.encode(624485) == bytearray([0xe5, 0x8e, 0x26]) | ||
assert leb128.u.decode(bytearray([0xe5, 0x8e, 0x26])) == 624485 | ||
assert leb128.u.decode_reader(io.BytesIO(bytearray([0xe5, 0x8e, 0x26]))) == (624485, 3) | ||
|
||
# signed leb128 | ||
assert leb128.i.encode(-123456) == bytearray([0xc0, 0xbb, 0x78]) | ||
assert leb128.i.decode(bytearray([0xc0, 0xbb, 0x78])) == -123456 | ||
assert leb128.i.decode_reader(io.BytesIO(bytearray([0xc0, 0xbb, 0x78]))) == (-123456, 3) | ||
``` | ||
|
||
# Performance | ||
|
||
Since I used the most optimized algorithm, it is likely to be the fastest among all pure Python implementations of leb128. The detailed results can refer to the table, which is the result of using a very low-performance CPU. | ||
|
||
| Case | Duration | | ||
| ---------------------- | -------- | | ||
| U encode 1000000 times | 0.865 s | | ||
| U decode 1000000 times | 0.808 s | | ||
| I encode 1000000 times | 0.762 s | | ||
| I decode 1000000 times | 0.835 s | | ||
|
||
# License | ||
|
||
MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
""" | ||
https://en.wikipedia.org/wiki/LEB128 | ||
LEB128 or Little Endian Base 128 is a form of variable-length code | ||
compression used to store an arbitrarily large integer in a small number of | ||
bytes. LEB128 is used in the DWARF debug file format and the WebAssembly | ||
binary encoding for all integer literals. | ||
""" | ||
|
||
import typing | ||
|
||
|
||
class _U: | ||
@staticmethod | ||
def encode(i: int) -> bytearray: | ||
"""Encode the int i using unsigned leb128 and return the encoded bytearray.""" | ||
assert i >= 0 | ||
r = [] | ||
while True: | ||
byte = i & 0x7f | ||
i = i >> 7 | ||
if i == 0: | ||
r.append(byte) | ||
return bytearray(r) | ||
r.append(0x80 | byte) | ||
|
||
@staticmethod | ||
def decode(b: bytearray) -> int: | ||
"""Decode the unsigned leb128 encoded bytearray""" | ||
r = 0 | ||
for i, e in enumerate(b): | ||
r = r + ((e & 0x7f) << (i * 7)) | ||
return r | ||
|
||
@staticmethod | ||
def decode_reader(r: typing.BinaryIO) -> (int, int): | ||
""" | ||
Decode the unsigned leb128 encoded from a reader, it will return two values, the actual number and the number | ||
of bytes read. | ||
""" | ||
a = bytearray() | ||
while True: | ||
b = ord(r.read(1)) | ||
a.append(b) | ||
if (b & 0x80) == 0: | ||
break | ||
return _U.decode(a), len(a) | ||
|
||
|
||
class _I: | ||
@staticmethod | ||
def encode(i: int) -> bytearray: | ||
"""Encode the int i using signed leb128 and return the encoded bytearray.""" | ||
r = [] | ||
while True: | ||
byte = i & 0x7f | ||
i = i >> 7 | ||
if (i == 0 and byte & 0x40 == 0) or (i == -1 and byte & 0x40 != 0): | ||
r.append(byte) | ||
return bytearray(r) | ||
r.append(0x80 | byte) | ||
|
||
@staticmethod | ||
def decode(b: bytearray) -> int: | ||
"""Decode the signed leb128 encoded bytearray""" | ||
r = 0 | ||
for i, e in enumerate(b): | ||
r = r + ((e & 0x7f) << (i * 7)) | ||
if e & 0x40 != 0: | ||
r |= - (1 << (i * 7) + 7) | ||
return r | ||
|
||
@staticmethod | ||
def decode_reader(r: typing.BinaryIO) -> (int, int): | ||
""" | ||
Decode the signed leb128 encoded from a reader, it will return two values, the actual number and the number | ||
of bytes read. | ||
""" | ||
a = bytearray() | ||
while True: | ||
b = ord(r.read(1)) | ||
a.append(b) | ||
if (b & 0x80) == 0: | ||
break | ||
return _I.decode(a), len(a) | ||
|
||
|
||
u = _U() | ||
i = _I() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters