File: elf-structs.lisp

package info (click to toggle)
acl2 8.6%2Bdfsg-3
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 1,138,276 kB
  • sloc: lisp: 17,818,294; java: 125,359; python: 28,122; javascript: 23,458; cpp: 18,851; ansic: 11,569; perl: 7,678; xml: 5,591; sh: 3,978; makefile: 3,840; ruby: 2,633; yacc: 1,126; ml: 763; awk: 295; csh: 233; lex: 197; php: 178; tcl: 49; asm: 23; haskell: 17
file content (223 lines) | stat: -rw-r--r-- 8,329 bytes parent folder | download | duplicates (3)
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
; EXLD (execloader) Library

; Note: The license below is based on the template at:
; http://opensource.org/licenses/BSD-3-Clause

; Copyright (C) 2020, Shilpi Goel
; All rights reserved.

; Redistribution and use in source and binary forms, with or without
; modification, are permitted provided that the following conditions are
; met:

; o Redistributions of source code must retain the above copyright
;   notice, this list of conditions and the following disclaimer.

; o 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.

; o Neither the name of the copyright holders 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
; HOLDER 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.

; Original Author(s):
; Shilpi Goel         <shigoel@gmail.com>

(in-package "EXLD")

(include-book "std/strings/pad" :dir :system)
(include-book "kestrel/fty/byte-list" :dir :system)
(include-book "centaur/fty/bitstruct" :dir :system)
(include-book "centaur/fty/top" :dir :system)

(local (xdoc::set-default-parents elf-reader))

;; ----------------------------------------------------------------------

;; ELF segments:

(defprod elf64-segment-header
  ((type natp :default 0)
   (flags natp :default 0)
   (offset natp :default 0)
   (vaddr  natp :default 0)
   (paddr  natp :default 0)
   (filesz natp :default 0)
   (memsz  natp :default 0)
   (align  natp :default 0)))
(fty::deflist elf64-segment-headers
              :elt-type elf64-segment-header
              :true-listp t)

(defprod elf32-segment-header
  ((type   natp :default 0)
   (flags  natp :default 0)
   (offset natp :default 0)
   (vaddr  natp :default 0)
   (paddr  natp :default 0)
   (filesz natp :default 0)
   (memsz  natp :default 0)
   (align  natp :default 0)))
(fty::deflist elf32-segment-headers
              :elt-type elf32-segment-header
              :true-listp t)

;; ----------------------------------------------------------------------

;; ELF sections:

(defprod elf-section-header
  ((name-str  stringp :default "")
   (name      natp :default 0)
   (type      natp :default 0)
   (flags     natp :default 0)
   (addr      natp :default 0
              "The address where this section should be laid in memory")
   (offset    natp :default 0
              "The offset in the binary file where this section is located")
   (size      natp :default 0
              "The size of the section in terms of number of bytes it occupies")
   (link      natp :default 0)
   (info      natp :default 0)
   (addralign natp :default 0)
   (entsize   natp :default 0)))
(fty::deflist elf-section-headers
              :elt-type elf-section-header
              :true-listp t)

(defprod section-info
  :short "Relevant information about a section of an ELF or Mach-O binary file"
  ((header elf-section-header-p :default (make-elf-section-header))
   (bytes byte-listp :default 'nil
          "The content of this section (least-significant byte first)")))
(fty::deflist section-info-list :elt-type section-info-p :true-listp t)

(define section-names ((section-info-list section-info-list-p))
  :short "Get all names from sections in @('section-info-list')"
  :returns (sec-names string-listp :hyp :guard)
  (b* (((when (atom section-info-list))
        nil)
       ((section-info section-info) (car section-info-list))
       ((elf-section-header section-info.header)))
    (cons section-info.header.name-str (section-names (cdr section-info-list))))
  ///
  (defthm cdr-section-names
    (equal (section-names (cdr sec-info-list))
           (cdr (section-names sec-info-list)))))

