summaryrefslogtreecommitdiffstats
path: root/misc/pascal/libpoff/pfprivate.h
blob: 76fdc867ea195918b3f82342ec759a3bbe2fc774 (plain)
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
/***************************************************************************
 * pfprivate.h
 * Contains command, internal, private definitions used by
 * the POFF library.  These were not intended for exportation.
 *
 *   Copyright (C) 2008-2009 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ***************************************************************************/

#ifndef __PFPRIVATE_H
#define __PFPRIVATE_H

/***************************************************************************
 * Included Files
 ***************************************************************************/

#include <stdint.h>
#include "keywords.h"
#include "poff.h"
#include "paslib.h"    /* Endian-ness support */

/***************************************************************************
 * Pre-processor Definitions
 ***************************************************************************/

#define INITIAL_STRING_TABLE_SIZE     4096
#define STRING_TABLE_INCREMENT        1024

#define INITIAL_SYMBOL_TABLE_SIZE     256*sizeof(poffSymbol_t)
#define SYMBOL_TABLE_INCREMENT        64*sizeof(poffSymbol_t)

#define INITIAL_FILENAME_TABLE_SIZE   64*sizeof(poffFileTab_t)
#define FILENAME_TABLE_INCREMENT      64*sizeof(poffFileTab_t)

#define INITIAL_RELOC_TABLE_SIZE      128*sizeof(poffRelocation_t)
#define RELOC_TABLE_INCREMENT         64*sizeof(poffRelocation_t)

#define INITIAL_LINENUMBER_TABLE_SIZE 2048*sizeof(poffLineNumber_t)
#define LINENUMBER_TABLE_INCREMENT    512*sizeof(poffLineNumber_t)

#define INITIAL_DEBUGFUNC_TABLE_SIZE  128*sizeof(poffDebugFuncInfo_t)
#define DEBUGFUNC_TABLE_INCREMENT     64*sizeof(poffDebugFuncInfo_t)

#define INITIAL_PROG_SECTION_SIZE     8096
#define PROG_SECTION_INCREMENT        2048

#define INITIAL_RODATA_SECTION_SIZE   4096
#define RODATA_SECTION_INCREMENT      1024

#define HAVE_PROGRAM_SECTION (poffInfo->progSection.sh_size > 0)
#define HAVE_RODATA_SECTION  (poffInfo->roDataSection.sh_size > 0)
#define HAVE_SYMBOL_TABLE    (poffInfo->symbolTableSection.sh_size > 0)
#define HAVE_STRING_TABLE    (poffInfo->stringTableSection.sh_size > 0)
#define HAVE_RELOC_SECTION   (poffInfo->relocSection.sh_size > 0)
#define HAVE_FILE_TABLE      (poffInfo->fileNameTableSection.sh_size > 0)
#define HAVE_LINE_NUMBER     (poffInfo->lineNumberSection.sh_size > 0)
#define HAVE_DEBUG_SECTION   (poffInfo->debugFuncSection.sh_size > 0)

#ifndef CONFIG_POFF_SWAPNEEDED
# define poffSwapFileHeader(p)
# define poffSwapSectionHeader(p)
# define poffSwapSymbolTableData(p)
# define poffSwapRelocationData(p)
# define poffSwapFileTableData(p)
# define poffSwapLineNumberData(p)
# define poffSwapDebugData(p)
#endif

/***************************************************************************
 * Public Types
 ***************************************************************************/

struct poffInfo_s
{
  /* POFF file header */

  poffFileHeader_t    fileHeader;

  /* Section headers: */

  poffSectionHeader_t progSection;
  poffSectionHeader_t roDataSection;
  poffSectionHeader_t symbolTableSection;
  poffSectionHeader_t stringTableSection;
  poffSectionHeader_t relocSection;
  poffSectionHeader_t fileNameTableSection;
  poffSectionHeader_t lineNumberSection;
  poffSectionHeader_t debugFuncSection;

  /* In-memory section data */

  uint8_t            *progSectionData;
  uint8_t            *roDataSectionData;
  uint8_t            *symbolTable;
  char               *stringTable;
  uint8_t            *relocTable;
  poffFileTab_t      *fileNameTable;
  uint8_t            *lineNumberTable;
  uint8_t            *debugFuncTable;

  /* Current allocation sizes.  Used only on writing to determine if
   * in-memory has been allocated and how much memory has been allocated
   * in case the buffer needs to be re-allocated.
   */

  uint32_t            progSectionAlloc;
  uint32_t            roDataSectionAlloc;
  uint32_t            symbolTableAlloc;
  uint32_t            stringTableAlloc;
  uint32_t            relocAlloc;
  uint32_t            fileNameTableAlloc;
  uint32_t            lineNumberTableAlloc;
  uint32_t            debugFuncTableAlloc;

  /* Current buffer indices.  These are used on reading data sequentially
   * from the in-memory section data.
   */

  uint32_t            progSectionIndex;
  uint32_t            symbolIndex;
  uint32_t            relocIndex;
  uint32_t            fileNameIndex;
  uint32_t            lineNumberIndex;
  uint32_t            debugFuncIndex;
};
typedef struct poffInfo_s poffInfo_t;

struct poffProgInfo_s
{
  uint32_t            progSectionSize;
  uint32_t            progSectionAlloc;
  uint8_t            *progSectionData;
};
typedef struct poffProgInfo_s poffProgInfo_t;

struct poffSymInfo_s
{
  uint32_t            symbolTableSize;
  uint32_t            symbolTableAlloc;
  uint8_t            *symbolTable;
};
typedef struct poffSymInfo_s poffSymInfo_t;

/***************************************************************************
 * Public Variables
 ***************************************************************************/

/***************************************************************************
 * Public Function Prototypes
 ***************************************************************************/

#ifdef CONFIG_POFF_SWAPNEEDED
extern void poffSwapFileHeader(poffFileHeader_t *pFileHeader);
extern void poffSwapSectionHeader(poffSectionHeader_t *pSectionHeader);
extern void poffSwapSymbolTableData(poffInfo_t *poffInfo);
extern void poffSwapRelocationData(poffInfo_t *poffInfo);
extern void poffSwapFileTableData(poffInfo_t *poffInfo);
extern void poffSwapLineNumberData(poffInfo_t *poffInfo);
extern void poffSwapDebugData(poffInfo_t *poffInfo);
#endif

#endif /* __PFPRIVATE_H */