source: release/1.6/source/library/elf.lisp @ 14493

Last change on this file since 14493 was 14230, checked in by rme, 9 years ago

The signature of %map-areas changed in r13174; update caller.

File size: 21.1 KB
Line 
1;;; Copyright 2009 Clozure Associates
2;;; This file is part of Clozure CL. 
3;;;
4;;; Clozure CL is licensed under the terms of the Lisp Lesser GNU
5;;; Public License , known as the LLGPL and distributed with Clozure
6;;; CL as the file "LICENSE".  The LLGPL consists of a preamble and
7;;; the LGPL, which is distributed with Clozure CL as the file "LGPL".
8;;; Where these conflict, the preamble takes precedence.
9;;;
10;;; Clozure CL is referenced in the preamble as the "LIBRARY."
11;;;
12;;; The LLGPL is also available online at
13;;; http://opensource.franz.com/preamble.html
14
15(in-package "CCL")
16
17(eval-when (:compile-toplevel :execute)
18  (use-interface-dir :elf))
19
20
21(defloadvar *readonly-area*
22    (do-consing-areas (a)
23      (when (eql (%fixnum-ref a target::area.code)
24                 ccl::area-readonly)
25        (return a))))
26
27;;; String tables: used both for symbol names and for section names.
28(defstruct elf-string-table
29  (hash (make-hash-table :test #'equal))
30  (string (make-array 100 :element-type '(unsigned-byte 8) :fill-pointer 1 :adjustable t)))
31
32;;; Collect info about Elf symbols.
33(defstruct elf-symbol-table
34  (strings (make-elf-string-table))
35  data                                  ; foreign pointer
36  nsyms
37  )
38
39;;; Wrapper around libelf's "elf" pointer
40(defstruct elf-object
41  libelf-pointer
42  fd
43  pathname
44  )
45
46
47;;; Is libelf thread-safe ?  Who knows, there's no
48;;; documentation ...
49(defun libelf-error-string (&optional (errnum -1))
50  (let* ((p (#_elf_errmsg errnum)))
51    (if (%null-ptr-p p)
52      (format nil "ELF error ~d" errnum)
53      (%get-cstring p))))
54
55(defloadvar *checked-libelf-version* nil)
56
57(defun check-libelf-version ()
58  (or *checked-libelf-version*
59      (progn
60        (open-shared-library "libelf.so")
61        (let* ((version (#_elf_version #$EV_CURRENT)))
62          (if (eql #$EV_NONE version)
63            (error "ELF library initialization failed: ~a" (libelf-error-string)))
64          (setq *checked-libelf-version* version)))))
65
66
67;;; Prepate to create an ELF object file at PATHNAME, overwriting
68;;; whatever might have been there.
69(defun create-elf-object (pathname)
70  (let* ((namestring (native-translated-namestring pathname))
71         (fd (ccl::fd-open namestring
72                           (logior #$O_RDWR #$O_CREAT #$O_TRUNC)
73                           #o755)))
74    (if (< fd 0)
75      (signal-file-error fd pathname)
76      (progn
77        (check-libelf-version)
78        (let* ((ptr (#_elf_begin fd #$ELF_C_WRITE +null-ptr+)))
79          (if (%null-ptr-p ptr)
80            (error "Can't initialize libelf object for ~s: ~a"
81                   pathname (libelf-error-string))
82            (make-elf-object :libelf-pointer (assert-pointer-type ptr :<E>lf)
83                             :fd fd
84                             :pathname pathname)))))))
85
86(defun elf-end (object)
87  (#_elf_end (elf-object-libelf-pointer object))
88  (setf (elf-object-libelf-pointer object) nil
89        (elf-object-fd object) nil))
90
91(defun new-elf-file-header (object format type machine)
92  (let* ((ehdr (#+64-bit-target #_elf64_newehdr #+32-bit-target #_elf32_newehdr (elf-object-libelf-pointer object))))
93    (if (%null-ptr-p ehdr)
94      (error "Can't create ELF file header for ~s: ~a"
95             (elf-object-pathname object)
96             (libelf-error-string))
97      (progn
98        (setf (paref (pref ehdr
99                           #+64-bit-target :<E>lf64_<E>hdr.e_ident
100                           #+32-bit-target :<E>lf32_<E>hdr.e_ident) (:* :unsigned-char) #$EI_DATA) format
101              (pref ehdr
102                    #+64-bit-target :<E>lf64_<E>hdr.e_machine
103                    #+32-bit-target :<E>lf32_<E>hdr.e_machine) machine
104              (pref ehdr
105                    #+64-bit-target :<E>lf64_<E>hdr.e_type
106                    #+32-bit-target :<E>lf32_<E>hdr.e_type) type
107              (pref ehdr
108                    #+64-bit-target :<E>lf64_<E>hdr.e_version
109                    #+32-bit-target :<E>lf32_<E>hdr.e_version) *checked-libelf-version*)
110        (assert-pointer-type ehdr
111                             #+64-bit-target :<E>lf64_<E>hdr
112                             #+32-bit-target :<E>lf32_<E>hdr)))))
113
114(defun new-elf-program-header (object &optional (count 1))
115  (let* ((phdr (#+64-bit-target #_elf64_newphdr #+32-bit-target #_elf32_newphdr (elf-object-libelf-pointer object) count)))
116    (if (%null-ptr-p phdr)
117      (error "Can't create ELF program header for ~s: ~a"
118             (elf-object-pathname object)
119             (libelf-error-string))
120      (assert-pointer-type phdr
121                           #+64-bit-target :<E>lf64_<P>hdr
122                           #+32-bit-target :<E>lf32_<P>hdr))))
123
124(defun new-elf-section (object)
125  (let* ((scn (#_elf_newscn (elf-object-libelf-pointer object))))
126    (if (%null-ptr-p scn)
127      (error "Can' create ELF section for ~s: ~a"
128             (elf-object-pathname object)
129             (libelf-error-string))
130      (assert-pointer-type scn :<E>lf_<S>cn))))
131
132(defun elf-section-header-for-section (object section)
133  (let* ((shdr (#+64-bit-target #_elf64_getshdr #+32-bit-target #_elf32_getshdr  section)))
134    (if (%null-ptr-p shdr)
135      (error "Can' obtain ELF section header for ~s: ~a"
136             (elf-object-pathname object)
137             (libelf-error-string))
138      (assert-pointer-type shdr
139                           #+64-bit-target :<E>lf64_<S>hdr
140                           #+32-bit-target :<E>lf32_<S>hdr))))
141
142(defun elf-data-pointer-for-section (object section)
143  (let* ((data (#_elf_newdata section)))
144    (if (%null-ptr-p data)
145      (error "Can' obtain ELF data pointer for ~s: ~a"
146             (elf-object-pathname object)
147             (libelf-error-string))
148      (assert-pointer-type data :<E>lf_<D>ata))))
149                   
150
151(defun elf-register-string (string table)
152  (let* ((hash (elf-string-table-hash table))
153         (s (elf-string-table-string table)))
154    (when (gethash string hash)
155      (format t "~& duplicate: ~s" string))
156    (or (gethash string hash)
157        (setf (gethash string hash)
158              (let* ((n (length s)))
159                (dotimes (i (length string) (progn (vector-push-extend 0 s) n))
160                  (let* ((code (char-code (char string i))))
161                    (declare (type (mod #x110000) code))
162                    (if (> code 255)
163                      (vector-push-extend (char-code #\sub) s)
164                      (vector-push-extend code s)))))))))
165
166
167(defun elf-lisp-function-name (f)
168  (let* ((name (format nil "~s" f)))
169    (subseq (nsubstitute #\0 #\# (nsubstitute #\. #\Space name)) 1)))
170
171
172#+x86-target
173(defun collect-elf-static-functions ()
174  (collect ((functions))
175    (purify)
176    (block walk
177      (%map-areas (lambda (o)
178                    (when (typep o
179                                 #+x8664-target 'function-vector
180                                 #-x8664-target 'function)
181                      (functions (function-vector-to-function o))))
182                  :readonly
183                  ))
184    (functions)))
185
186#+(or arm-target ppc-target)
187(defun collect-elf-static-functions ()
188  (ccl::purify)
189  (multiple-value-bind (pure-low pure-high)
190      (ccl::do-gc-areas (a)
191        (when (eql(ccl::%fixnum-ref a target::area.code)
192                  ccl::area-readonly)
193          (return
194            (values (ash (ccl::%fixnum-ref a target::area.low) target::fixnumshift)
195                    (ash (ccl::%fixnum-ref a target::area.active) target::fixnumshift)))))
196    (let* ((hash (make-hash-table :test #'eq))
197           (code-vector-index #+ppc-target 0 #+arm-target 1))
198      (ccl::%map-lfuns #'(lambda (f)
199                           (let* ((code-vector  (ccl:uvref f code-vector-index))
200                                  (startaddr (+ (ccl::%address-of code-vector)
201                                                target::misc-data-offset)))
202                             (when (and (>= startaddr pure-low)
203                                        (< startaddr pure-high))
204                               (push f (gethash code-vector hash))))))
205      (let* ((n 0))
206        (declare (fixnum n))
207        (maphash #'(lambda (k v)
208                     (declare (ignore k))
209                     (if (null (cdr v))
210                       (incf n)))
211                 hash)
212        (let* ((functions ()))
213          (maphash #'(lambda (k v)
214                       (declare (ignore k))
215                       (when (null (cdr v))
216                         (push (car v) functions)))
217                   hash)
218          (sort functions
219                #'(lambda (x y)
220                    (< (ccl::%address-of (uvref x code-vector-index))
221                       (ccl::%address-of (uvref y code-vector-index))))))))))
222
223(defun register-elf-functions (section-number)
224  (let* ((functions (collect-elf-static-functions))
225         (n (length functions))
226         (data (#_calloc (1+ n) (record-length #+64-bit-target :<E>lf64_<S>ym
227                                               #+32-bit-target :<E>lf32_<S>ym)))
228         (string-table (make-elf-string-table)))
229    (declare (fixnum n))
230    (do* ((i 0 (1+ i))
231          (p (%inc-ptr data
232                       (record-length #+64-bit-target :<E>lf64_<S>ym
233                                      #+32-bit-target :<E>lf32_<S>ym))
234             (progn (%incf-ptr p
235                               (record-length #+64-bit-target :<E>lf64_<S>ym
236                                              #+32-bit-target :<E>lf32_<S>ym))
237                    p))
238          (f (pop functions) (pop functions)))
239         ((= i n)
240          (make-elf-symbol-table :strings string-table :data data :nsyms n))
241      (declare (fixnum n))
242      (setf (pref p
243                  #+64-bit-target :<E>lf64_<S>ym.st_name
244                  #+32-bit-target :<E>lf32_<S>ym.st_name)
245            (elf-register-string (elf-lisp-function-name f) string-table)
246            (pref p
247                  #+64-bit-target :<E>lf64_<S>ym.st_info
248                  #+32-bit-target :<E>lf32_<S>ym.st_info)
249            (logior (ash #$STB_GLOBAL 4) #$STT_FUNC)
250            (pref p
251                  #+64-bit-target :<E>lf64_<S>ym.st_shndx
252                  #+32-bit-target :<E>lf32_<S>ym.st_shndx) section-number
253            (pref p
254                  #+64-bit-target :<E>lf64_<S>ym.st_value
255                  #+32-bit-target :<E>lf32_<S>ym.st_value)
256            #+x86-target (%address-of f)
257            #+ppc-target (- (%address-of (uvref f 0)) (- ppc::fulltag-misc ppc::node-size))
258            #+arm-target (- (%address-of (uvref f 1)) (- arm::fulltag-misc arm::node-size))
259            (pref p
260                  #+64-bit-target :<E>lf64_<S>ym.st_size
261                  #+32-bit-target :<E>lf32_<S>ym.st_size)
262            #+x86-target (1+ (ash (1- (%function-code-words f)) target::word-shift))
263            #+ppc-target (ash (uvsize (uvref f 0)) ppc::word-shift)
264            #+arm-target (ash (uvsize (uvref f 1)) arm::word-shift)
265            ))))
266
267(defun elf-section-index (section)
268  (#_elf_ndxscn section))
269
270(defun elf-set-shstrab-section (object scn)
271  #+freebsd-target
272  (#_elf_setshstrndx (elf-object-libelf-pointer object) (elf-section-index scn))
273  #-freebsd-target
274  (declare (ignore object scn)))
275
276
277(defun elf-init-section-data-from-string-table (object section string-table)
278  (let* ((strings-data (elf-data-pointer-for-section object section))
279         (s (elf-string-table-string string-table))
280         (bytes (array-data-and-offset s))
281         (n (length s))
282         (buf (#_malloc n)))
283    (%copy-ivector-to-ptr bytes 0 buf 0 n)
284    (setf (pref strings-data :<E>lf_<D>ata.d_align) 1
285          (pref strings-data :<E>lf_<D>ata.d_off) 0
286          (pref strings-data :<E>lf_<D>ata.d_type) #$ELF_T_BYTE
287          (pref strings-data :<E>lf_<D>ata.d_version) #$EV_CURRENT
288          (pref strings-data :<E>lf_<D>ata.d_size) n
289          (pref strings-data :<E>lf_<D>ata.d_buf) buf)
290    n))
291
292(defun elf-init-symbol-section-from-symbol-table (object section symbols)
293  (let* ((symbols-data (elf-data-pointer-for-section object section))
294         (buf (elf-symbol-table-data symbols))
295         (nsyms (elf-symbol-table-nsyms symbols) )
296         (n (* (1+ nsyms) (record-length #+64-bit-target :<E>lf64_<S>ym
297                                         #+32-bit-target :<E>lf32_<S>ym))))
298    (setf (pref symbols-data :<E>lf_<D>ata.d_align) 8
299          (pref symbols-data :<E>lf_<D>ata.d_off) 0
300          (pref symbols-data :<E>lf_<D>ata.d_type) #$ELF_T_SYM
301          (pref symbols-data :<E>lf_<D>ata.d_version) #$EV_CURRENT
302          (pref symbols-data :<E>lf_<D>ata.d_size) n
303          (pref symbols-data :<E>lf_<D>ata.d_buf) buf)
304    nsyms))
305
306(defun elf-make-empty-data-for-section (object section &optional (size 0))
307  (let* ((data (elf-data-pointer-for-section object section))
308         (buf +null-ptr+))
309    (setf (pref data :<E>lf_<D>ata.d_align) 0
310          (pref data :<E>lf_<D>ata.d_off) 0
311          (pref data :<E>lf_<D>ata.d_type) #$ELF_T_BYTE
312          (pref data :<E>lf_<D>ata.d_version) #$EV_CURRENT
313          (pref data :<E>lf_<D>ata.d_size) size
314          (pref data :<E>lf_<D>ata.d_buf) buf)
315    0))
316 
317
318(defun elf-flag-phdr (object cmd flags)
319  (#_elf_flagphdr (elf-object-libelf-pointer object) cmd flags))
320
321(defun elf-update (object cmd)
322  (let* ((size (#_elf_update (elf-object-libelf-pointer object) cmd)))
323    (if (< size 0)
324      (error "elf_update failed for for ~s: ~a"
325             (elf-object-pathname object)
326             (libelf-error-string))
327      size)))
328
329(defun fixup-lisp-section-offset (fd eof sectnum)
330  (fd-lseek fd 0 #$SEEK_SET)
331  (rlet ((fhdr #+64-bit-target :<E>lf64_<E>hdr
332               #+32-bit-target :<E>lf32_<E>hdr)
333         (shdr #+64-bit-target :<E>lf64_<S>hdr
334               #+32-bit-target :<E>lf32_<S>hdr))
335    (fd-read fd fhdr (record-length #+64-bit-target :<E>lf64_<E>hdr
336                                    #+32-bit-target :<E>lf32_<E>hdr))
337    (let* ((pos (+ (pref fhdr #+64-bit-target :<E>lf64_<E>hdr.e_shoff
338                         #+32-bit-target :<E>lf32_<E>hdr.e_shoff)
339                   (* sectnum (pref fhdr #+64-bit-target :<E>lf64_<E>hdr.e_shentsize
340                                    #+32-bit-target :<E>lf32_<E>hdr.e_shentsize)))))
341      (fd-lseek fd pos #$SEEK_SET)
342      (fd-read fd shdr (record-length #+64-bit-target :<E>lf64_<S>hdr
343                                      #+32-bit-target :<E>lf32_<S>hdr))
344      ;; On 64-bit platforms, the section data precedes the image
345      ;; header; on 32-bit platforms, the image header and image
346      ;; section table precede the image data for the first (static)
347      ;; section.  With alignment, the header/section headers are
348      ;; one 4K page, and the static section size is 8K ...
349      (setf (pref shdr #+64-bit-target :<E>lf64_<S>hdr.sh_offset
350                  #+32-bit-target :<E>lf32_<S>hdr.sh_offset)
351            (+ #+32-bit-target #x1000 #+64-bit-target 0  #x2000 (logandc2 (+ eof 4095) 4095))) 
352      (setf (pref shdr #+64-bit-target :<E>lf64_<S>hdr.sh_type
353                  #+32-bit-target :<E>lf32_<S>hdr.sh_type)
354            #$SHT_PROGBITS)
355      (fd-lseek fd pos #$SEEK_SET)
356      (fd-write fd shdr (record-length #+64-bit-target :<E>lf64_<S>hdr
357                                       #+32-bit-target :<E>lf32_<S>hdr))
358      t)))
359 
360(defun write-elf-symbols-to-file (pathname)
361  (let* ((object (create-elf-object pathname))
362         (file-header (new-elf-file-header object
363                                           #+little-endian-target #$ELFDATA2LSB
364                                           #+big-endian-target #$ELFDATA2MSB
365                                           #$ET_DYN
366                                           #+x8664-target #$EM_X86_64
367                                           #+x8632-target #$EM_386
368                                           #+ppc32-target #$EM_PPC
369                                           #+ppc64-target #$EM_PPC64
370                                           #+arm-target #$EM_ARM
371                                           ))
372         (program-header (new-elf-program-header object))
373         (lisp-section (new-elf-section object))
374         (symbols-section (new-elf-section object))
375         (strings-section (new-elf-section object))
376         (shstrtab-section (new-elf-section object))
377         (section-names (make-elf-string-table))
378         (lisp-section-index (elf-section-index lisp-section))
379         (symbols (register-elf-functions lisp-section-index))
380         (lisp-section-header (elf-section-header-for-section object lisp-section))
381         (symbols-section-header (elf-section-header-for-section object symbols-section))
382         (strings-section-header (elf-section-header-for-section object strings-section))
383         (shstrtab-section-header (elf-section-header-for-section object shstrtab-section)))
384   
385    (setf (pref file-header #+64-bit-target :<E>lf64_<E>hdr.e_shstrndx
386                #+32-bit-target :<E>lf32_<E>hdr.e_shstrndx) (elf-section-index shstrtab-section))
387    (setf (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_name
388                #+32-bit-target :<E>lf32_<S>hdr.sh_name) (elf-register-string ".lisp" section-names)
389          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_type
390                #+32-bit-target :<E>lf32_<S>hdr.sh_type) #$SHT_NOBITS
391          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_flags
392                #+32-bit-target :<E>lf32_<S>hdr.sh_flags) (logior #$SHF_WRITE #$SHF_ALLOC #$SHF_EXECINSTR)
393          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_addr
394                #+32-bit-target :<E>lf32_<S>hdr.sh_addr) (ash (%fixnum-ref *readonly-area* target::area.low) target::fixnumshift)
395          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_size
396                #+32-bit-target :<E>lf32_<S>hdr.sh_size) (ash (- (%fixnum-ref *readonly-area* target::area.active) (%fixnum-ref *readonly-area* target::area.low) )target::fixnumshift)
397          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_offset
398                #+32-bit-target :<E>lf32_<S>hdr.sh_offset) 0
399          (pref lisp-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_addralign
400                #+32-bit-target :<E>lf32_<S>hdr.sh_addralign) 1)
401    (setf (pref symbols-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_name
402                #+32-bit-target :<E>lf32_<S>hdr.sh_name) (elf-register-string ".symtab" section-names)
403          (pref symbols-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_type
404                #+32-bit-target :<E>lf32_<S>hdr.sh_type) #$SHT_SYMTAB
405          (pref symbols-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_entsize
406                #+32-bit-target :<E>lf32_<S>hdr.sh_entsize) (record-length #+64-bit-target :<E>lf64_<S>ym
407                                                                           #+32-bit-target :<E>lf32_<S>ym)
408          (pref symbols-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_link
409                #+32-bit-target :<E>lf32_<S>hdr.sh_link) (elf-section-index strings-section))
410    (setf (pref strings-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_name
411                #+32-bit-target :<E>lf32_<S>hdr.sh_name) (elf-register-string ".strtab" section-names)
412          (pref strings-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_type
413                #+32-bit-target :<E>lf32_<S>hdr.sh_type) #$SHT_STRTAB
414          (pref strings-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_flags
415                #+32-bit-target :<E>lf32_<S>hdr.sh_flags) (logior #$SHF_STRINGS #$SHF_ALLOC))
416    (setf (pref shstrtab-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_name
417                #+32-bit-target :<E>lf32_<S>hdr.sh_name) (elf-register-string ".shstrtab" section-names)
418          (pref shstrtab-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_type
419                #+32-bit-target :<E>lf32_<S>hdr.sh_type) #$SHT_STRTAB
420          (pref shstrtab-section-header #+64-bit-target :<E>lf64_<S>hdr.sh_flags
421                #+32-bit-target :<E>lf32_<S>hdr.sh_flags) (logior #$SHF_STRINGS #$SHF_ALLOC))
422    (elf-make-empty-data-for-section object lisp-section (ash (- (%fixnum-ref *readonly-area* target::area.active) (%fixnum-ref *readonly-area* target::area.low) )target::fixnumshift))
423    (elf-init-section-data-from-string-table object strings-section (elf-symbol-table-strings symbols))
424    (elf-init-section-data-from-string-table object shstrtab-section section-names)
425    (elf-init-symbol-section-from-symbol-table object symbols-section symbols)
426    ;; Prepare in-memory data structures.
427    (elf-update object #$ELF_C_NULL)
428    ;; Fix up the program header.
429    (setf (pref program-header
430                #+64-bit-target :<E>lf64_<P>hdr.p_type
431                #+32-bit-target :<E>lf32_<P>hdr.p_type) #$PT_PHDR
432          (pref program-header #+64-bit-target :<E>lf64_<P>hdr.p_offset
433                #+32-bit-target :<E>lf32_<P>hdr.p_offset)
434          (pref file-header
435                #+64-bit-target :<E>lf64_<E>hdr.e_phoff
436                #+32-bit-target :<E>lf32_<E>hdr.e_phoff)
437          (pref program-header
438                #+64-bit-target :<E>lf64_<P>hdr.p_filesz
439                #+32-bit-target :<E>lf32_<P>hdr.p_filesz)
440          (#+64-bit-target #_elf64_fsize #+32-bit-target #_elf32_fsize #$ELF_T_PHDR 1 #$EV_CURRENT))
441    ;; Mark the program header as being dirty.
442    (elf-flag-phdr object #$ELF_C_SET #$ELF_F_DIRTY)
443    (let* ((eof (elf-update object #$ELF_C_WRITE))
444           (fd (elf-object-fd object)))
445      (elf-end object)
446      (fixup-lisp-section-offset fd eof lisp-section-index)
447      (fd-close fd))
448    pathname))
449
450     
451   
452   
Note: See TracBrowser for help on using the repository browser.