#stack #no_std

no-std psm

Portable Stack Manipulation: stack manipulation and introspection routines

12 releases

Uses old Rust 2015

new 0.1.11 Jul 30, 2020
0.1.10 Jun 25, 2020
0.1.8 May 6, 2020
0.1.7 Mar 22, 2020
0.1.2 Dec 29, 2018

#19 in Debugging

Download history 3698/week @ 2020-04-14 4999/week @ 2020-04-21 3494/week @ 2020-04-28 12058/week @ 2020-05-05 13259/week @ 2020-05-12 16204/week @ 2020-05-19 15820/week @ 2020-05-26 16515/week @ 2020-06-02 15062/week @ 2020-06-09 14549/week @ 2020-06-16 13217/week @ 2020-06-23 15603/week @ 2020-06-30 16042/week @ 2020-07-07 16700/week @ 2020-07-14 13109/week @ 2020-07-21 10853/week @ 2020-07-28

61,400 downloads per month
Used in 44 crates (via stacker)

MIT/Apache

69KB
1.5K SLoC

GNU Style Assembly 1K SLoC // 0.1% comments Rust 240 SLoC // 0.5% comments Assembly 140 SLoC // 0.2% comments

Portable Stack Manipulation

This crate provides very portable functions to control the stack pointer and inspect the properties of the stack. This crate does not attempt to provide safe abstractions to any operations, the only goals are correctness, portability and efficiency (in that exact order). As a consequence most functions you’ll see in this crate are unsafe.

Unless you’re writing a safe abstraction over stack manipulation, this is not the crate you want. Instead consider one of the safe abstractions over this crate. A good place to look at is the crates.io’s reverse dependency list.

Platform support

The following table lists supported targets and architectures with notes on the level of current support and knowledge about the target. The three columns “Available”, “Tested” and “Callstack” imply an increasingly high level of support.

  • “Available” basically means that the code builds and the assembly files have been written for the target;
  • “Tested” means that the assembly code has been tested or otherwise verified to be correct. For most targets it also means that continuous integration is set up;
  • “Callstack” means that the assembly code has been written with due care to support unwinding the stack and displaying the call frames (i.e. gdb backtrace works as expected).
Target Support
Architecture OS Available Tested Callstack
Notes
x86_64 apple-ios Yes Yes Yes

Target has been tested locally.

windows Yes Yes Yes, but disabled

Stacks allocated the usual way are not valid to be used on Windows and the functions to allocate a stack in a proper way is a Windows implementation detail. As a (unnecessarily slow and inflexible) alternative use Fibers.

* Yes Yes Yes
i686
i586
i386
apple-ios Yes Unknown Unknown
linux-android Unknown Unknown Unknown

The assembly files are available, but the target hasn’t been verified to build

windows No No No

The code technically works on my local machine, but exception handling does not correctly work on appveyor, which makes me unwilling to mark this as working yet.

Stacks allocated the usual way are not valid to be used on Windows and the functions to allocate a stack in a proper way is a Windows implementation detail. As a (unnecessarily slow and inflexible) alternative use Fibers.

* Yes Yes Yes
aarch64 apple-ios Yes Unknown Yes

aarch64-apple-ios has not been tested. iOS hardware is necessary to run these tests.

fuchsia
unknown-cloudabi
Unknown Unknown Yes
windows No No No

Stacks allocated the usual way are not valid to be used on Windows and the functions to allocate a stack in a proper way is a Windows implementation detail. As a (unnecessarily slow and inflexible) alternative use Fibers.

* Yes Yes Yes
arm
armv7
apple-ios Yes Unknown Unknown

armv7-apple-ios has not been tested. iOS hardware is necessary to run these tests.

windows No No No

Stacks allocated the usual way are not valid to be used on Windows and the functions to allocate a stack in a proper way is a Windows implementation detail. As a (unnecessarily slow and inflexible) alternative use Fibers.

* Yes Yes Yes
armv5te * Unknown Unknown Unknown
thumbv6
thumbv7
* Unknown Unknown Unknown
mips
mipsel
linux Yes Yes Yes

Only the o32 ABI is supported and will be used for all 32-bit MIPS targets.

mips64
mips64el
linux Yes Yes Yes
powerpc linux Yes Yes Yes

Callstack generation may fail at certain well defined ranges of the program, although the usual compiler-generated code fails at similar points itself.

powerpc64 linux Yes Yes Yes

Callstack generation may fail at certain well defined ranges of the program, although the usual compiler-generated code fails at similar points itself.

powerpc64le linux Yes Yes Yes

Callstack generation may fail at certain well defined ranges of the program, although the usual compiler-generated code fails at similar points itself.

s390x linux Yes Locally Yes

Test runner on CI hangs, local verification has been done on a qemu-system-s390x VM. It may be possible to add CI testing in the future via qemu’s full-system emulation.

sparc linux Unknown Unknown Unknown

A Rust target for 32-bit SPARC exists, but no Linux distributions actually have a 32-bit SPARC distribution, so verification is infeasible.

The actual assembly code has been written conservatively, modelled after the 64-bit SPARC code. and so has a non-zero chance of working.

sparc64 linux Yes Locally Yes

Has been manually verified to work on the GCC Farm Project machines. It may be possible to add CI testing in the future via qemu’s full-system emulation.

sparc9 solaris Yes Unknown Unknown

Uses the same assembly as the sparc64-linux-gnu target. This target has no rustc builds and therefore the correct operation of this target could not be verified at the moment.

wasm * No No No

This library is not applicable to the target. WASM hasn’t a specified C ABI, the callstack is not even in an address space and does not appear to be manipulatable.

asmjs * No No No

Feasibility/necessity hasn’t been acertained.

nvptx * No No No

Feasibility/necessity hasn’t been acertained.

msp430 * No No No

Haven’t gotten to it yet...

riscv32 * Yes No Unknown

Although the assembly code has not been tested, it is a straightforward copy of the 64-bit version. Unless there is a non-obvious mistake, this should work fine.

riscv64 * Yes Locally Unknown

The assembly code for riscv64 has been tested locally with a C caller.

License

PSM is licensed under either of

at your option.

No runtime deps

~130KB