operate.lisp 13.7 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/cache
7
8
   :asdf/component :asdf/system :asdf/operation :asdf/action
   :asdf/find-system :asdf/find-component :asdf/lisp-action :asdf/plan)
9
  (:export
10
   #:operate #:oos
11
   #:build-op #:make
12
13
   #:load-system #:load-systems #:load-systems*
   #:compile-system #:test-system #:require-system
14
   #:module-provide-asdf
15
   #:component-loaded-p #:already-loaded-systems))
16
17
(in-package :asdf/operate)

18
(with-upgradability ()
19
  (defgeneric operate (operation component &key &allow-other-keys)
20
    (:documentation
21
     "Operate does mainly four things for the user:
22

23
24
25
26
27
28
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.
29

30
31
32
33
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.
34
35
36
37
38
39

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
40
41
42
43
44
: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."))
45

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

49
50
  (defvar *in-operate* nil
    "Are we in operate?")
51

52
53
54
  ;; 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.
55
56
57
58
  (defmethod operate :around (operation component &rest keys
                              &key verbose
                                (on-warnings *compile-file-warnings-behaviour*)
                                (on-failure *compile-file-failure-behaviour*) &allow-other-keys)
59
60
61
62
    (nest
     (with-asdf-cache ())
     (let ((in-operate *in-operate*)
           (*in-operate* t)
63
           (operation-remaker ;; how to remake the operation after ASDF was upgraded (if it was)
64
            (etypecase operation
65
66
              (operation (let ((name (type-of operation)))
                           #'(lambda () (make-operation name))))
67
              ((or symbol string) (constantly operation))))
68
           (component-path (typecase component ;; to remake the component after ASDF upgrade
69
                             (component (component-find-path component))
70
71
72
73
74
75
76
                             (t component)))))
     ;; 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.
     (progn
       (unless in-operate
         (when (upgrade-asdf)
           ;; If we were upgraded, restart OPERATE the hardest of ways, for
77
           ;; its function may have been redefined.
78
79
           (return-from operate
             (apply 'operate (funcall operation-remaker) component-path keys)))))
80
      ;; Setup proper bindings around any operate call.
81
82
83
84
     (let* ((*verbose-out* (and verbose *standard-output*))
            (*compile-file-warnings-behaviour* on-warnings)
            (*compile-file-failure-behaviour* on-failure))
       (call-next-method))))
85
86
87
88
89
90
91

  (defmethod operate :before ((operation operation) (component component)
                              &key version &allow-other-keys)
    (unless (version-satisfies component version)
      (error 'missing-component-of-version :requires component :version version)))

  (defmethod operate ((operation operation) (component component)
92
93
                      &rest keys &key plan-class &allow-other-keys)
    (let ((plan (apply 'make-plan plan-class operation component keys)))
94
      (apply 'perform-plan plan keys)
95
      (values operation plan)))
96
97
98
99
100
101
102

  (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))))
103
104
105


;;;; Common operations
106
(when-upgrading ()
107
  (defmethod component-depends-on ((o prepare-op) (s system))
108
109
    (call-next-method)))
(with-upgradability ()
110
  (defclass build-op (non-propagating-operation) ()
111
112
113
114
115
    (: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);
116
117
if NIL is specified (the default), BUILD-OP falls back to LOAD-OP,
that will load the system in the current image."))
118
  (defmethod component-depends-on ((o build-op) (c component))
119
    `((,(or (component-build-operation c) 'load-op) ,c)
120
      ,@(call-next-method)))
121

122
123
  (defun make (system &rest keys)
    "The recommended way to interact with ASDF3.1 is via (ASDF:MAKE :FOO).
124
125
It will build system FOO using the operation BUILD-OP,
the meaning of which is configurable by the system, and
126
defaults to LOAD-OP, to load it in current image."
127
128
    (apply 'operate 'build-op system keys)
    t)
129

130
131
132
  (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))
133
    (apply 'operate 'load-op system keys)
134
    t)
135

136
137
138
139
  (defun load-systems* (systems &rest keys)
    "Loading multiple systems at once."
    (dolist (s systems) (apply 'load-system s keys)))

140
141
  (defun load-systems (&rest systems)
    "Loading multiple systems at once."
142
    (load-systems* systems))
143

144
145
146
147
148
  (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)
149

150
151
152
153
154
  (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))
155

156
157
;;;;; Define the function REQUIRE-SYSTEM, that, similarly to REQUIRE,
;; only tries to load its specified target if it's not loaded yet.
158
(with-upgradability ()
159
  (defun component-loaded-p (component)
Robert Goldman's avatar
Robert Goldman committed
160
    "Has the given COMPONENT been successfully loaded in the current image (yet)?
161
Note that this returns true even if the component is not up to date."
162
    (if-let ((component (find-component component () :registered t)))
163
      (action-already-done-p nil (make-operation 'load-op) component)))
164
165

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

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

175

176
177
;;;; Define the class REQUIRE-SYSTEM, to be hooked into CL:REQUIRE when possible,
;; i.e. for ABCL, CLISP, ClozureCL, CMUCL, ECL, MKCL and SBCL
178
179
;; Note that despite the two being homonyms, the _function_ require-system
;; and the _class_ require-system are quite distinct entities, fulfilling independent purposes.
180
(with-upgradability ()
181
182
183
  (defvar *modules-being-required* nil)

  (defclass require-system (system)
184
185
186
    ((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."))
187
188
189
190
191
192
193
194

  (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)))
195
      (require module)))
196
197

  (defmethod resolve-dependency-combination (component (combinator (eql :require)) arguments)
198
    (unless (and (length=n-p arguments 1)
Robert Goldman's avatar
Robert Goldman committed
199
                 (typep (car arguments) '(or string (and symbol (not null)))))
200
201
202
      (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))
203
204
205
206
207
208
    ;; :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
209
210
    ;; cl:require and asdf:operate that could potentially blow up the stack,
    ;; all the while defeating the consistency of the dependency graph.
211
    (let* ((module (car arguments)) ;; NB: we already checked that it was not null
212
213
214
215
216
           ;; 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)))
217
218
                   (register-system system)
                   system))))
219

220
  (defun module-provide-asdf (name)
221
222
223
224
225
    ;; 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.
226
227
228
229
230
    (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)))
231
232
233
          (handler-bind
              ((style-warning #'muffle-warning)
               (missing-component (constantly nil))
234
               (fatal-condition
Robert Goldman's avatar
Robert Goldman committed
235
236
237
                #'(lambda (e)
                    (format *error-output* (compatfmt "~@<ASDF could not load ~(~A~) because ~A.~@:>~%")
                            name e))))
238
            (let ((*verbose-out* (make-broadcast-stream)))
239
              (let ((system (find-system system-name nil)))
240
                (when system
241
                  (require-system system-name :verbose nil)
242
                  t)))))))))
243

244
245

;;;; Some upgrade magic
246
247
248
(with-upgradability ()
  (defun restart-upgraded-asdf ()
    ;; If we're in the middle of something, restart it.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
249
250
251
252
253
254
255
256
257
258
259
260
261
    (let ((systems-being-defined
           (when *asdf-cache*
             (prog1
                 (loop :for k :being :the hash-keys :of *asdf-cache*
                   :when (eq (first k) 'find-system) :collect (second k))
               (clrhash *asdf-cache*)))))
      ;; Regardless, clear defined systems, since they might be invalid
      ;; after an incompatible ASDF upgrade.
      (clear-defined-systems)
      ;; 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))))
262
  (register-hook-function '*post-upgrade-cleanup-hook* 'restart-upgraded-asdf)
263
264
265
266
267

  ;; The following function's symbol is from asdf/find-system.
  ;; It is defined here to resolve what would otherwise be forward package references.
  (defun mark-component-preloaded (component)
    "Mark a component as preloaded."
268
269
270
271
272
273
    (let ((component (find-component component nil :registered t)))
      ;; Recurse to children, so asdf/plan will hopefully be happy.
      (map () 'mark-component-preloaded (component-children component))
      ;; Mark the timestamps of the common lisp-action operations as 0.
      (let ((times (component-operation-times component)))
        (dolist (o '(load-op compile-op prepare-op))
274
          (setf (gethash (make-operation o) times) 0))))))
275