1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
# 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).
<table>
<tr>
<th rowspan="1" colspan="2">Target</th>
<th colspan="3">Support</th>
</tr>
<tr>
<th rowspan="2">Architecture</th>
<th rowspan="2">OS</th>
<th>Available</th>
<th>Tested</th>
<th>Callstack</th>
</tr>
<tr>
<th colspan="3">Notes</th>
</tr>
<tr>
<td rowspan="6">x86_64</td>
<td rowspan="2">apple-ios</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
Target has been tested locally.
</td>
</tr>
<tr>
<td rowspan="2">windows</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes, but disabled</td>
</tr>
<tr>
<td colspan="3">
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][fibers].
</td>
</tr>
<tr>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td rowspan="8">i686<br>i586<br>i386</td>
<td rowspan="2">apple-ios</td>
<td>Yes</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">linux-android</td>
<td>Unknown</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
The assembly files are available, but the target hasn’t been verified to build
</td>
</tr>
<tr>
<td rowspan="2">windows</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
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][fibers].
</td>
</tr>
<tr>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="8">aarch64</td>
<td rowspan="2">apple-ios</td>
<td>Yes</td>
<td>Unknown</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
aarch64-apple-ios has not been tested. iOS hardware is necessary to run these tests.
</td>
</tr>
<tr>
<td rowspan="2">fuchsia<br>unknown-cloudabi</td>
<td>Unknown</td>
<td>Unknown</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">windows</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
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][fibers].
</td>
</tr>
<tr>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="6">arm<br>armv7</td>
<td rowspan="2">apple-ios</td>
<td>Yes</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
armv7-apple-ios has not been tested. iOS hardware is necessary to run these tests.
</td>
</tr>
<tr>
<td rowspan="2">windows</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
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][fibers].
</td>
</tr>
<tr>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">armv5te</td>
<td rowspan="2">*</td>
<td>Unknown</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">thumbv6<br>thumbv7</td>
<td rowspan="2">*</td>
<td>Unknown</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">mips<br>mipsel</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
Only the o32 ABI is supported and will be used for all 32-bit MIPS targets.
</td>
</tr>
<tr>
<td rowspan="2">mips64<br>mips64el</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">powerpc</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
Callstack generation may fail at certain well defined ranges of the program, although the usual
compiler-generated code fails at similar points itself.
</td>
</tr>
<tr>
<td rowspan="4">powerpc64</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
Callstack generation may fail at certain well defined ranges of the program, although the usual
compiler-generated code fails at similar points itself.
</td>
</tr>
<tr>
<td rowspan="2">AIX</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
<tr>
<td colspan="3">
</td>
</tr>
<tr>
<td rowspan="2">powerpc64le</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
Callstack generation may fail at certain well defined ranges of the program, although the usual
compiler-generated code fails at similar points itself.
</td>
</tr>
<tr>
<td rowspan="2">s390x</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Locally</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">sparc</td>
<td rowspan="2">linux</td>
<td>Unknown</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">sparc64</td>
<td rowspan="2">linux</td>
<td>Yes</td>
<td>Locally</td>
<td>Yes</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">sparc9</td>
<td rowspan="2">solaris</td>
<td>Yes</td>
<td>Unknown</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">wasm</td>
<td rowspan="2">*</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">asmjs</td>
<td rowspan="2">*</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
Feasibility/necessity hasn’t been acertained.
</td>
</tr>
<tr>
<td rowspan="2">nvptx</td>
<td rowspan="2">*</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
Feasibility/necessity hasn’t been acertained.
</td>
</tr>
<tr>
<td rowspan="2">msp430</td>
<td rowspan="2">*</td>
<td>No</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td colspan="3">
Haven’t gotten to it yet...
</td>
</tr>
<tr>
<td rowspan="2">riscv32</td>
<td rowspan="2">*</td>
<td>Yes</td>
<td>No</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
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.
</td>
</tr>
<tr>
<td rowspan="2">riscv64</td>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Locally</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
The assembly code for riscv64 has been tested locally with a C caller.
</td>
</tr>
<tr>
<td rowspan="2">loongarch64</td>
<td rowspan="2">*</td>
<td>Yes</td>
<td>Locally</td>
<td>Unknown</td>
</tr>
<tr>
<td colspan="3">
The assembly code for loongarch64 has been tested locally with a C caller.
</td>
</tr>
</table>
[GCC Farm Project]: https://cfarm.tetaneutral.net/
[fibers]: https://docs.microsoft.com/en-gb/windows/desktop/ProcThread/fibers
# License
PSM is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
https://opensource.org/licenses/MIT)
at your option.
|
