src/compiler/early-c.lisp

   1 ;;;; This file contains compiler code and compiler-related stuff which
   2 ;;;; can be built early on. Some of the stuff may be here because it's
   3 ;;;; needed early on, some other stuff (e.g. constants) just because
   4 ;;;; it might as well be done early so we don't have to think about
   5 ;;;; whether it's done early enough.
   6
   7 ;;;; This software is part of the SBCL system. See the README file for
   8 ;;;; more information.
   9 ;;;;
  10 ;;;; This software is derived from the CMU CL system, which was
  11 ;;;; written at Carnegie Mellon University and released into the
  12 ;;;; public domain. The software is in the public domain and is
  13 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  14 ;;;; files for more information.
  15
  16 (in-package "SB!C")
  17
  18 ;;; ANSI limits on compilation
  19 (def!constant sb!xc:call-arguments-limit sb!xc:most-positive-fixnum
  20   #!+sb-doc
  21   "The exclusive upper bound on the number of arguments which may be passed
  22   to a function, including &REST args.")
  23 (def!constant sb!xc:lambda-parameters-limit sb!xc:most-positive-fixnum
  24   #!+sb-doc
  25   "The exclusive upper bound on the number of parameters which may be specifed
  26   in a given lambda list. This is actually the limit on required and &OPTIONAL
  27   parameters. With &KEY and &AUX you can get more.")
  28 (def!constant sb!xc:multiple-values-limit sb!xc:most-positive-fixnum
  29   #!+sb-doc
  30   "The exclusive upper bound on the number of multiple VALUES that you can
  31   return.")
  32 \f
  33 ;;;; cross-compiler-only versions of CL special variables, so that we
  34 ;;;; don't have weird interactions with the host compiler
  35
  36 (defvar sb!xc:*compile-file-pathname*)
  37 (defvar sb!xc:*compile-file-truename*)
  38 (defvar sb!xc:*compile-print*)
  39 (defvar sb!xc:*compile-verbose*)
  40 \f
  41 ;;;; miscellaneous types used both in the cross-compiler and on the target
  42
  43 ;;;; FIXME: The INDEX and LAYOUT-DEPTHOID definitions probably belong
  44 ;;;; somewhere else, not "early-c", since they're after all not part
  45 ;;;; of the compiler.
  46
  47 ;;; the type of LAYOUT-DEPTHOID slot values
  48 (def!type sb!kernel::layout-depthoid () '(or index (integer -1 -1)))
  49 \f
  50 ;;; possible values for the INLINE-ness of a function.
  51 (deftype inlinep ()
  52   '(member :inline :maybe-inline :notinline nil))
  53 (defparameter *inlinep-translations*
  54   '((inline . :inline)
  55     (notinline . :notinline)
  56     (maybe-inline . :maybe-inline)))
  57
  58 ;;; the lexical environment we are currently converting in
  59 (defvar *lexenv*)
  60 (declaim (type lexenv *lexenv*))
  61
  62 ;;; *FREE-VARS* translates from the names of variables referenced
  63 ;;; globally to the LEAF structures for them. *FREE-FUNS* is like
  64 ;;; *FREE-VARS*, only it deals with function names.
  65 (defvar *free-vars*)
  66 (defvar *free-funs*)
  67 (declaim (type hash-table *free-vars* *free-funs*))
  68
  69 ;;; We use the same CONSTANT structure to represent all equal anonymous
  70 ;;; constants. This hashtable translates from constants to the LEAFs that
  71 ;;; represent them.
  72 (defvar *constants*)
  73 (declaim (type hash-table *constants*))
  74
  75 ;;; *ALLOW-INSTRUMENTING* controls whether we should allow the
  76 ;;; insertion of instrumenting code (like a (CATCH ...)) around code
  77 ;;; to allow the debugger RETURN and STEP commands to function (we
  78 ;;; disallow it for internal stuff).
  79 (defvar *allow-instrumenting*)
  80
  81 ;;; miscellaneous forward declarations
  82 (defvar *code-segment*)
  83 #!+sb-dyncount (defvar *collect-dynamic-statistics*)
  84 (defvar *component-being-compiled*)
  85 (defvar *compiler-error-context*)
  86 (defvar *compiler-error-count*)
  87 (defvar *compiler-warning-count*)
  88 (defvar *compiler-style-warning-count*)
  89 (defvar *compiler-note-count*)
  90 (defvar *compiler-trace-output*)
  91 (defvar *constraint-universe*)
  92 (defvar *count-vop-usages*)
  93 (defvar *current-path*)
  94 (defvar *current-component*)
  95 (defvar *delayed-ir1-transforms*)
  96 (defvar *handled-conditions*)
  97 (defvar *disabled-package-locks*)
  98 (defvar *policy*)
  99 (defvar *dynamic-counts-tn*)
 100 (defvar *elsewhere*)
 101 (defvar *event-info*)
 102 (defvar *event-note-threshold*)
 103 (defvar *failure-p*)
 104 (defvar *fixup-notes*)
 105 (defvar *in-pack*)
 106 (defvar *info-environment*)
 107 #!+inline-constants
 108 (progn
 109   (defvar *constant-segment*)
 110   (defvar *constant-table*)
 111   (defvar *constant-vector*))
 112 (defvar *lexenv*)
 113 (defvar *source-info*)
 114 (defvar *source-plist*)
 115 (defvar *trace-table*)
 116 (defvar *undefined-warnings*)
 117 (defvar *warnings-p*)
 118 (defvar *lambda-conversions*)
 119
 120 (defvar *stack-allocate-dynamic-extent* t
 121   "If true (the default), the compiler respects DYNAMIC-EXTENT declarations
 122 and stack allocates otherwise inaccessible parts of the object whenever
 123 possible. Potentially long (over one page in size) vectors are, however, not
 124 stack allocated except in zero SAFETY code, as such a vector could overflow
 125 the stack without triggering overflow protection.")
 126
 127 (!begin-collecting-cold-init-forms)
 128 ;;; This lock is seized in the compiler, and related areas -- like the
 129 ;;; classoid/layout/class system.
 130 (defglobal **world-lock** nil)
 131 (!cold-init-forms
 132  (setf **world-lock** (sb!thread:make-mutex :name "World Lock")))
 133 (!defun-from-collected-cold-init-forms !world-lock-cold-init)
 134
 135 (defmacro with-world-lock (() &body body)
 136   `(sb!thread:with-recursive-lock (**world-lock**)
 137      ,@body))
 138
 139 (declaim (type fixnum *compiler-sset-counter*))
 140 (defvar *compiler-sset-counter* 0)
 141
 142 ;;; unique ID for the next object created (to let us track object
 143 ;;; identity even across GC, useful for understanding weird compiler
 144 ;;; bugs where something is supposed to be unique but is instead
 145 ;;; exists as duplicate objects)
 146 #!+sb-show
 147 (progn
 148   (defvar *object-id-counter* 0)
 149   (defun new-object-id ()
 150     (prog1
 151         *object-id-counter*
 152       (incf *object-id-counter*))))
 153 \f
 154 ;;;; miscellaneous utilities
 155
 156 ;;; Delete any undefined warnings for NAME and KIND. This is for the
 157 ;;; benefit of the compiler, but it's sometimes called from stuff like
 158 ;;; type-defining code which isn't logically part of the compiler.
 159 (declaim (ftype (function ((or symbol cons) keyword) (values))
 160                 note-name-defined))
 161 (defun note-name-defined (name kind)
 162   ;; We do this BOUNDP check because this function can be called when
 163   ;; not in a compilation unit (as when loading top level forms).
 164   (when (boundp '*undefined-warnings*)
 165     (setq *undefined-warnings*
 166           (delete-if (lambda (x)
 167                        (and (equal (undefined-warning-name x) name)
 168                             (eq (undefined-warning-kind x) kind)))
 169                      *undefined-warnings*)))
 170   (values))
 171
 172 ;;; to be called when a variable is lexically bound
 173 (declaim (ftype (function (symbol) (values)) note-lexical-binding))
 174 (defun note-lexical-binding (symbol)
 175     ;; This check is intended to protect us from getting silently
 176     ;; burned when we define
 177     ;;   foo.lisp:
 178     ;;     (DEFVAR *FOO* -3)
 179     ;;     (DEFUN FOO (X) (+ X *FOO*))
 180     ;;   bar.lisp:
 181     ;;     (DEFUN BAR (X)
 182     ;;       (LET ((*FOO* X))
 183     ;;         (FOO 14)))
 184     ;; and then we happen to compile bar.lisp before foo.lisp.
 185   (when (looks-like-name-of-special-var-p symbol)
 186     ;; FIXME: should be COMPILER-STYLE-WARNING?
 187     (style-warn 'sb!kernel:asterisks-around-lexical-variable-name
 188                 :format-control
 189                 "using the lexical binding of the symbol ~S, not the~@
 190                  dynamic binding"
 191                 :format-arguments (list symbol)))
 192   (values))
 193
 194 (def!struct (debug-name-marker (:make-load-form-fun dump-debug-name-marker)
 195                                (:print-function print-debug-name-marker)))
 196
 197 (defvar *debug-name-level* 4)
 198 (defvar *debug-name-length* 12)
 199 (defvar *debug-name-punt*)
 200 (defvar *debug-name-sharp*)
 201 (defvar *debug-name-ellipsis*)
 202
 203 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
 204   (defun dump-debug-name-marker (marker &optional env)
 205     (declare (ignore env))
 206     (cond ((eq marker *debug-name-sharp*)
 207            `(if (boundp '*debug-name-sharp*)
 208                 *debug-name-sharp*
 209                 (make-debug-name-marker)))
 210           ((eq marker *debug-name-ellipsis*)
 211            `(if (boundp '*debug-name-ellipsis*)
 212                 *debug-name-ellipsis*
 213                 (make-debug-name-marker)))
 214           (t
 215            (warn "Dumping unknown debug-name marker.")
 216            '(make-debug-name-marker)))))
 217
 218 (defun print-debug-name-marker (marker stream level)
 219   (declare (ignore level))
 220   (cond ((eq marker *debug-name-sharp*)
 221          (write-char #\# stream))
 222         ((eq marker *debug-name-ellipsis*)
 223          (write-string "..." stream))
 224         (t
 225          (write-string "???" stream))))
 226
 227 (setf *debug-name-sharp* (make-debug-name-marker)
 228       *debug-name-ellipsis* (make-debug-name-marker))
 229
 230 (defun debug-name (type thing)
 231   (let ((*debug-name-punt* nil))
 232     (labels ((walk (x)
 233                (typecase x
 234                  (cons
 235                   (if (plusp *debug-name-level*)
 236                       (let ((*debug-name-level* (1- *debug-name-level*)))
 237                         (do ((tail (cdr x) (cdr tail))
 238                              (name (cons (walk (car x)) nil)
 239                                    (cons (walk (car tail)) name))
 240                              (n (1- *debug-name-length*) (1- n)))
 241                             ((or (not (consp tail))
 242                                  (not (plusp n))
 243                                  *debug-name-punt*)
 244                              (cond (*debug-name-punt*
 245                                     (setf *debug-name-punt* nil)
 246                                     (nreverse name))
 247                                    ((atom tail)
 248                                     (nconc (nreverse name) (walk tail)))
 249                                    (t
 250                                     (setf *debug-name-punt* t)
 251                                     (nconc (nreverse name) (list *debug-name-ellipsis*)))))))
 252                       *debug-name-sharp*))
 253                  ((or symbol number string)
 254                   x)
 255                  (t
 256                   (type-of x)))))
 257       (let ((name (list type (walk thing))))
 258         (when (legal-fun-name-p name)
 259           (bug "~S is a legal function name, and cannot be used as a ~
 260                 debug name." name))
 261         name))))