VirtualBox

source: vbox/trunk/include/iprt/formats/omf.h@ 93941

Last change on this file since 93941 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/* $Id: omf.h 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * IPRT - Relocatable Object Module Format (OMF).
4 *
5 * @remarks For a more details description, see specification from Tools
6 * Interface Standards (TIS), version 1.1 dated May 2015.
7 * Typically named found as OMF_v1.1.pdf.
8 */
9
10/*
11 * Copyright (C) 2006-2022 Oracle Corporation
12 *
13 * This file is part of VirtualBox Open Source Edition (OSE), as
14 * available from http://www.virtualbox.org. This file is free software;
15 * you can redistribute it and/or modify it under the terms of the GNU
16 * General Public License (GPL) as published by the Free Software
17 * Foundation, in version 2 as it comes in the "COPYING" file of the
18 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
19 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
20 *
21 * The contents of this file may alternatively be used under the terms
22 * of the Common Development and Distribution License Version 1.0
23 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
24 * VirtualBox OSE distribution, in which case the provisions of the
25 * CDDL are applicable instead of those of the GPL.
26 *
27 * You may elect to license modified versions of this file under the
28 * terms and conditions of either the GPL or the CDDL or both.
29 */
30
31#ifndef IPRT_INCLUDED_formats_omf_h
32#define IPRT_INCLUDED_formats_omf_h
33#ifndef RT_WITHOUT_PRAGMA_ONCE
34# pragma once
35#endif
36
37#include <iprt/stdint.h>
38#include <iprt/assertcompile.h>
39
40
41/** @defgroup grp_rt_formats_omf Relocatable Object Module Format (OMF) structures and definitions
42 * @ingroup grp_rt_formats
43 * @{
44 */
45
46/**
47 * OMF record header.
48 */
49#pragma pack(1)
50typedef struct OMFRECHDR
51{
52 /** The record type. */
53 uint8_t bType;
54 /** The record length, excluding the this header. */
55 uint16_t cbLen;
56} OMFRECHDR;
57#pragma pack()
58AssertCompileSize(OMFRECHDR, 3);
59/** Pointer to an OMF header. */
60typedef OMFRECHDR *POMFRECHDR;
61/** Pointer to a const OMF header. */
62typedef OMFRECHDR *PCOMFRECHDR;
63
64/** The max OMF record length, including the header. */
65#define OMF_MAX_RECORD_LENGTH UINT16_C(1024)
66
67/** The max OMF record payload, including CRC byte. */
68#define OMF_MAX_RECORD_PAYLOAD UINT16_C(1021)
69
70
71/** @name OMF Record Types (OMFRECHDR::bType).
72 * @{ */
73/** Record type flag indicating 32-bit record. */
74#define OMF_REC32 UINT8_C(0x01)
75/** Object file header record.
76 * Is followed by a length prefixed string */
77#define OMF_THEADR UINT8_C(0x80)
78/** Comment record.
79 * Is followed by a comment type byte and a commen class byte, thereafter comes
80 * type specific byte sequence. */
81#define OMF_COMENT UINT8_C(0x88)
82/** Local name table referenced by segment and group defintions.
83 * Array of length prefixed strings. Multi record. */
84#define OMF_LNAMES UINT8_C(0x96)
85/** 16-bit segment definition.
86 * Complicated, see TIS docs. */
87#define OMF_SEGDEF16 UINT8_C(0x98)
88/** 32-bit segment definition.
89 * Complicated, see TIS docs. */
90#define OMF_SEGDEF32 UINT8_C(0x99)
91/** Segment group definition.
92 * Starts with an LNAMES index (one or two bytes) of the group name. Followed
93 * by an array which entries consists of a 0xff byte and a segment
94 * defintion index (one or two bytes). */
95#define OMF_GRPDEF UINT8_C(0x9a)
96/** External symbol defintions.
97 * Array where each entry is a length prefixed symbol name string followed by a
98 * one or two byte type number. */
99#define OMF_EXTDEF UINT8_C(0x8c)
100/** 16-but public symbol definitions.
101 * Starts with a group index (one or two bytes) and a segment index (ditto)
102 * which indicates which group/segment the symbols belong to.
103 * Is followed by an array with entries consiting of a length prefixed symbol
104 * name string, a two byte segment offset, and a one or two byte type index. */
105#define OMF_PUBDEF16 UINT8_C(0x90)
106/** 32-but public symbol definitions.
107 * Identical to #OMF_PUBDEF16 except that the symbol offset field is four
108 * byte. */
109#define OMF_PUBDEF32 UINT8_C(0x91)
110/** 16-bit local symbol definitions.
111 * Same format as #OMF_PUBDEF16. */
112#define OMF_LPUBDEF16 UINT8_C(0xb6)
113/** 16-bit local symbol definitions.
114 * Same format as #OMF_PUBDEF32. */
115#define OMF_LPUBDEF32 UINT8_C(0xb7)
116/** Logical enumerated data record (a chunk of raw segment bits).
117 * Starts with the index of the segment it contributes to (one or two bytes) and
118 * is followed by the offset into the segment of the bytes (two bytes).
119 * After that comes the raw data bytes. */
120#define OMF_LEDATA16 UINT8_C(0xa0)
121/** Logical enumerated data record (a chunk of raw segment bits).
122 * Identical to #OMF_LEDATA16 except that is has a the segment offset field is
123 * four bytes. */
124#define OMF_LEDATA32 UINT8_C(0xa1)
125/** 16-bit fixup record.
126 * Complicated, see TIS docs. */
127#define OMF_FIXUPP16 UINT8_C(0x9c)
128/** 32-bit fixup record.
129 * Complicated, see TIS docs. */
130#define OMF_FIXUPP32 UINT8_C(0x9d)
131/** 16-bit line numbers record. */
132#define OMF_LINNUM16 UINT8_C(0x94)
133/** 32-bit line numbers record. */
134#define OMF_LINNUM32 UINT8_C(0x95)
135/** 16-bit object file end record.
136 * Duh! wrong bitfield order.
137 *
138 * Starts with a byte bitfield indicating module type: bit 0 is set if this is a
139 * main program module; bit 1 is set if this is a start address is available;
140 * bits 2 thru 6 are reserved and must be zero; bit 7 is set to indicate
141 * a non-absolute start address.
142 *
143 * When bit 1 is set what follow is: A FIXUPP byte, one or two byte frame datum,
144 * one or two byte target datum, and a 2 byte target displacement. */
145#define OMF_MODEND16 UINT8_C(0x8a)
146/** 32-bit object file end record.
147 * Identical to #OMF_MODEND16 except that is has a 4 byte target
148 * displacement field. */
149#define OMF_MODEND32 UINT8_C(0x8b)
150/** @} */
151
152/** @name OMF COMENT Type Flags
153 * @{ */
154/** Comment type: Don't remove comment when object is manipulated. */
155#define OMF_CTYP_NO_PURGE UINT8_C(0x80)
156/** Comment type: Don't include in object listing. */
157#define OMF_CTYP_NO_LIST UINT8_C(0x40)
158/** @} */
159
160/** @name OMF COMENT Classes
161 * @{ */
162/** Comment class: Dependency file.
163 * Is followed by a dword timestamp (1980 based?) and a length prefix
164 * filename string. */
165#define OMF_CCLS_DEP_FILE UINT8_C(0x88)
166/** Comment class: Link pass separator.
167 * Contains a byte with the value 01 to indicate the linker can stop pass 1
168 * processing now. */
169#define OMF_CCLS_LINK_PASS_SEP UINT8_C(0xa2)
170/** Comment class: Borland type information. */
171#define OMF_CCLS_BORLAND_TYPES UINT8_C(0xe3)
172/** Comment class: Borland symbol information. */
173#define OMF_CCLS_BORLAND_SYMBOLS UINT8_C(0xe6)
174/** Comment class: Borland source file (applies to subsequent LINNUMs). */
175#define OMF_CCLS_BORLAND_SRC_FILE UINT8_C(0xe8)
176/** Comment class: Borland dependency files. */
177#define OMF_CCLS_BORLAND_DEP_FILES UINT8_C(0xe9)
178/** @} */
179
180/** @name OMF SEGDEF Attrib.
181 * @{ */
182#define OMF_SEG_ATTR_ALIGN_ABS (UINT8_C(0) << 5) /**< SEGDEF attrib A: absolute - frame and offset fields present. */
183#define OMF_SEG_ATTR_ALIGN_BYTE (UINT8_C(1) << 5) /**< SEGDEF attrib A: 1-byte alignment. */
184#define OMF_SEG_ATTR_ALIGN_WORD (UINT8_C(2) << 5) /**< SEGDEF attrib A: 2-byte alignment. */
185#define OMF_SEG_ATTR_ALIGN_PARA (UINT8_C(3) << 5) /**< SEGDEF attrib A: 16-byte alignment. */
186#define OMF_SEG_ATTR_ALIGN_PAGE (UINT8_C(4) << 5) /**< SEGDEF attrib A: 4096-byte alignment (or 256-byte). */
187#define OMF_SEG_ATTR_ALIGN_DWORD (UINT8_C(5) << 5) /**< SEGDEF attrib A: 4-byte alignment. */
188#define OMF_SEG_ATTR_ALIGN_6 (UINT8_C(6) << 5) /**< SEGDEF attrib A: not supported (load-time locatable, paragraph aligned). */
189#define OMF_SEG_ATTR_ALIGN_7 (UINT8_C(7) << 5) /**< SEGDEF attrib A: undefined. */
190#define OMF_SEG_ATTR_ALIGN_MASK (UINT8_C(7) << 5) /**< SEGDEF attrib A: Mask for the alignment field. */
191#define OMF_SEG_ATTR_ALIGN_SHIFT 5 /**< SEGDEF attrib A: Shift count for the alignment field. */
192
193#define OMF_SEG_ATTR_COMB_PRIVATE (UINT8_C(0) << 2) /**< SEGDEF attrib C: Private - do not combine with anyone. */
194#define OMF_SEG_ATTR_COMB_1 (UINT8_C(1) << 2) /**< SEGDEF attrib C: Reserved */
195#define OMF_SEG_ATTR_COMB_PUBLIC (UINT8_C(2) << 2) /**< SEGDEF attrib C: Public - append at offset meeting alignment. */
196#define OMF_SEG_ATTR_COMB_3 (UINT8_C(3) << 2) /**< SEGDEF attrib C: Reserved */
197#define OMF_SEG_ATTR_COMB_PUBLIC_4 (UINT8_C(4) << 2) /**< SEGDEF attrib C: Public - append at offset meeting alignment. */
198#define OMF_SEG_ATTR_COMB_STACK (UINT8_C(5) << 2) /**< SEGDEF attrib C: Stack - same as public, but forced byte alignment. */
199#define OMF_SEG_ATTR_COMB_COMMON (UINT8_C(6) << 2) /**< SEGDEF attrib C: Common - overlay using maximum size. */
200#define OMF_SEG_ATTR_COMB_PUBLIC_7 (UINT8_C(5) << 2) /**< SEGDEF attrib C: Public - append at offset meeting alignment. */
201#define OMF_SEG_ATTR_COMB_MASK (UINT8_C(7) << 2) /**< SEGDEF attrib C: Mask for the combination field. */
202#define OMF_SEG_ATTR_COMB_SHIFT 2 /**< SEGDEF attrib C: Shift count for the combination field. */
203#define OMF_SEG_ATTR_BIG UINT8_C(2) /**< SEGDEF attrib B: Big segment 64K / 4GB. */
204#define OMF_SEG_ATTR_USE32 UINT8_C(1) /**< SEGDEF attrib P: Indicates 32-bit data or code. */
205#define OMF_SEG_ATTR_USE16 UINT8_C(0) /**< SEGDEF attrib ~P: Just for spelling out !USE32. */
206/** @} */
207
208
209/** @name OMF FIXUPP Locations.
210 * @{ */
211#define OMF_FIX_LOC_8BIT_LOW_BYTE UINT8_C(0) /**< FIXUP location: low byte (offset or displacement). */
212#define OMF_FIX_LOC_16BIT_OFFSET UINT8_C(1) /**< FIXUP location: 16-bit offset. */
213#define OMF_FIX_LOC_16BIT_SEGMENT UINT8_C(2) /**< FIXUP location: 16-bit segment. */
214#define OMF_FIX_LOC_1616FAR UINT8_C(3) /**< FIXUP location: 16:16 far pointer. */
215#define OMF_FIX_LOC_8BIT_HIGH_BYTE UINT8_C(4) /**< FIXUP location: high byte (offset). Not supported by MS/IBM. */
216#define OMF_FIX_LOC_16BIT_OFFSET_LDR UINT8_C(5) /**< FIXUP location: 16-bit loader resolved offset, same a 1 for linker. PharLab conflict. */
217#define OMF_FIX_LOC_RESERVED_FAR1632 UINT8_C(6) /**< FIXUP location: PharLab 16:32 far pointers, not defined by MS/IBM. */
218#define OMF_FIX_LOC_RESERVED_7 UINT8_C(7) /**< FIXUP location: Not defined. */
219#define OMF_FIX_LOC_RESERVED_8 UINT8_C(8) /**< FIXUP location: Not defined. */
220#define OMF_FIX_LOC_32BIT_OFFSET UINT8_C(9) /**< FIXUP location: 32-bit offset. */
221#define OMF_FIX_LOC_RESERVED_10 UINT8_C(10) /**< FIXUP location: Not defined. */
222#define OMF_FIX_LOC_1632FAR UINT8_C(11) /**< FIXUP location: 16:32 far pointer. */
223#define OMF_FIX_LOC_RESERVED_12 UINT8_C(12) /**< FIXUP location: Not defined. */
224#define OMF_FIX_LOC_32BIT_OFFSET_LDR UINT8_C(13) /**< FIXUP location: 32-bit loader resolved offset, same as 9 for linker. */
225/** @} */
226/** @name OMF FIXUPP Targets
227 * @{ */
228#define OMF_FIX_T_SEGDEF UINT8_C(0) /**< FIXUP target: SEGDEF index. */
229#define OMF_FIX_T_GRPDEF UINT8_C(1) /**< FIXUP target: GRPDEF index. */
230#define OMF_FIX_T_EXTDEF UINT8_C(2) /**< FIXUP target: EXTDEF index. */
231#define OMF_FIX_T_FRAME_NO UINT8_C(3) /**< FIXUP target: Explicit frame number, not supported by MS/IBM. */
232#define OMF_FIX_T_SEGDEF_NO_DISP UINT8_C(4) /**< FIXUP target: SEGDEF index only, displacement take as 0. */
233#define OMF_FIX_T_GRPDEF_NO_DISP UINT8_C(5) /**< FIXUP target: GRPDEF index only, displacement take as 0. */
234#define OMF_FIX_T_EXTDEF_NO_DISP UINT8_C(6) /**< FIXUP target: EXTDEF index only, displacement take as 0. */
235/** @} */
236/** @name OMF FIXUPP Frames
237 * @{ */
238#define OMF_FIX_F_SEGDEF UINT8_C(0) /**< FIXUP frame: SEGDEF index. */
239#define OMF_FIX_F_GRPDEF UINT8_C(1) /**< FIXUP frame: GRPDEF index. */
240#define OMF_FIX_F_EXTDEF UINT8_C(2) /**< FIXUP frame: EXTDEF index. */
241#define OMF_FIX_F_FRAME_NO UINT8_C(3) /**< FIXUP frame: Explicit frame number, not supported by any linkers. */
242#define OMF_FIX_F_LXDATA_SEG UINT8_C(4) /**< FIXUP frame: Determined from the data being fixed up. (No index field.) */
243#define OMF_FIX_F_TARGET_SEG UINT8_C(5) /**< FIXUP frame: Determined from the target. (No index field.) */
244#define OMF_FIX_F_RESERVED_6 UINT8_C(6) /**< FIXUP frame: Reserved. */
245/** @} */
246
247
248/** @} */
249#endif /* !IPRT_INCLUDED_formats_omf_h */
250
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette