tools-for-build/ldso-stubs.lisp

   1 ;;;; Generate stubs for C-linkage library functions which we need to refer to
   2 ;;;; from Lisp.
   3 ;;;;
   4 ;;;; (But note this is only the Linux version, as per the FIXME
   5 ;;;; note in the BSD version in undefineds.h.)
   6 ;;;;
   7 ;;;; These stubs exist for the benefit of Lisp code that needs to refer
   8 ;;;; to foreign symbols when dlsym() is not available (i.e. when dumping
   9 ;;;; cold-sbcl.core, when we may be running in a host that's not SBCL,
  10 ;;;; or on platforms that don't have it at all). If the runtime is
  11 ;;;; dynamically linked, library functions won't be linked into it, so
  12 ;;;; the map file won't show them. So, we need a bunch of stubs that
  13 ;;;; nm(1) _can_ see.
  14 ;;;;
  15 ;;;; This software is part of the SBCL system. See the README file for
  16 ;;;; more information.
  17 ;;;;
  18 ;;;; This software is derived from the CMU CL system, which was
  19 ;;;; written at Carnegie Mellon University and released into the
  20 ;;;; public domain. The software is in the public domain and is
  21 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  22 ;;;; files for more information.
  23
  24 #!-sparc
  25 (defun ldso-stubify (fct str)
  26   (format str "LDSO_STUBIFY(~A)~%" fct))
  27
  28 ;;; This is an attempt to follow DB's hint of sbcl-devel
  29 ;;; 2001-09-18. -- CSR
  30 ;;;
  31 ;;; And an attempt to work around the Sun toolchain... --ns
  32 #!+sparc
  33 (defun ldso-stubify (fct str)
  34   (apply #'format str "
  35 .globl ldso_stub__~A ;                          \\
  36         FUNCDEF(ldso_stub__~A) ;                \\
  37 ldso_stub__~A: ;                                \\
  38         sethi %hi(~A),%g1       ;               \\
  39         jmpl %g1+%lo(~A),%g0    ;               \\
  40         nop /* delay slot*/     ;               \\
  41 .L~Ae1: ;                                       \\
  42         .size    ldso_stub__~A,.L~Ae1-ldso_stub__~A ;~%"
  43           (make-list 9 :initial-element fct)))
  44
  45 (defvar *preludes* '("
  46 /* This is an automatically generated file, please do not hand-edit it.
  47  * See the program tools-for-build/ldso-stubs.lisp. */
  48
  49 #ifndef LANGUAGE_ASSEMBLY
  50 #define LANGUAGE_ASSEMBLY
  51 #endif
  52 #include \"sbcl.h\""
  53
  54 #!+sparc "
  55 #ifdef LISP_FEATURE_SPARC
  56 #include \"sparc-funcdef.h\"
  57 #endif
  58         .text"
  59
  60 #!+(or (and x86 (not darwin)) x86-64) "
  61 #define LDSO_STUBIFY(fct)                       \\
  62         .align 16 ;                             \\
  63 .globl ldso_stub__ ## fct ;                     \\
  64         .type    ldso_stub__ ## fct,@function ; \\
  65 ldso_stub__ ## fct: ;                           \\
  66         jmp fct ;                               \\
  67 .L ## fct ## e1: ;                              \\
  68         .size    ldso_stub__ ## fct,.L ## fct ## e1-ldso_stub__ ## fct ;"
  69
  70 ;;; osf1 has ancient cpp that doesn't do ##
  71 #!+(and osf1 alpha) "
  72 #define LDSO_STUBIFY(fct)                       \\
  73 .globl ldso_stub__/**/fct ;                     \\
  74 ldso_stub__/**/fct: ;                           \\
  75         jmp fct ;                               \\
  76 .L/**/fct/**/e1: ;"
  77
  78 ;;; but there's no reason we need to put up with that on modern (Linux) OSes
  79 #!+(and linux alpha) "
  80 #define LDSO_STUBIFY(fct)                       \\
  81 .globl ldso_stub__ ## fct ;                     \\
  82         .type    ldso_stub__ ## fct,@function ; \\
  83 ldso_stub__ ## fct: ;                           \\
  84         jmp fct ;                               \\
  85 .L ## fct ## e1: ;                              \\
  86         .size    ldso_stub__ ## fct,.L ## fct ## e1-ldso_stub__ ## fct ;"
  87
  88 #!+(and linux ppc) "
  89 #define LDSO_STUBIFY(fct)                       \\
  90 .globl ldso_stub__ ## fct ;                     \\
  91         .type    ldso_stub__ ## fct,@function ; \\
  92 ldso_stub__ ## fct: ;                           \\
  93         b fct ;                                 \\
  94 .L ## fct ## e1: ;                              \\
  95         .size    ldso_stub__ ## fct,.L ## fct ## e1-ldso_stub__ ## fct ;"
  96
  97 #!+(and darwin ppc) "
  98 #define LDSO_STUBIFY(fct)                       @\\
  99 .text                                           @\\
 100 .globl  ldso_stub___ ## fct                     @\\
 101 ldso_stub___ ## fct:                            @\\
 102         b ldso_stub__ ## fct ## stub            @\\
 103 .symbol_stub ldso_stub__ ## fct ## stub:        @\\
 104 .indirect_symbol _ ## fct                       @\\
 105         lis     r11,ha16(ldso_stub__ ## fct ## $lazy_ptr)       @\\
 106         lwz     r12,lo16(ldso_stub__ ## fct ## $lazy_ptr)(r11)  @\\
 107         mtctr   r12                             @\\
 108         addi    r11,r11,lo16(ldso_stub__ ## fct ## $lazy_ptr)   @\\
 109         bctr                                    @\\
 110 .lazy_symbol_pointer                            @\\
 111 ldso_stub__ ## fct ## $lazy_ptr:                @\\
 112         .indirect_symbol _ ## fct               @\\
 113         .long dyld_stub_binding_helper"
 114
 115 ;;; darwin x86 assembler is weird and follows the ppc assembler syntax
 116 #!+(and darwin x86) "
 117 #define LDSO_STUBIFY(fct)                       \\
 118 .text                           ;               \\
 119         .align 4 ;                              \\
 120 .globl ldso_stub___ ## fct ;                    \\
 121 ldso_stub___ ## fct: ;                          \\
 122         jmp L ## fct ## $stub ;                 \\
 123         .section __IMPORT,__jump_table,symbol_stubs,self_modifying_code+pure_instructions,5 ;   \\
 124 L ## fct ## $stub: ;                    \\
 125         .indirect_symbol _ ## fct ;     \\
 126         hlt                       ;     \\
 127         hlt                       ;     \\
 128         hlt                       ;     \\
 129         hlt                       ;     \\
 130         hlt                       ;     \\
 131         .subsections_via_symbols  ;    "
 132
 133 ;;; KLUDGE: set up the vital fifth argument, passed on the
 134 ;;; stack.  Do this unconditionally, even if the stub is for a
 135 ;;; function with few arguments: it can't hurt.  We only do this for
 136 ;;; the fifth argument, as the first four are passed in registers
 137 ;;; and we apparently don't ever need to pass six arguments to a
 138 ;;; libc function.  -- CSR, 2003-10-29
 139 ;;; Expanded to 8 arguments regardless.  -- ths, 2005-03-24
 140 #!+mips "
 141 #define LDSO_STUBIFY(fct)                      \\
 142         .globl  ldso_stub__ ## fct ;           \\
 143         .type   ldso_stub__ ## fct,@function ; \\
 144         .ent    ldso_stub__ ## fct ;           \\
 145 ldso_stub__ ## fct: ;                  \\
 146         .set noat ;                    \\
 147         addiu $29,-48 ;                \\
 148         sw $28,40($29) ;               \\
 149         sw $31,44($29) ;               \\
 150         lw $25,64($29) ;               \\
 151         lw  $1,68($29) ;               \\
 152         sw $25,16($29) ;               \\
 153         sw  $1,20($29) ;               \\
 154         lw $25,72($29) ;               \\
 155         lw  $1,76($29) ;               \\
 156         sw $25,24($29) ;               \\
 157         sw  $1,28($29) ;               \\
 158         .set at ;                      \\
 159         la $25, fct ;                  \\
 160         jalr $25 ;                     \\
 161         lw $31,44($29) ;               \\
 162         lw $28,40($29) ;               \\
 163         addiu $29,48 ;                 \\
 164         jr $31 ;                       \\
 165         .end    ldso_stub__ ## fct ;   \\
 166         .size   ldso_stub__ ## fct,.-ldso_stub__ ## fct ;"))
 167
 168 (defvar *stubs* (append
 169                  '("accept"
 170                    "access"
 171                    "acos"
 172                    "acosh"
 173                    "asin"
 174                    "asinh"
 175                    "atanh"
 176                    "bind"
 177                    "cfgetispeed"
 178                    "cfgetospeed"
 179                    "cfsetispeed"
 180                    "cfsetospeed"
 181                    "chmod"
 182                    "chown"
 183                    "close"
 184                    "closedir"
 185                    "connect"
 186                    "cosh"
 187                    "creat"
 188                    "dup"
 189                    "dup2"
 190                    "execve"
 191                    "exit"
 192                    "fchmod"
 193                    "fchown"
 194                    "fcntl"
 195                    "fork"
 196                    "free"
 197                    "fstat"
 198                    "fsync"
 199                    "ftruncate"
 200                    "getcwd"
 201                    "getdtablesize"
 202                    "getegid"
 203                    "getenv"
 204                    "getgid"
 205                    "gethostbyaddr"
 206                    "gethostbyname"
 207                    "gethostname"
 208                    "getitimer"
 209                    "getpagesize"
 210                    "getpeername"
 211                    "getpgrp"
 212                    "getpid"
 213                    "getppid"
 214                    "getrusage"
 215                    "getsockname"
 216                    "gettimeofday"
 217                    "getuid"
 218                    "hypot"
 219                    "ioctl"
 220                    "isatty"
 221                    "kill"
 222                    "killpg"
 223                    "link"
 224                    "listen"
 225                    "log1p"
 226                    "lseek"
 227                    "lstat"
 228                    "malloc"
 229                    "memmove"
 230                    "mkdir"
 231                    "nanosleep"
 232                    "nl_langinfo"
 233                    "open"
 234                    "opendir"
 235                    "pipe"
 236                    "pow"
 237                    "read"
 238                    "readdir"
 239                    "readlink"
 240                    "recv"
 241                    "rename"
 242                    "rmdir"
 243                    "select"
 244                    "send"
 245                    "setitimer"
 246                    "setpgrp"
 247                    "setsid"
 248                    "sinh"
 249                    "socket"
 250                    "stat"
 251                    "strerror"
 252                    "strlen"
 253                    "symlink"
 254                    "sync"
 255                    "tanh"
 256                    "tcdrain"
 257                    "tcflow"
 258                    "tcflush"
 259                    "tcgetattr"
 260                    "tcsendbreak"
 261                    "tcsetattr"
 262                    "truncate"
 263                    "ttyname"
 264                    "tzname"
 265                    "unlink"
 266                    "utimes"
 267                    "wait3"
 268                    "write")
 269                  ;; These aren't needed on the X86 because they're microcoded into the
 270                  ;; FPU, so the Lisp VOPs can implement them directly without having to
 271                  ;; call C code.
 272                  ;;
 273                  ;; Note: There might be some other functions in this category as well.
 274                  ;; E.g. I notice tanh() and acos() in the list above.. -- WHN 2001-06-07
 275                  #!-x86
 276                  '("sin"
 277                    "cos"
 278                    "tan"
 279                    "atan"
 280                    "atan2"
 281                    "exp"
 282                    "log"
 283                    "log10"
 284                    "sqrt")
 285                  #!+alpha
 286                  '("ieee_get_fp_control"
 287                    "ieee_set_fp_control")
 288                  ;; FIXME: After 1.0 this should be made
 289                  ;; #!-linkage-table, as we only need these stubs if
 290                  ;; we don't have linkage-table. Done this way now to
 291                  ;; cut down on the number of ports affected.
 292                  #!-(or win32 darwin freebsd)
 293                  '("ptsname"
 294                    "grantpt"
 295                    "unlockpt")
 296                  #!-darwin
 297                  '("dlclose"
 298                    "dlerror"
 299                    "dlopen"
 300                    "dlsym")
 301                  #!+os-provides-dladdr
 302                  '("dladdr")
 303                  #!-sunos ;; !defined(SVR4)
 304                  '("sigsetmask")))
 305
 306 (with-open-file (f "src/runtime/ldso-stubs.S" :direction :output :if-exists :supersede)
 307   (assert (= (length *preludes*) 2))
 308   (dolist (pre *preludes*)
 309     (write-line pre f))
 310   (dolist (stub *stubs*)
 311     (check-type stub string)
 312     (ldso-stubify stub f)))
 313