upgrade.lisp 9.75 KB
Newer Older
1 2 3 4
;;;; -------------------------------------------------------------------------
;;;; Handle upgrade as forward- and backward-compatibly as possible
;; See https://bugs.launchpad.net/asdf/+bug/485687

5
(uiop/package:define-package :asdf/upgrade
6
  (:recycle :asdf/upgrade :asdf)
7
  (:use :uiop/common-lisp :uiop)
8
  (:export
9
   #:asdf-version #:*previous-asdf-versions* #:*asdf-version*
10
   #:asdf-message #:*verbose-out*
11
   #:upgrading-p #:when-upgrading #:upgrade-asdf #:defparameter*
12
   #:*post-upgrade-cleanup-hook* #:cleanup-upgraded-asdf
13
   ;; There will be no symbol left behind!
14
   #:intern*)
15
  (:import-from :uiop/package #:intern* #:find-symbol*))
16 17 18 19
(in-package :asdf/upgrade)

;;; Special magic to detect if this is an upgrade

20
(with-upgradability ()
21 22 23 24 25
  (defun asdf-version ()
    "Exported interface to the version of ASDF currently installed. A string.
You can compare this string with e.g.: (ASDF:VERSION-SATISFIES (ASDF:ASDF-VERSION) \"3.4.5.67\")."
    (when (find-package :asdf)
      (or (symbol-value (find-symbol (string :*asdf-version*) :asdf))
26 27 28 29 30
          (let* ((revsym (find-symbol (string :*asdf-revision*) :asdf))
                 (rev (and revsym (boundp revsym) (symbol-value revsym))))
            (etypecase rev
              (string rev)
              (cons (format nil "~{~D~^.~}" rev))
31
              (null "1.0"))))))
32 33 34
  ;; This (private) variable contains a list of versions of previously loaded variants of ASDF,
  ;; from which ASDF was upgraded.
  ;; Important: define *p-a-v* /before/ *a-v* so that they initialize correctly.
35 36 37 38 39 40 41 42 43
  (defvar *previous-asdf-versions*
    (let ((previous (asdf-version)))
      (when previous
        ;; Punt on hard package upgrade: from ASDF1 or ASDF2
        (when (version< previous "2.27") ;; 2.27 is the first to have the :asdf3 feature.
          (let ((away (format nil "~A-~A" :asdf previous)))
            (rename-package :asdf away)
            (when *load-verbose*
              (format t "~&; Renamed old ~A package away to ~A~%" :asdf away)))))
44 45
      (list previous)))
  ;; This public variable will be bound shortly to the currently loaded version of ASDF.
46
  (defvar *asdf-version* nil)
47 48
  ;; We need to clear systems from versions older than the one in this (private) parameter.
  ;; The latest incompatible defclass is 2.32.13 renaming a slot in component;
49 50
  ;; the latest incompatible gf change is in 3.1.7.20 (see redefined-functions below).
  (defparameter *oldest-forward-compatible-asdf-version* "3.1.7.20")
51
  ;; Semi-private variable: a designator for a stream on which to output ASDF progress messages
52
  (defvar *verbose-out* nil)
53
  ;; Private function by which ASDF outputs progress messages and warning messages:
54
  (defun asdf-message (format-string &rest format-args)
55
    (when *verbose-out* (apply 'format *verbose-out* format-string format-args)))
56
  ;; Private hook for functions to run after ASDF has upgraded itself from an older variant:
57
  (defvar *post-upgrade-cleanup-hook* ())
58 59
  ;; Private function to detect whether the current upgrade counts as an incompatible
  ;; data schema upgrade implying the need to drop data.
60 61 62
  (defun upgrading-p (&optional (oldest-compatible-version *oldest-forward-compatible-asdf-version*))
    (and *previous-asdf-versions*
         (version< (first *previous-asdf-versions*) oldest-compatible-version)))
63 64 65
  ;; Private variant of defparameter that works in presence of incompatible upgrades:
  ;; behaves like defvar in a compatible upgrade (e.g. reloading system after simple code change),
  ;; but behaves like defparameter if in presence of an incompatible upgrade.
66 67 68 69 70 71 72 73
  (defmacro defparameter* (var value &optional docstring (version *oldest-forward-compatible-asdf-version*))
    (let* ((name (string-trim "*" var))
           (valfun (intern (format nil "%~A-~A-~A" :compute name :value))))
      `(progn
         (defun ,valfun () ,value)
         (defvar ,var (,valfun) ,@(ensure-list docstring))
         (when (upgrading-p ,version)
           (setf ,var (,valfun))))))
74 75 76
  ;; Private macro to declare sections of code that are only compiled and run when upgrading.
  ;; The use of eval portably ensures that the code will not have adverse compile-time side-effects,
  ;; whereas the use of handler-bind portably ensures that it will not issue warnings when it runs.
77 78
  (defmacro when-upgrading ((&key (version *oldest-forward-compatible-asdf-version*)
                               (upgrading-p `(upgrading-p ,version)) when) &body body)
79
    "A wrapper macro for code that should only be run when upgrading a
80
previously-loaded version of ASDF."
81
    `(with-upgradability ()
82 83
       (when (and ,upgrading-p ,@(when when `(,when)))
         (handler-bind ((style-warning #'muffle-warning))
84
           (eval '(progn ,@body))))))
85
  ;; Only now can we safely update the version.
86
  (let* (;; For bug reporting sanity, please always bump this version when you modify this file.
87
         ;; Please also modify asdf.asd to reflect this change. make bump-version v=3.4.5.67.8
88
         ;; can help you do these changes in synch (look at the source for documentation).
89
         ;; Relying on its automation, the version is now redundantly present on top of asdf.lisp.
90 91
         ;; "3.4" would be the general branch for major version 3, minor version 4.
         ;; "3.4.5" would be an official release in the 3.4 branch.
92
         ;; "3.4.5.67" would be a development version in the official branch, on top of 3.4.5.
93 94
         ;; "3.4.5.0.8" would be your eighth local modification of official release 3.4.5
         ;; "3.4.5.67.8" would be your eighth local modification of development version 3.4.5.67
95
         (asdf-version "3.1.7.29")
96
         (existing-version (asdf-version)))
97
    (setf *asdf-version* asdf-version)
98 99
    (when (and existing-version (not (equal asdf-version existing-version)))
      (push existing-version *previous-asdf-versions*)
100 101
      (when (or *verbose-out* *load-verbose*)
        (format (or *verbose-out* *trace-output*)
102
                (compatfmt "~&~@<; ~@;Upgrading ASDF ~@[from version ~A ~]to version ~A~@:>~%")
103
                existing-version asdf-version)))))
104

105
;;; Upon upgrade, specially frob some functions and classes that are being incompatibly redefined
106
(when-upgrading ()
107 108 109 110
  (let ((redefined-functions ;; List of functions that changes incompatibly since 2.27:
         ;; gf signature changed (should NOT happen), defun that became a generic function,
         ;; method removed that will mess up with new ones (especially :around :before :after,
         ;; more specific or call-next-method'ed method) and/or semantics otherwise modified. Oops.
111 112
         ;; NB: it's too late to do anything about functions in UIOP!
         ;; If you introduce some critical incompatibility there, you must change the function name.
113 114 115
         ;; Note that we don't need do anything about functions that changed incompatibly
         ;; from ASDF 2.26 or earlier: we wholly punt on the entire ASDF package in such an upgrade.
         ;; Also note that we don't include the defgeneric=>defun, because they are
116
         ;; done directly with defun* and need not trigger a punt on data.
117 118 119 120
         ;; See discussion at https://gitlab.common-lisp.net/asdf/asdf/merge_requests/36
         '(#:component-depends-on #:input-files ;; methods removed before 3.1.2
           #:find-component ;; gf modified in 3.1.7.20
           ))
121
        (redefined-classes
122 123 124
         ;; redefining the classes causes interim circularities
         ;; with the old ASDF during upgrade, and many implementations bork
         '((#:compile-concatenated-source-op (#:operation) ()))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
125
    (loop :for name :in redefined-functions
126 127
          :for sym = (find-symbol* name :asdf nil) :do
            (when sym
128
              ;; CLISP seemingly can't fmakunbound and define a function in the same fasl. Sigh.
129
              #-clisp (fmakunbound sym)))
130
    (labels ((asym (x) (multiple-value-bind (s p) (if (consp x) (values (car x) (cadr x)) (values x :asdf))
131 132
                         (find-symbol* s p nil)))
             (asyms (l) (mapcar #'asym l)))
133
      (loop* :for (name superclasses slots) :in redefined-classes
134 135 136
             :for sym = (find-symbol* name :asdf nil)
             :when (and sym (find-class sym))
             :do (eval `(defclass ,sym ,(asyms superclasses) ,(asyms slots)))))))
137

138

139
;;; Self-upgrade functions
140
(with-upgradability ()
141 142
  ;; This private function is called at the end of asdf/footer and ensures that,
  ;; *if* this loading of ASDF was an upgrade, then all registered cleanup functions will be called.
143 144 145 146 147
  (defun cleanup-upgraded-asdf (&optional (old-version (first *previous-asdf-versions*)))
    (let ((new-version (asdf-version)))
      (unless (equal old-version new-version)
        (push new-version *previous-asdf-versions*)
        (when old-version
148 149 150 151 152
          (if (version<= new-version old-version)
              (error (compatfmt "~&~@<; ~@;Downgraded ASDF from version ~A to version ~A~@:>~%")
                     old-version new-version)
              (asdf-message (compatfmt "~&~@<; ~@;Upgraded ASDF from version ~A to version ~A~@:>~%")
                            old-version new-version))
153 154 155 156 157 158
          ;; In case the previous version was too old to be forward-compatible, clear systems.
          ;; TODO: if needed, we may have to define a separate hook to run
          ;; in case of forward-compatible upgrade.
          ;; Or to move the tests forward-compatibility test inside each hook function?
          (unless (version<= *oldest-forward-compatible-asdf-version* old-version)
            (call-functions (reverse *post-upgrade-cleanup-hook*)))
159
          t))))
160

161 162
  (defun upgrade-asdf ()
    "Try to upgrade of ASDF. If a different version was used, return T.
163
   We need do that before we operate on anything that may possibly depend on ASDF."
164 165
    (let ((*load-print* nil)
          (*compile-print* nil))
166
      (handler-bind (((or style-warning) #'muffle-warning))
167
        (symbol-call :asdf :load-system :asdf :verbose nil)))))