source: branches/qres/ccl/library/elf.lisp @ 15278

Last change on this file since 15278 was 13189, checked in by gz, 10 years ago

Merge r13180 (fix for newer oprofile)

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