operate.lisp 14.1 KB
Newer Older
1 2
;;;; -------------------------------------------------------------------------
;;;; Invoking Operations
3

4
(uiop/package:define-package :asdf/operate
5
  (:recycle :asdf/operate :asdf)
6
  (:use :uiop/common-lisp :uiop :asdf/upgrade :asdf/session
7
        :asdf/component :asdf/system :asdf/system-registry :asdf/find-component
8
        :asdf/operation :asdf/action :asdf/lisp-action :asdf/forcing :asdf/plan)
9
  (:export
10
   #:operate #:oos #:build-op #:make
11
   #:load-system #:load-systems #:load-systems*
12
   #:compile-system #:test-system #:require-system #:module-provide-asdf
13
   #:component-loaded-p #:already-loaded-systems))
14 15
(in-package :asdf/operate)

16
(with-upgradability ()
17
  (defgeneric operate (operation component &key)
18
    (:documentation
19
     "Operate does mainly four things for the user:
20

21 22 23 24 25 26
1. Resolves the OPERATION designator into an operation object.
   OPERATION is typically a symbol denoting an operation class, instantiated with MAKE-OPERATION.
2. Resolves the COMPONENT designator into a component object.
   COMPONENT is typically a string or symbol naming a system, loaded from disk using FIND-SYSTEM.
3. It then calls MAKE-PLAN with the operation and system as arguments.
4. Finally calls PERFORM-PLAN on the resulting plan to actually build the system.
27

28 29 30 31
The entire computation is wrapped in WITH-COMPILATION-UNIT and error handling code.
If a VERSION argument is supplied, then operate also ensures that the system found satisfies it
using the VERSION-SATISFIES method.
If a PLAN-CLASS argument is supplied, that class is used for the plan.
32
If a PLAN-OPTIONS argument is supplied, the options are passed to the plan.
33 34 35 36 37 38

The :FORCE or :FORCE-NOT argument to OPERATE can be:
  T to force the inside of the specified system to be rebuilt (resp. not),
    without recursively forcing the other systems we depend on.
  :ALL to force all systems including other systems we depend on to be rebuilt (resp. not).
  (SYSTEM1 SYSTEM2 ... SYSTEMN) to force systems named in a given list
39 40 41 42 43
:FORCE-NOT has precedence over :FORCE; builtin systems cannot be forced.

For backward compatibility, all keyword arguments are passed to MAKE-OPERATION
when instantiating a new operation, that will in turn be inherited by new operations.
But do NOT depend on it, for this is deprecated behavior."))
44

45 46
  (define-convenience-action-methods operate (operation component &key)
    :if-no-component (error 'missing-component :requires component))
47

48 49 50
  ;; This method ensures that an ASDF upgrade is attempted as the very first thing,
  ;; with suitable state preservation in case in case it actually happens,
  ;; and that a few suitable dynamic bindings are established.
51 52 53
  (defmethod operate :around (operation component &rest keys
                              &key verbose
                                (on-warnings *compile-file-warnings-behaviour*)
54
                                (on-failure *compile-file-failure-behaviour*))
55
    (nest
56
     (with-asdf-session ())
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
     (let* ((operation-remaker ;; how to remake the operation after ASDF was upgraded (if it was)
             (etypecase operation
               (operation (let ((name (type-of operation)))
                            #'(lambda () (make-operation name))))
               ((or symbol string) (constantly operation))))
            (component-path (typecase component ;; to remake the component after ASDF upgrade
                              (component (component-find-path component))
                              (t component)))
            (system-name (labels ((first-name (x)
                                    (etypecase x
                                      ((or string symbol) x) ; NB: includes the NIL case.
                                      (cons (or (first-name (car x)) (first-name (cdr x)))))))
                           (coerce-name (first-name component-path)))))
       (apply 'make-forcing :performable-p t :system system-name keys)
       ;; Before we operate on any system, make sure ASDF is up-to-date,
       ;; for if an upgrade is ever attempted at any later time, there may be BIG trouble.
73 74
       (unless (asdf-upgraded-p (toplevel-asdf-session))
         (setf (asdf-upgraded-p (toplevel-asdf-session)) t)
75 76
         (when (upgrade-asdf)
           ;; If we were upgraded, restart OPERATE the hardest of ways, for
77
           ;; its function may have been redefined.
78
           (return-from operate
79
             (with-asdf-session (:override t :override-cache t)
80
               (apply 'operate (funcall operation-remaker) component-path keys))))))
81
      ;; Setup proper bindings around any operate call.
82 83
     (let* ((*verbose-out* (and verbose *standard-output*))
            (*compile-file-warnings-behaviour* on-warnings)
84
            (*compile-file-failure-behaviour* on-failure)))
85 86 87 88 89
     (unwind-protect
          (progn
            (incf (operate-level))
            (call-next-method))
       (decf (operate-level)))))
90 91

  (defmethod operate :before ((operation operation) (component component)
92
                              &key version)
93
    (unless (version-satisfies component version)
94
      (error 'missing-component-of-version :requires component :version version))
95 96
    (record-dependency nil operation component))

97
  (defmethod operate ((operation operation) (component component)
98 99 100 101
                      &key plan-class plan-options)
    (let ((plan (apply 'make-plan plan-class operation component
                       :forcing (forcing *asdf-session*) plan-options)))
      (perform-plan plan)
102
      (values operation plan)))
103 104 105 106 107 108 109

  (defun oos (operation component &rest args &key &allow-other-keys)
    (apply 'operate operation component args))

  (setf (documentation 'oos 'function)
        (format nil "Short for _operate on system_ and an alias for the OPERATE function.~%~%~a"
                (documentation 'operate 'function))))
110 111 112


;;;; Common operations
113
(when-upgrading ()
114
  (defmethod component-depends-on ((o prepare-op) (s system))
115 116
    (call-next-method)))
(with-upgradability ()
117
  (defclass build-op (non-propagating-operation) ()
118 119 120 121 122
    (:documentation "Since ASDF3, BUILD-OP is the recommended 'master' operation,
to operate by default on a system or component, via the function BUILD.
Its meaning is configurable via the :BUILD-OPERATION option of a component.
which typically specifies the name of a specific operation to which to delegate the build,
as a symbol or as a string later read as a symbol (after loading the defsystem-depends-on);
123 124
if NIL is specified (the default), BUILD-OP falls back to LOAD-OP,
that will load the system in the current image."))
125
  (defmethod component-depends-on ((o build-op) (c component))
126
    `((,(or (component-build-operation c) 'load-op) ,c)
127
      ,@(call-next-method)))
128

129 130
  (defun make (system &rest keys)
    "The recommended way to interact with ASDF3.1 is via (ASDF:MAKE :FOO).
131 132
It will build system FOO using the operation BUILD-OP,
the meaning of which is configurable by the system, and
133
defaults to LOAD-OP, to load it in current image."
134 135
    (apply 'operate 'build-op system keys)
    t)
136

137 138 139
  (defun load-system (system &rest keys &key force force-not verbose version &allow-other-keys)
    "Shorthand for `(operate 'asdf:load-op system)`. See OPERATE for details."
    (declare (ignore force force-not verbose version))
140
    (apply 'operate 'load-op system keys)
141
    t)
142

143 144 145 146
  (defun load-systems* (systems &rest keys)
    "Loading multiple systems at once."
    (dolist (s systems) (apply 'load-system s keys)))

147 148
  (defun load-systems (&rest systems)
    "Loading multiple systems at once."
149
    (load-systems* systems))
150

151 152 153 154 155
  (defun compile-system (system &rest args &key force force-not verbose version &allow-other-keys)
    "Shorthand for `(asdf:operate 'asdf:compile-op system)`. See OPERATE for details."
    (declare (ignore force force-not verbose version))
    (apply 'operate 'compile-op system args)
    t)
156

157 158 159 160 161
  (defun test-system (system &rest args &key force force-not verbose version &allow-other-keys)
    "Shorthand for `(asdf:operate 'asdf:test-op system)`. See OPERATE for details."
    (declare (ignore force force-not verbose version))
    (apply 'operate 'test-op system args)
    t))
162

163 164
;;;;; Define the function REQUIRE-SYSTEM, that, similarly to REQUIRE,
;; only tries to load its specified target if it's not loaded yet.
165
(with-upgradability ()
166
  (defun component-loaded-p (component)
Robert Goldman's avatar
Robert Goldman committed
167
    "Has the given COMPONENT been successfully loaded in the current image (yet)?
168
Note that this returns true even if the component is not up to date."
169
    (if-let ((component (find-component component () :registered t)))
170
      (nth-value 1 (component-operation-time (make-operation 'load-op) component))))
171 172

  (defun already-loaded-systems ()
173
    "return a list of the names of the systems that have been successfully loaded so far"
174
    (mapcar 'coerce-name (remove-if-not 'component-loaded-p (registered-systems*))))
175

176
  (defun require-system (system &rest keys &key &allow-other-keys)
Robert Goldman's avatar
Robert Goldman committed
177
    "Ensure the specified SYSTEM is loaded, passing the KEYS to OPERATE, but do not update the
178
system or its dependencies if they have already been loaded."
179 180
    (unless (component-loaded-p system)
      (apply 'load-system system :force-not (already-loaded-systems) keys))))
181

182

183 184
;;;; Define the class REQUIRE-SYSTEM, to be hooked into CL:REQUIRE when possible,
;; i.e. for ABCL, CLISP, ClozureCL, CMUCL, ECL, MKCL and SBCL
185 186
;; Note that despite the two being homonyms, the _function_ require-system
;; and the _class_ require-system are quite distinct entities, fulfilling independent purposes.
187
(with-upgradability ()
188 189 190
  (defvar *modules-being-required* nil)

  (defclass require-system (system)
191 192 193
    ((module :initarg :module :initform nil :accessor required-module))
    (:documentation "A SYSTEM subclass whose processing is handled by
the implementation's REQUIRE rather than by internal ASDF mechanisms."))
194 195 196 197 198 199 200 201

  (defmethod perform ((o compile-op) (c require-system))
    nil)

  (defmethod perform ((o load-op) (s require-system))
    (let* ((module (or (required-module s) (coerce-name s)))
           (*modules-being-required* (cons module *modules-being-required*)))
      (assert (null (component-children s)))
202
      (require module)))
203 204

  (defmethod resolve-dependency-combination (component (combinator (eql :require)) arguments)
205
    (unless (and (length=n-p arguments 1)
Robert Goldman's avatar
Robert Goldman committed
206
                 (typep (car arguments) '(or string (and symbol (not null)))))
207 208 209
      (parameter-error (compatfmt "~@<In ~S, bad dependency ~S for ~S. ~S takes one argument, a string or non-null symbol~@:>")
                       'resolve-dependency-combination
                       (cons combinator arguments) component combinator))
210 211 212 213 214 215
    ;; :require must be prepared for some implementations providing modules using ASDF,
    ;; as SBCL used to do, and others may might do. Thus, the system provided in the end
    ;; would be a downcased name as per module-provide-asdf above. For the same reason,
    ;; we cannot assume that the system in the end will be of type require-system,
    ;; but must check whether we can use find-system and short-circuit cl:require.
    ;; Otherwise, calling cl:require could result in nasty reentrant calls between
216 217
    ;; cl:require and asdf:operate that could potentially blow up the stack,
    ;; all the while defeating the consistency of the dependency graph.
218
    (let* ((module (car arguments)) ;; NB: we already checked that it was not null
219 220 221 222 223
           ;; CMUCL, MKCL, SBCL like their module names to be all upcase.
           (module-name (string module))
           (system-name (string-downcase module))
           (system (find-system system-name nil)))
      (or system (let ((system (make-instance 'require-system :name system-name :module module-name)))
224 225
                   (register-system system)
                   system))))
226

227
  (defun module-provide-asdf (name)
228 229 230 231 232
    ;; We must use string-downcase, because modules are traditionally specified as symbols,
    ;; that implementations traditionally normalize as uppercase, for which we seek a system
    ;; with a name that is traditionally in lowercase. Case is lost along the way. That's fine.
    ;; We could make complex, non-portable rules to try to preserve case, and just documenting
    ;; them would be a hell that it would be a disservice to inflict on users.
233 234 235 236 237
    (let ((module-name (string name))
          (system-name (string-downcase name)))
      (unless (member module-name *modules-being-required* :test 'equal)
        (let ((*modules-being-required* (cons module-name *modules-being-required*))
              #+sbcl (sb-impl::*requiring* (remove module-name sb-impl::*requiring* :test 'equal)))
238 239 240
          (handler-bind
              ((style-warning #'muffle-warning)
               (missing-component (constantly nil))
241
               (fatal-condition
Robert Goldman's avatar
Robert Goldman committed
242 243 244
                #'(lambda (e)
                    (format *error-output* (compatfmt "~@<ASDF could not load ~(~A~) because ~A.~@:>~%")
                            name e))))
245
            (let ((*verbose-out* (make-broadcast-stream)))
246
              (let ((system (find-system system-name nil)))
247
                (when system
248 249 250 251 252
                  ;; Do not use require-system after all, use load-system:
                  ;; on the one hand, REQUIRE already uses *MODULES* not to load something twice,
                  ;; on the other hand, REQUIRE-SYSTEM uses FORCE-NOT which may conflict with
                  ;; the toplevel session forcing settings.
                  (load-system system :verbose nil)
253
                  t)))))))))
254

255 256

;;;; Some upgrade magic
257 258 259
(with-upgradability ()
  (defun restart-upgraded-asdf ()
    ;; If we're in the middle of something, restart it.
260
    (let ((systems-being-defined
261
           (when *asdf-session*
262
             (prog1
263
                 (loop :for k :being :the hash-keys :of (asdf-cache)
264
                   :when (eq (first k) 'find-system) :collect (second k))
265
               (clrhash (asdf-cache))))))
266 267
      ;; Regardless, clear defined systems, since they might be invalid
      ;; after an incompatible ASDF upgrade.
268
      (clear-registered-systems)
269 270 271 272
      ;; The configuration also may have to be upgraded.
      (upgrade-configuration)
      ;; If we were in the middle of an operation, be sure to restore the system being defined.
      (dolist (s systems-being-defined) (find-system s nil))))
273
  (register-hook-function '*post-upgrade-cleanup-hook* 'restart-upgraded-asdf))