action.lisp 23.3 KB
Newer Older
1
2
3
;;;; -------------------------------------------------------------------------
;;;; Actions

4
(uiop/package:define-package :asdf/action
5
  (:nicknames :asdf-action)
6
  (:recycle :asdf/action :asdf)
7
  (:use :uiop/common-lisp :uiop :asdf/upgrade
8
   :asdf/component :asdf/system #:asdf/cache :asdf/find-system :asdf/find-component :asdf/operation)
9
  (:import-from :asdf/operation #:check-operation-constructor)
10
  (:export
11
   #:action #:define-convenience-action-methods
12
   #:action-description
13
   #:downward-operation #:upward-operation #:sideway-operation #:selfward-operation #:non-propagating-operation
14
   #:component-depends-on
15
16
   #:input-files #:output-files #:output-file #:operation-done-p
   #:action-status #:action-stamp #:action-done-p
17
   #:action-operation #:action-component #:make-action
18
   #:component-operation-time #:mark-operation-done #:compute-action-stamp
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
19
   #:perform #:perform-with-restarts #:retry #:accept
20
   #:action-path #:find-action #:stamp #:done-p
21
   #:operation-definition-warning #:operation-definition-error ;; condition
22
   ))
23
24
(in-package :asdf/action)

25
(eval-when (#-lispworks :compile-toplevel :load-toplevel :execute) ;; LispWorks issues spurious warning
26
27
28
29
30

  (deftype action ()
    "A pair of operation and component uniquely identifies a node in the dependency graph
of steps to be performed while building a system."
    '(cons operation component))
31
32

  (deftype operation-designator ()
33
34
    "An operation designates itself. NIL designates a context-dependent current operation,
and a class-name or class designates the canonical instance of the designated class."
35
    '(or operation null symbol class)))
36

37
38
39
40
41
42
43
44
45
;;; these are pseudo accessors -- let us abstract away the CONS cell representation of plan
;;; actions.
(with-upgradability ()
  (defun make-action (operation component)
    (cons operation component))
  (defun action-operation (action)
    (car action))
  (defun action-component (action)
    (cdr action)))
46

47
;;;; Reified representation for storage or debugging. Note: an action is identified by its class.
48
49
(with-upgradability ()
  (defun action-path (action)
50
    "A readable data structure that identifies the action."
51
52
53
    (let ((o (action-operation action))
          (c (action-component action)))
      (cons (type-of o) (component-find-path c))))
54
  (defun find-action (path)
55
    "Reconstitute an action from its action-path"
56
    (destructuring-bind (o . c) path (make-action (make-operation o) (find-component () c)))))
57
58

;;;; Convenience methods
59
(with-upgradability ()
60
61
62
63
64
65
66
67
  ;; A macro that defines convenience methods for a generic function (gf) that
  ;; dispatches on operation and component.  The convenience methods allow users
  ;; to call the gf with operation and/or component designators, that the
  ;; methods will resolve into actual operation and component objects, so that
  ;; the users can interact using readable designators, but developers only have
  ;; to write methods that handle operation and component objects.
  ;; FUNCTION is the generic function name
  ;; FORMALS is its list of arguments, which must include OPERATION and COMPONENT.
68
69
  ;; IF-NO-OPERATION is a form (defaults to NIL) describing what to do if no operation is found.
  ;; IF-NO-COMPONENT is a form (defaults to NIL) describing what to do if no component is found.
70
  (defmacro define-convenience-action-methods
71
      (function formals &key if-no-operation if-no-component)
72
73
    (let* ((rest (gensym "REST"))
           (found (gensym "FOUND"))
74
75
76
           (keyp (equal (last formals) '(&key)))
           (formals-no-key (if keyp (butlast formals) formals))
           (len (length formals-no-key))
77
78
79
80
81
82
           (operation 'operation)
           (component 'component)
           (opix (position operation formals))
           (coix (position component formals))
           (prefix (subseq formals 0 opix))
           (suffix (subseq formals (1+ coix) len))
83
           (more-args (when keyp `(&rest ,rest &key &allow-other-keys))))
84
      (assert (and (integerp opix) (integerp coix) (= coix (1+ opix))))
85
86
      (flet ((next-method (o c)
               (if keyp
87
88
                   `(apply ',function ,@prefix ,o ,c ,@suffix ,rest)
                   `(,function ,@prefix ,o ,c ,@suffix))))
89
        `(progn
90
           (defmethod ,function (,@prefix (,operation string) ,component ,@suffix ,@more-args)
91
             (declare (notinline ,function))
92
93
94
             (let ((,component (find-component () ,component))) ;; do it first, for defsystem-depends-on
               ,(next-method `(safe-read-from-string ,operation :package :asdf/interface) component)))
           (defmethod ,function (,@prefix (,operation symbol) ,component ,@suffix ,@more-args)
95
             (declare (notinline ,function))
96
97
             (if ,operation
                 ,(next-method
98
                   `(make-operation ,operation)
99
100
                   `(or (find-component () ,component) ,if-no-component))
                 ,if-no-operation))
101
           (defmethod ,function (,@prefix (,operation operation) ,component ,@suffix ,@more-args)
102
             (declare (notinline ,function))
103
104
             (if (typep ,component 'component)
                 (error "No defined method for ~S on ~/asdf-action:format-action/"
105
                        ',function (make-action ,operation ,component))
106
107
108
                 (if-let (,found (find-component () ,component))
                    ,(next-method operation found)
                    ,if-no-component))))))))
109

110
111

;;;; self-description
112
113
114
(with-upgradability ()
  (defgeneric action-description (operation component)
    (:documentation "returns a phrase that describes performing this operation
115
116
on this component, e.g. \"loading /a/b/c\".
You can put together sentences using this phrase."))
117
118
  (defmethod action-description (operation component)
    (format nil (compatfmt "~@<~A on ~A~@:>")
119
            operation component))
120

121
  (defun format-action (stream action &optional colon-p at-sign-p)
122
123
    "FORMAT helper to display an action's action-description.
Use it in FORMAT control strings as ~/asdf-action:format-action/"
124
125
126
    (assert (null colon-p)) (assert (null at-sign-p))
    (destructuring-bind (operation . component) action
      (princ (action-description operation component) stream))))
127
128
129


;;;; Dependencies
130
(with-upgradability ()
131
  (defgeneric component-depends-on (operation component) ;; ASDF4: rename to component-dependencies
132
133
    (:documentation
     "Returns a list of dependencies needed by the component to perform
134
135
    the operation.  A dependency has one of the following forms:

136
137
138
139
140
      (<operation> <component>*), where <operation> is an operation designator
        with respect to FIND-OPERATION in the context of the OPERATION argument,
        and each <component> is a component designator with respect to
        FIND-COMPONENT in the context of the COMPONENT argument,
        and means that the component depends on
141
142
143
144
        <operation> having been performed on each <component>;

        [Note: an <operation> is an operation designator -- it can be either an
        operation name or an operation object.  Similarly, a <component> may be
145
146
        a component name or a component object.  Also note that, the degenerate
        case of (<operation>) is a no-op.]
147

148
    Methods specialized on subclasses of existing component types
149
    should usually append the results of CALL-NEXT-METHOD to the list."))
150
  (define-convenience-action-methods component-depends-on (operation component))
151
152
153

  (defmethod component-depends-on :around ((o operation) (c component))
    (do-asdf-cache `(component-depends-on ,o ,c)
154
      (call-next-method))))
155
156


157
158
;;;; upward-operation, downward-operation, sideway-operation, selfward-operation
;; These together handle actions that propagate along the component hierarchy or operation universe.
159
160
161
(with-upgradability ()
  (defclass downward-operation (operation)
    ((downward-operation
162
      :initform nil :reader downward-operation
163
      :type operation-designator :allocation :class))
164
165
166
167
168
169
    (:documentation "A DOWNWARD-OPERATION's dependencies propagate down the component hierarchy.
I.e., if O is a DOWNWARD-OPERATION and its DOWNWARD-OPERATION slot designates operation D, then
the action (O . M) of O on module M will depends on each of (D . C) for each child C of module M.
The default value for slot DOWNWARD-OPERATION is NIL, which designates the operation O itself.
E.g. in order for a MODULE to be loaded with LOAD-OP (resp. compiled with COMPILE-OP), all the
children of the MODULE must have been loaded with LOAD-OP (resp. compiled with COMPILE-OP."))
170
171
  (defun downward-operation-depends-on (o c)
    `((,(or (downward-operation o) o) ,@(component-children c))))
172
  (defmethod component-depends-on ((o downward-operation) (c parent-component))
173
    `(,@(downward-operation-depends-on o c) ,@(call-next-method)))
174

175
176
  (defclass upward-operation (operation)
    ((upward-operation
177
      :initform nil :reader upward-operation
178
      :type operation-designator :allocation :class))
179
180
181
182
183
184
    (:documentation "An UPWARD-OPERATION has dependencies that propagate up the component hierarchy.
I.e., if O is an instance of UPWARD-OPERATION, and its UPWARD-OPERATION slot designates operation U,
then the action (O . C) of O on a component C that has the parent P will depends on (U . P).
The default value for slot UPWARD-OPERATION is NIL, which designates the operation O itself.
E.g. in order for a COMPONENT to be prepared for loading or compiling with PREPARE-OP, its PARENT
must first be prepared for loading or compiling with PREPARE-OP."))
185
186
  ;; For backward-compatibility reasons, a system inherits from module and is a child-component
  ;; so we must guard against this case. ASDF4: remove that.
187
188
  (defun upward-operation-depends-on (o c)
    (if-let (p (component-parent c)) `((,(or (upward-operation o) o) ,p))))
189
  (defmethod component-depends-on ((o upward-operation) (c child-component))
190
    `(,@(upward-operation-depends-on o c) ,@(call-next-method)))
191

192
193
  (defclass sideway-operation (operation)
    ((sideway-operation
194
      :initform nil :reader sideway-operation
195
      :type operation-designator :allocation :class))
196
197
198
199
200
201
    (:documentation "A SIDEWAY-OPERATION has dependencies that propagate \"sideway\" to siblings
that a component depends on. I.e. if O is a SIDEWAY-OPERATION, and its SIDEWAY-OPERATION slot
designates operation S (where NIL designates O itself), then the action (O . C) of O on component C
depends on each of (S . D) where D is a declared dependency of C.
E.g. in order for a COMPONENT to be prepared for loading or compiling with PREPARE-OP,
each of its declared dependencies must first be loaded as by LOAD-OP."))
202
  (defun sideway-operation-depends-on (o c)
203
    `((,(or (sideway-operation o) o) ,@(component-sideway-dependencies c))))
204
205
  (defmethod component-depends-on ((o sideway-operation) (c component))
    `(,@(sideway-operation-depends-on o c) ,@(call-next-method)))
206

207
208
  (defclass selfward-operation (operation)
    ((selfward-operation
209
      ;; NB: no :initform -- if an operation depends on others, it must explicitly specify which
210
      :type (or operation-designator list) :reader selfward-operation :allocation :class))
211
    (:documentation "A SELFWARD-OPERATION depends on another operation on the same component.
212
213
I.e., if O is a SELFWARD-OPERATION, and its SELFWARD-OPERATION designates a list of operations L,
then the action (O . C) of O on component C depends on each (S . C) for S in L.
214
E.g. before a component may be loaded by LOAD-OP, it must have been compiled by COMPILE-OP.
215
216
A operation-designator designates a singleton list of the designated operation;
a list of operation-designators designates the list of designated operations;
217
218
219
NIL is not a valid operation designator in that context.  Note that any dependency
ordering between the operations in a list of SELFWARD-OPERATION should be specified separately
in the respective operation's COMPONENT-DEPENDS-ON methods so that they be scheduled properly."))
220
221
  (defun selfward-operation-depends-on (o c)
    (loop :for op :in (ensure-list (selfward-operation o)) :collect `(,op ,c)))
222
  (defmethod component-depends-on ((o selfward-operation) (c component))
223
    `(,@(selfward-operation-depends-on o c) ,@(call-next-method)))
224
225
226

  (defclass non-propagating-operation (operation)
    ()
227
    (:documentation "A NON-PROPAGATING-OPERATION is an operation that propagates
228
229
230
231
232
233
234
235
no dependencies whatsoever.  It is supplied in order that the programmer be able
to specify that s/he is intentionally specifying an operation which invokes no
dependencies.")))


;;;---------------------------------------------------------------------------
;;; Help programmers catch obsolete OPERATION subclasses
;;;---------------------------------------------------------------------------
236
237
238
239
240
241
242
243
244
245
(with-upgradability ()
  (define-condition operation-definition-warning (simple-warning)
    ()
    (:documentation "Warning condition related to definition of obsolete OPERATION objects."))

  (define-condition operation-definition-error (simple-error)
    ()
    (:documentation "Error condition related to definition of incorrect OPERATION objects."))

  (defmethod initialize-instance :before ((o operation) &key)
246
    (check-operation-constructor)
247
    (unless (typep o '(or downward-operation upward-operation sideway-operation
248
                          selfward-operation non-propagating-operation))
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
      (warn 'operation-definition-warning
            :format-control
            "No dependency propagating scheme specified for operation class ~S.
The class needs to be updated for ASDF 3.1 and specify appropriate propagation mixins."
            :format-arguments (list (type-of o)))))

  (defmethod initialize-instance :before ((o non-propagating-operation) &key)
    (when (typep o '(or downward-operation upward-operation sideway-operation selfward-operation))
      (error 'operation-definition-error
             :format-control
             "Inconsistent class: ~S
  NON-PROPAGATING-OPERATION is incompatible with propagating operation classes as superclasses."
             :format-arguments
             (list (type-of o)))))

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
264
265
  (defun backward-compatible-depends-on (o c)
    "DEPRECATED: all subclasses of OPERATION used in ASDF should inherit from one of
266
267
268
 DOWNWARD-OPERATION UPWARD-OPERATION SIDEWAY-OPERATION SELFWARD-OPERATION NON-PROPAGATING-OPERATION.
 The function BACKWARD-COMPATIBLE-DEPENDS-ON temporarily provides ASDF2 behaviour for those that
 don't. In the future this functionality will be removed, and the default will be no propagation."
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
269
270
271
272
273
    (uiop/version::notify-deprecated-function
     (version-deprecation *asdf-version* :style-warning "3.2")
     'backward-compatible-depends-on)
    `(,@(sideway-operation-depends-on o c)
      ,@(when (typep c 'parent-component) (downward-operation-depends-on o c))))
274

275
276
277
  (defmethod component-depends-on ((o operation) (c component))
    `(;; Normal behavior, to allow user-specified in-order-to dependencies
      ,@(cdr (assoc (type-of o) (component-in-order-to c)))
278
279
280
281
282
        ;; For backward-compatibility with ASDF2, any operation that doesn't specify propagation
        ;; or non-propagation through an appropriate mixin will be downward and sideway.
        ,@(unless (typep o '(or downward-operation upward-operation sideway-operation
                             selfward-operation non-propagating-operation))
            (backward-compatible-depends-on o c))))
283
284
285
286

  (defmethod downward-operation ((o operation)) nil)
  (defmethod sideway-operation ((o operation)) nil))

287
288
289
290

;;;---------------------------------------------------------------------------
;;; End of OPERATION class checking
;;;---------------------------------------------------------------------------
291
292
293


;;;; Inputs, Outputs, and invisible dependencies
294
(with-upgradability ()
295
  (defgeneric output-files (operation component)
296
    (:documentation "Methods for this function return two values: a list of output files
297
298
299
corresponding to this action, and a boolean indicating if they have already been subjected
to relevant output translations and should not be further translated.

300
Methods on PERFORM *must* call this function to determine where their outputs are to be located.
301
302
They may rely on the order of the files to discriminate between outputs.
"))
303
  (defgeneric input-files (operation component)
304
305
    (:documentation "A list of input files corresponding to this action.

306
Methods on PERFORM *must* call this function to determine where their inputs are located.
307
308
They may rely on the order of the files to discriminate between inputs.
"))
309
  (defgeneric operation-done-p (operation component)
310
    (:documentation "Returns a boolean which is NIL if the action must be performed (again)."))
311
312
313
314
315
316
317
  (define-convenience-action-methods output-files (operation component))
  (define-convenience-action-methods input-files (operation component))
  (define-convenience-action-methods operation-done-p (operation component))

  (defmethod operation-done-p ((o operation) (c component))
    t)

318
  ;; Translate output files, unless asked not to. Memoize the result.
319
  (defmethod output-files :around ((operation t) (component t))
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
    (do-asdf-cache `(output-files ,operation ,component)
      (values
       (multiple-value-bind (pathnames fixedp) (call-next-method)
         ;; 1- Make sure we have absolute pathnames
         (let* ((directory (pathname-directory-pathname
                            (component-pathname (find-component () component))))
                (absolute-pathnames
                  (loop
                    :for pathname :in pathnames
                    :collect (ensure-absolute-pathname pathname directory))))
           ;; 2- Translate those pathnames as required
           (if fixedp
               absolute-pathnames
               (mapcar *output-translation-function* absolute-pathnames))))
       t)))
  (defmethod output-files ((o operation) (c component))
    nil)
  (defun output-file (operation component)
    "The unique output file of performing OPERATION on COMPONENT"
    (let ((files (output-files operation component)))
      (assert (length=n-p files 1))
      (first files)))

343
  ;; Memoize input files.
344
345
346
347
  (defmethod input-files :around (operation component)
    (do-asdf-cache `(input-files ,operation ,component)
      (call-next-method)))

348
  ;; By default an action has no input-files.
349
  (defmethod input-files ((o operation) (c component))
350
351
    nil)

352
353
354
355
  ;; An action with a selfward-operation by default gets its input-files from the output-files of
  ;; the actions using selfward-operations it depends on (and the same component),
  ;; or if there are none, on the component-pathname of the component if it's a file
  ;; -- and then on the results of the next-method.
356
357
358
359
360
361
  (defmethod input-files ((o selfward-operation) (c component))
    `(,@(or (loop :for dep-o :in (ensure-list (selfward-operation o))
                  :append (or (output-files dep-o c) (input-files dep-o c)))
            (if-let ((pathname (component-pathname c)))
              (and (file-pathname-p pathname) (list pathname))))
      ,@(call-next-method))))
362
363
364


;;;; Done performing
365
(with-upgradability ()
366
367
368
369
370
  ;; ASDF4: hide it behind plan-action-stamp
  (defgeneric component-operation-time (operation component)
    (:documentation "Return the timestamp for when an action was last performed"))
  (defgeneric (setf component-operation-time) (time operation component)
    (:documentation "Update the timestamp for when an action was last performed"))
371
  (define-convenience-action-methods component-operation-time (operation component))
372

373
374
375
376
377
378
  ;; ASDF4: hide it behind (setf plan-action-stamp)
  (defgeneric mark-operation-done (operation component)
    (:documentation "Mark a action as having been just done.

Updates the action's COMPONENT-OPERATION-TIME to match the COMPUTE-ACTION-STAMP
using the JUST-DONE flag."))
379
380
  (defgeneric compute-action-stamp (plan operation component &key just-done)
    (:documentation "Has this action been successfully done already,
381
and at what known timestamp has it been done at or will it be done at?
382
383
384
385
* PLAN is a plan object modelling future effects of actions,
  or NIL to denote what actually happened.
* OPERATION and COMPONENT denote the action.
Takes keyword JUST-DONE:
386
387
388
* JUST-DONE is a boolean that is true if the action was just successfully performed,
  at which point we want compute the actual stamp and warn if files are missing;
  otherwise we are making plans, anticipating the effects of the action.
389
390
Returns two values:
* a STAMP saying when it was done or will be done,
391
  or T if the action involves files that need to be recomputed.
392
393
394
* a boolean DONE-P that indicates whether the action has actually been done,
  and both its output-files and its in-image side-effects are up to date."))

395
396
397
398
  (defclass action-status ()
    ((stamp
      :initarg :stamp :reader action-stamp
      :documentation "STAMP associated with the ACTION if it has been completed already
399
in some previous image, or T if it needs to be done.")
400
401
402
403
     (done-p
      :initarg :done-p :reader action-done-p
      :documentation "a boolean, true iff the action was already done (before any planned action)."))
    (:documentation "Status of an action"))
404

405
406
407
408
  (defmethod print-object ((status action-status) stream)
    (print-unreadable-object (status stream :type t)
      (with-slots (stamp done-p) status
        (format stream "~@{~S~^ ~}" :stamp stamp :done-p done-p))))
409

410
  (defmethod component-operation-time ((o operation) (c component))
411
    (gethash o (component-operation-times c)))
412

413
  (defmethod (setf component-operation-time) (stamp (o operation) (c component))
414
    (setf (gethash o (component-operation-times c)) stamp))
415

416
  (defmethod mark-operation-done ((o operation) (c component))
417
    (setf (component-operation-time o c) (compute-action-stamp nil o c :just-done t))))
418
419
420


;;;; Perform
421
(with-upgradability ()
422
  (defgeneric perform (operation component)
423
    (:documentation "PERFORM an action, consuming its input-files and building its output-files"))
424
425
426
427
428
429
430
431
432
  (define-convenience-action-methods perform (operation component))

  (defmethod perform :before ((o operation) (c component))
    (ensure-all-directories-exist (output-files o c)))
  (defmethod perform :after ((o operation) (c component))
    (mark-operation-done o c))
  (defmethod perform ((o operation) (c parent-component))
    nil)
  (defmethod perform ((o operation) (c source-file))
433
434
435
436
437
    ;; For backward compatibility, don't error on operations that don't specify propagation.
    (when (typep o '(or downward-operation upward-operation sideway-operation
                     selfward-operation non-propagating-operation))
      (sysdef-error
       (compatfmt "~@<Required method ~S not implemented for ~/asdf-action:format-action/~@:>")
438
       'perform (make-action o c))))
439

440
441
442
  ;; The restarts of the perform-with-restarts variant matter in an interactive context.
  ;; The retry strategies of p-w-r itself, and/or the background workers of a multiprocess build
  ;; may call perform directly rather than call p-w-r.
443
  (defgeneric perform-with-restarts (operation component)
444
    (:documentation "PERFORM an action in a context where suitable restarts are in place."))
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
  (defmethod perform-with-restarts (operation component)
    (perform operation component))
  (defmethod perform-with-restarts :around (operation component)
    (loop
      (restart-case
          (return (call-next-method))
        (retry ()
          :report
          (lambda (s)
            (format s (compatfmt "~@<Retry ~A.~@:>")
                    (action-description operation component))))
        (accept ()
          :report
          (lambda (s)
            (format s (compatfmt "~@<Continue, treating ~A as having been successful.~@:>")
                    (action-description operation component)))
          (mark-operation-done operation component)
          (return))))))