forked from 0x10cAtlas/AtlasOS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ABI.txt
102 lines (88 loc) · 4.98 KB
/
ABI.txt
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
__ _______ _ __ ______ __ _____ _
/ \ |___ ___| | | / \ | ____| / \ | __ \ | |
/ /\ \ | | | | / /\ \ | |____ ____ / /\ \ | |__| | | |
/ /__\ \ | | | | / /__\ \ |____ | |____| / /__\ \ | __ < | |
/ ______ \ | | | |___ / ______ \ ____| | / ______ \ | |__| | | |
/_/ \_\ |_| |_____| /_/ \_\ |______| /_/ \_\ |_____/ |_|
ABI documentation for AtlasOS
!!! [DRAFT] !!!
Introduction
============
This document describes the Application Binary Interface of AtlasOS.
File header
-----------
+-----------+-------------------------------------------------+
| Words | Description |
+-----------+-------------------------------------------------+
| 1 | Magic number for AtlasOS to recognise this is |
| | not a flat binary. (0x4714) |
| | |
| 1 | Version of the header/ABI. (0x0001) |
| | |
| 1 | Length of the header. |
| | |
| 1 | Length of the code and data. |
| | |
| 1 | Flags of the programm which are: |
| | H L |
| | 1111111111111111 |
| | \____ ____/||||+- Has Assembler Relocation Table|
| | V |||+-- Realtime application * |
| | | ||+--- Daemon ** |
| | unused |+---- Driver |
| | +----- Library |
| | |
| | |
| 0 to n | Assembler Relocation Table |
| | |
| 0 to n | Library Function Table |
| | |
\___________\__________________ ______________________________/
V
Code and data
* When AtlasOS starts a realtime application all other application are swaped out the memory.
The application is not suspended (proc_suspend only runs driver). As soon as it calls 'proc_kill_me'
the appication is terminated and all other applications are restored. This may be useful for loading
control systems or other time critical apps.
** Deamons are called without forcing the shell to pause until it finished. This may be useful
for non-time-critical tasks. Daemons are supposed to stay silent (write nothing on the
screen) though they CAN write on the screen.
The code
--------
The code must be pure DCPU-16 code.
The Assembler Relocation Table
------------------------------
This data ensures the pointer in the code point to the right
position by listing all the pointers the OS must modify.
Header:
+-----------+-------------------------------------------------+
| Words | Description |
+-----------+-------------------------------------------------+
| 1 | Number of entries |
. . .
Entry:
. . .
| 1 | Address of the pointer |
. . .
. . .
+-----------+-------------------------------------------------+
The Library Function Table
--------------------------
The LFT provides the public methods and their addresses so applications
can make use of them without knowing their positions in memory. The function
references are automaticaly relocated (without ART).
Header:
+-----------+-------------------------------------------------+
| Words | Description |
+-----------+-------------------------------------------------+
| 1 | Size of the table (in words) |
| | |
| 1 | Number of entries |
. . .
Entry:
. . .
| 1 | Address of the function |
| | |
| 2 to n | 0-terminated string with function name. At least|
| | one character. |
+-----------+-------------------------------------------------+