(define get-section-info1 ((name stringp "Name of a section header; e.g., \".symtab\"")
                           (section-info-list section-info-list-p)
                           (section-names string-listp))
  :guard (subsetp-equal (section-names section-info-list) section-names)
  :returns (section-info section-info-p :hyp (section-info-list-p section-info-list))
  (b* (((when (atom section-info-list))
        (prog2$
         (raise "Section ~s0 not found! List of sections found: ~x1."
                name section-names)
         (make-section-info)))
       ((section-info section-info) (car section-info-list))
       ((elf-section-header section-info.header))
       ((when (equal (str::trim section-info.header.name-str) (str::trim name)))
        section-info))
    (get-section-info1 name (cdr section-info-list) section-names)))

(define get-section-info ((name stringp "Name of a section header; e.g., \".symtab\"")
                          (section-info-list section-info-list-p))
  :short "Get a @(tsee section-info-p) in @('section-info-list-p') corresponding to @('name')"
  :returns (section-info section-info-p :hyp (section-info-list-p section-info-list))
  (get-section-info1 name section-info-list (section-names section-info-list)))

;; ----------------------------------------------------------------------

;; ELF header:

(defprod elf-header
  ((magic     byte-listp :default 'nil)
   (class     natp :default 0)
   (dataenc   natp :default 0)
   (identver  natp :default 0)
   (osabi     natp :default 0)
   (abiver    natp :default 0)
   (padding   byte-listp :default 'nil)
   (type      natp :default 0)
   (machine   natp :default 0)
   (version   natp :default 0)
   (entry     natp :default 0)
   (phoff     natp :default 0)
   (shoff     natp :default 0)
   (flags     natp :default 0)
   (ehsize    natp :default 0)
   (phentsize natp :default 0)
   (phnum     natp :default 0)
   (shentsize natp :default 0)
   (shnum     natp :default 0)
   (shstrndx  natp :default 0)))

;; ----------------------------------------------------------------------

;; Symbol table entries:

(fty::defbitstruct elf_bits8   8)
(fty::defbitstruct elf_bits16 16)
(fty::defbitstruct elf_bits32 32)
(fty::defbitstruct elf_bits64 64)
(fty::defbitstruct elf64_sym ;; LSB first                   
  ;; typedef struct {
  ;;     uint32_t      st_name;
  ;;     unsigned char st_info;
  ;;     unsigned char st_other;
  ;;     uint16_t      st_shndx;
  ;;     Elf64_Addr    st_value;
  ;;     uint64_t      st_size;
  ;; } Elf64_Sym;
  ((name     elf_bits32 :default 0)
   (info     elf_bits8  :default 0)
   (other    elf_bits8  :default 0)
   (shndx    elf_bits16 :default 0)
   (value    elf_bits64 :default 0)
   (size     elf_bits64 :default 0))
  :msb-first nil)

(defprod elf64_sym-info
  ((name-str stringp        :default "") ;; Obtained from strtab.
   (entry    elf64_sym-p    :default 0)))
(fty::deflist elf64_sym-info-list
              :elt-type elf64_sym-info
              :true-listp t)

(fty::defbitstruct elf32_sym
  ;; typedef struct {
  ;;     uint32_t      st_name;
  ;;     Elf32_Addr    st_value;
  ;;     uint32_t      st_size;
  ;;     unsigned char st_info;
  ;;     unsigned char st_other;
  ;;     uint16_t      st_shndx;
  ;; } Elf32_Sym;
  ((name  elf_bits32 :default 0)
   (value elf_bits32 :default 0)
   (size  elf_bits32 :default 0)
   (info  elf_bits8  :default 0)
   (other elf_bits8  :default 0)
   (shndx elf_bits16 :default 0)))
(defprod elf32_sym-info
  ((name-str stringp        :default "") ;; Obtained from strtab.
   (entry    elf32_sym      :default 0)))
(fty::deflist elf32_sym-info-list
              :elt-type elf32_sym-info
              :true-listp t)

;; ----------------------------------------------------------------------