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 (defvar *lexenv*)
 108 (defvar *source-info*)
 109 (defvar *trace-table*)
 110 (defvar *undefined-warnings*)
 111 (defvar *warnings-p*)
 112 (defvar *lambda-conversions*)
 113
 114 (defvar *stack-allocate-dynamic-extent* t
 115   "If true (the default), the compiler respects DYNAMIC-EXTENT declarations
 116 and stack allocates otherwise inaccessible parts of the object whenever
 117 possible. Potentially long (over one page in size) vectors are, however, not
 118 stack allocated except in zero SAFETY code, as such a vector could overflow
 119 the stack without triggering overflow protection.")
 120
 121 ;;; This lock is seized in the compiler, and related areas: the
 122 ;;; compiler is not presently thread-safe
 123 (defvar *big-compiler-lock*
 124   (sb!thread:make-mutex :name "big compiler lock"))
 125
 126 (declaim (type fixnum *compiler-sset-counter*))
 127 (defvar *compiler-sset-counter* 0)
 128
 129 ;;; unique ID for the next object created (to let us track object
 130 ;;; identity even across GC, useful for understanding weird compiler
 131 ;;; bugs where something is supposed to be unique but is instead
 132 ;;; exists as duplicate objects)
 133 #!+sb-show
 134 (progn
 135   (defvar *object-id-counter* 0)
 136   (defun new-object-id ()
 137     (prog1
 138         *object-id-counter*
 139       (incf *object-id-counter*))))
 140 \f
 141 ;;;; miscellaneous utilities
 142
 143 ;;; Delete any undefined warnings for NAME and KIND. This is for the
 144 ;;; benefit of the compiler, but it's sometimes called from stuff like
 145 ;;; type-defining code which isn't logically part of the compiler.
 146 (declaim (ftype (function ((or symbol cons) keyword) (values))
 147                 note-name-defined))
 148 (defun note-name-defined (name kind)
 149   ;; We do this BOUNDP check because this function can be called when
 150   ;; not in a compilation unit (as when loading top level forms).
 151   (when (boundp '*undefined-warnings*)
 152     (setq *undefined-warnings*
 153           (delete-if (lambda (x)
 154                        (and (equal (undefined-warning-name x) name)
 155                             (eq (undefined-warning-kind x) kind)))
 156                      *undefined-warnings*)))
 157   (values))
 158
 159 ;;; to be called when a variable is lexically bound
 160 (declaim (ftype (function (symbol) (values)) note-lexical-binding))
 161 (defun note-lexical-binding (symbol)
 162     ;; This check is intended to protect us from getting silently
 163     ;; burned when we define
 164     ;;   foo.lisp:
 165     ;;     (DEFVAR *FOO* -3)
 166     ;;     (DEFUN FOO (X) (+ X *FOO*))
 167     ;;   bar.lisp:
 168     ;;     (DEFUN BAR (X)
 169     ;;       (LET ((*FOO* X))
 170     ;;         (FOO 14)))
 171     ;; and then we happen to compile bar.lisp before foo.lisp.
 172   (when (looks-like-name-of-special-var-p symbol)
 173     ;; FIXME: should be COMPILER-STYLE-WARNING?
 174     (style-warn 'sb!kernel:asterisks-around-lexical-variable-name
 175                 :format-control
 176                 "using the lexical binding of the symbol ~S, not the~@
 177                  dynamic binding"
 178                 :format-arguments (list symbol)))
 179   (values))
 180
 181 (def!struct (debug-name-marker (:make-load-form-fun dump-debug-name-marker)
 182                                (:print-function print-debug-name-marker)))
 183
 184 (defvar *debug-name-level* 4)
 185 (defvar *debug-name-length* 12)
 186 (defvar *debug-name-punt*)
 187 (defvar *debug-name-sharp*)
 188 (defvar *debug-name-ellipsis*)
 189
 190 (eval-when (:compile-toplevel :load-toplevel :execute)
 191   (defun dump-debug-name-marker (marker &optional env)
 192     (declare (ignore env))
 193     (cond ((eq marker *debug-name-sharp*)
 194            `(if (boundp '*debug-name-sharp*)
 195                 *debug-name-sharp*
 196                 (make-debug-name-marker)))
 197           ((eq marker *debug-name-ellipsis*)
 198            `(if (boundp '*debug-name-ellipsis*)
 199                 *debug-name-ellipsis*
 200                 (make-debug-name-marker)))
 201           (t
 202            (warn "Dumping unknown debug-name marker.")
 203            '(make-debug-name-marker)))))
 204
 205 (defun print-debug-name-marker (marker stream level)
 206   (declare (ignore level))
 207   (cond ((eq marker *debug-name-sharp*)
 208          (write-char #\# stream))
 209         ((eq marker *debug-name-ellipsis*)
 210          (write-string "..." stream))
 211         (t
 212          (write-string "???" stream))))
 213
 214 (setf *debug-name-sharp* (make-debug-name-marker)
 215       *debug-name-ellipsis* (make-debug-name-marker))
 216
 217 (defun debug-name (type thing)
 218   (let ((*debug-name-punt* nil))
 219     (labels ((walk (x)
 220                (typecase x
 221                  (cons
 222                   (if (plusp *debug-name-level*)
 223                       (let ((*debug-name-level* (1- *debug-name-level*)))
 224                         (do ((tail (cdr x) (cdr tail))
 225                              (name (cons (walk (car x)) nil)
 226                                    (cons (walk (car tail)) name))
 227                              (n (1- *debug-name-length*) (1- n)))
 228                             ((or (not (consp tail))
 229                                  (not (plusp n))
 230                                  *debug-name-punt*)
 231                              (cond (*debug-name-punt*
 232                                     (setf *debug-name-punt* nil)
 233                                     (nreverse name))
 234                                    ((atom tail)
 235                                     (nconc (nreverse name) (walk tail)))
 236                                    (t
 237                                     (setf *debug-name-punt* t)
 238                                     (nconc (nreverse name) (list *debug-name-ellipsis*)))))))
 239                       *debug-name-sharp*))
 240                  ((or symbol number string)
 241                   x)
 242                  (t
 243                   (type-of x)))))
 244       (let ((name (list type (walk thing))))
 245         (when (legal-fun-name-p name)
 246           (bug "~S is a legal function name, and cannot be used as a ~
 247                 debug name." name))
 248         name))))