YESS/y86_obj_code.5 at master · sbennett1990/YESS · GitHub

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
.\"
.\" Copyright (c) 2020 Scott Bennett <scottb@fastmail.com>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd September 8, 2021
.Dt Y86_OBJ_CODE 5
.Os
.Sh NAME
.Nm y86_obj_code
.Nd Y86 object code reference
.Sh DESCRIPTION
.Sy y86 object code
is represented by ASCII text files ending in a
.Em \.yo
extension.
Each line in the program file is either a
.Sy comment record
or a
.Sy data record .
.Pp
A
.Sy comment record
is of the form:
.Bd -literal
                      | comment here

.Ed
where columns 0\(en21 contain space characters
.Pq Sq " "
and column 22 contains a pipe character
.Pq Sq | .
Any characters beyond column 22 are considered part of a comment and are
ignored.
It is considered good form to put a space after the
.Sq | .
.Pp
A
.Sy data record
is of the form:
.Bd -literal
  0x042: 0f000000     |

.Ed
where columns 0, 1, 8, and 21 (at least) contain space characters, columns 2\(en7
contain an address, columns 9 up to 20 contain zero to six bytes of data, and
column 22 contains a pipe character
.Pq Sq | .
Characters beyond column 22 are considered comment characters and are ignored.
The address in columns 2\(en7 is a hex address.
Both upper a lower case characters are accepted.
This address indicates the starting byte address of the first byte in memory
where the data (in columns 9 up to 20) is to be stored.
.Pp
.\" TODO: more details?
.Sh EXAMPLES
.\" Add a few comment and data record examples.
The beginning point of a program:
.Bd -literal
  0x000:              |    .pos 0

.Ed
.Pp
Declare the beginning of an array:
.Bd -literal
  0x014:              |    .align 4
  0x014: 0d000000     | array: .long 0xd

.Ed
.Pp
Here is a comment:
.Bd -literal
                      | # This program copies data from one array to another.

.Ed
.Pp
This is also a comment:
.Bd -literal
                      | Main:   irmovl $11, %eax

.Ed
.Sh SEE ALSO
.Xr yess 1