bundle.lisp 18.6 KB
Newer Older
1 2 3
;;;; -------------------------------------------------------------------------
;;;; ASDF-Bundle

4 5
(asdf/package:define-package :asdf/bundle
  (:recycle :asdf/bundle :asdf)
6
  (:use :asdf/common-lisp :asdf/driver :asdf/upgrade
7 8 9
   :asdf/component :asdf/system :asdf/find-system :asdf/find-component :asdf/operation
   :asdf/action :asdf/lisp-action :asdf/plan :asdf/operate)
  (:export
10
   #:bundle-op #:bundle-op-build-args #:bundle-type #:bundle-system #:bundle-pathname-type
11
   #:fasl-op #:load-fasl-op #:lib-op #:dll-op #:binary-op
12
   #:monolithic-op #:monolithic-bundle-op #:direct-dependency-files
13
   #:monolithic-binary-op #:monolithic-fasl-op #:monolithic-lib-op #:monolithic-dll-op
14
   #:program-op
15
   #:compiled-file #:precompiled-system #:prebuilt-system
16 17
   #:operation-monolithic-p
   #:user-system-p #:user-system #:trivial-system-p
18
   #+ecl #:make-build
19
   #:register-pre-built-system
20
   #:build-args #:name-suffix #:prologue-code #:epilogue-code #:static-library))
21 22
(in-package :asdf/bundle)

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
(with-upgradability ()
  (defclass bundle-op (operation)
    ((build-args :initarg :args :initform nil :accessor bundle-op-build-args)
     (name-suffix :initarg :name-suffix :initform nil)
     (bundle-type :initform :no-output-file :reader bundle-type)
     #+ecl (lisp-files :initform nil :accessor bundle-op-lisp-files)
     #+mkcl (do-fasb :initarg :do-fasb :initform t :reader bundle-op-do-fasb-p)
     #+mkcl (do-static-library :initarg :do-static-library :initform t :reader bundle-op-do-static-library-p)))

  (defclass fasl-op (bundle-op)
    ;; create a single fasl for the entire library
    ((bundle-type :initform :fasl)))

  (defclass load-fasl-op (basic-load-op)
    ;; load a single fasl for the entire library
    ())

  (defclass lib-op (bundle-op)
    ;; On ECL: compile the system and produce linkable .a library for it.
    ;; On others: just compile the system.
    ((bundle-type :initform #+(or ecl mkcl) :lib #-(or ecl mkcl) :no-output-file)))

  (defclass dll-op (bundle-op)
    ;; Link together all the dynamic library used by this system into a single one.
    ((bundle-type :initform :dll)))

  (defclass binary-op (bundle-op)
    ;; On ECL: produce lib and fasl for the system.
    ;; On "normal" Lisps: produce just the fasl.
    ())

  (defclass monolithic-op (operation) ()) ;; operation on a system and its dependencies

  (defclass monolithic-bundle-op (monolithic-op bundle-op)
    ((prologue-code :accessor monolithic-op-prologue-code)
     (epilogue-code :accessor monolithic-op-epilogue-code)))

  (defclass monolithic-binary-op (binary-op monolithic-bundle-op)
    ;; On ECL: produce lib and fasl for combined system and dependencies.
    ;; On "normal" Lisps: produce an image file from system and dependencies.
    ())

  (defclass monolithic-fasl-op (monolithic-bundle-op fasl-op)
    ;; Create a single fasl for the system and its dependencies.
    ())

  (defclass monolithic-lib-op (monolithic-bundle-op lib-op)
    ;; ECL: Create a single linkable library for the system and its dependencies.
    ((bundle-type :initform :lib)))

  (defclass monolithic-dll-op (monolithic-bundle-op dll-op)
    ((bundle-type :initform :dll)))

  (defclass program-op (monolithic-bundle-op)
    ;; All: create an executable file from the system and its dependencies
    ((bundle-type :initform :program)))

  (defun bundle-pathname-type (bundle-type)
    (etypecase bundle-type
      ((eql :no-output-file) nil) ;; should we error out instead?    
      ((or null string) bundle-type)
      ((eql :fasl) #-(or ecl mkcl) (compile-file-type) #+(or ecl mkcl) "fasb")
      #+ecl
      ((member :binary :dll :lib :static-library :program :object :program)
       (compile-file-type :type bundle-type))
      ((eql :binary) "image")
      ((eql :dll) (cond ((os-unix-p) "so") ((os-windows-p) "dll")))
      ((member :lib :static-library) (cond ((os-unix-p) "a") ((os-windows-p) "lib")))
      ((eql :program) (cond ((os-unix-p) nil) ((os-windows-p) "exe")))))

  (defun bundle-output-files (o c)
    (let ((bundle-type (bundle-type o)))
      (unless (eq bundle-type :no-output-file) ;; NIL already means something regarding type.
        (let ((name (or (component-build-pathname c)
                        (format nil "~A~@[~A~]" (component-name c) (slot-value o 'name-suffix))))
              (type (bundle-pathname-type bundle-type)))
          (values (list (subpathname (component-pathname c) name :type type))
                  (eq (type-of o) (component-build-operation c)))))))

  (defmethod output-files ((o bundle-op) (c system))
    (bundle-output-files o c))

  #-(or ecl mkcl)
  (progn
    (defmethod perform ((o program-op) (c system))
      (let ((output-file (output-file o c)))
        (setf *image-entry-point* (ensure-function (component-entry-point c)))
        (dump-image output-file :executable t)))

    (defmethod perform ((o monolithic-binary-op) (c system))
      (let ((output-file (output-file o c)))
        (dump-image output-file))))

  (defclass compiled-file (file-component)
    ((type :initform #-(or ecl mkcl) (compile-file-type) #+(or ecl mkcl) "fasb")))

  (defclass precompiled-system (system)
    ((build-pathname :initarg :fasl)))

  (defclass prebuilt-system (system)
    ((build-pathname :initarg :static-library :initarg :lib
                     :accessor prebuilt-system-static-library))))

126 127 128 129 130 131 132 133 134

;;;
;;; BUNDLE-OP
;;;
;;; This operation takes all components from one or more systems and
;;; creates a single output file, which may be
;;; a FASL, a statically linked library, a shared library, etc.
;;; The different targets are defined by specialization.
;;;
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
(with-upgradability ()
  (defun operation-monolithic-p (op)
    (typep op 'monolithic-op))

  (defmethod initialize-instance :after ((instance bundle-op) &rest initargs
                                         &key (name-suffix nil name-suffix-p)
                                         &allow-other-keys)
    (declare (ignorable initargs name-suffix))
    (unless name-suffix-p
      (setf (slot-value instance 'name-suffix)
            (unless (typep instance 'program-op)
              (if (operation-monolithic-p instance) ".all-systems" #-ecl ".system"))))
    (when (typep instance 'monolithic-bundle-op)
      (destructuring-bind (&rest original-initargs
                           &key lisp-files prologue-code epilogue-code
                           &allow-other-keys)
          (operation-original-initargs instance)
        (setf (operation-original-initargs instance)
              (remove-plist-keys '(:lisp-files :epilogue-code :prologue-code) original-initargs)
              (monolithic-op-prologue-code instance) prologue-code
              (monolithic-op-epilogue-code instance) epilogue-code)
        #-ecl (assert (null (or lisp-files epilogue-code prologue-code)))
        #+ecl (setf (bundle-op-lisp-files instance) lisp-files)))
    (setf (bundle-op-build-args instance)
          (remove-plist-keys '(:type :monolithic :name-suffix)
                             (operation-original-initargs instance))))

  (defmethod bundle-op-build-args :around ((o lib-op))
    (declare (ignorable o))
    (let ((args (call-next-method)))
      (remf args :ld-flags)
      args))

  (defun bundlable-file-p (pathname)
    (let ((type (pathname-type pathname)))
      (declare (ignorable type))
      (or #+ecl (or (equal type (compile-file-type :type :object))
                    (equal type (compile-file-type :type :static-library)))
          #+mkcl (equal type (compile-file-type :fasl-p nil))
          #+(or allegro clisp clozure cmu lispworks sbcl scl xcl) (equal type (compile-file-type)))))

  (defgeneric* (trivial-system-p) (component))

  (defun user-system-p (s)
    (and (typep s 'system)
         (not (builtin-system-p s))
         (not (trivial-system-p s))))

  (deftype user-system () '(and system (satisfies user-system-p))))
184 185 186 187 188 189 190 191 192

;;;
;;; First we handle monolithic bundles.
;;; These are standalone systems which contain everything,
;;; including other ASDF systems required by the current one.
;;; A PROGRAM is always monolithic.
;;;
;;; MONOLITHIC SHARED LIBRARIES, PROGRAMS, FASL
;;;
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
(with-upgradability ()
  (defmethod component-depends-on ((o monolithic-lib-op) (c system))
    (declare (ignorable o))
    `((lib-op ,@(required-components c :other-systems t :component-type 'system
                                       :goal-operation 'load-op
                                       :keep-operation 'compile-op))))

  (defmethod component-depends-on ((o monolithic-fasl-op) (c system))
    (declare (ignorable o))
    `((fasl-op ,@(required-components c :other-systems t :component-type 'system
                                        :goal-operation 'load-fasl-op
                                        :keep-operation 'fasl-op))))

  (defmethod component-depends-on ((o program-op) (c system))
    (declare (ignorable o))
    #+(or ecl mkcl) (component-depends-on (make-operation 'monolithic-lib-op) c)
    #-(or ecl mkcl) `((load-op ,c)))

  (defmethod component-depends-on ((o binary-op) (c system))
    (declare (ignorable o))
    `((fasl-op ,c)
      (lib-op ,c)))

  (defmethod component-depends-on ((o monolithic-binary-op) (c system))
    `((,(find-operation o 'monolithic-fasl-op) ,c)
      (,(find-operation o 'monolithic-lib-op) ,c)))

  (defmethod component-depends-on ((o lib-op) (c system))
    (declare (ignorable o))
    `((compile-op ,@(required-components c :other-systems nil :component-type '(not system)
                                           :goal-operation 'load-op
                                           :keep-operation 'compile-op))))

  (defmethod component-depends-on ((o fasl-op) (c system))
    (declare (ignorable o))
    #+ecl `((lib-op ,c))
    #-ecl
    (component-depends-on (find-operation o 'lib-op) c))

  (defmethod component-depends-on ((o dll-op) c)
    (component-depends-on (find-operation o 'lib-op) c))

  (defmethod component-depends-on ((o bundle-op) c)
    (declare (ignorable o c))
    nil)

  (defmethod component-depends-on :around ((o bundle-op) (c component))
    (declare (ignorable o c))
    (if-let (op (and (eq (type-of o) 'bundle-op) (component-build-operation c)))
242 243 244
      `((,op ,c))
      (call-next-method)))

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  (defun direct-dependency-files (o c &key (test 'identity) (key 'output-files) &allow-other-keys)
    (while-collecting (collect)
      (map-direct-dependencies
       o c #'(lambda (sub-o sub-c)
               (loop :for f :in (funcall key sub-o sub-c)
                     :when (funcall test f) :do (collect f))))))

  (defmethod input-files ((o bundle-op) (c system))
    (direct-dependency-files o c :test 'bundlable-file-p :key 'output-files))

  (defun select-bundle-operation (type &optional monolithic)
    (ecase type
      ((:binary)
       (if monolithic 'monolithic-binary-op 'binary-op))
      ((:dll :shared-library)
       (if monolithic 'monolithic-dll-op 'dll-op))
      ((:lib :static-library)
       (if monolithic 'monolithic-lib-op 'lib-op))
      ((:fasl)
       (if monolithic 'monolithic-fasl-op 'fasl-op))
      ((:program)
       'program-op)))

  (defun make-build (system &rest args &key (monolithic nil) (type :fasl)
                             (move-here nil move-here-p)
                             &allow-other-keys)
    (let* ((operation-name (select-bundle-operation type monolithic))
           (move-here-path (if (and move-here
                                    (typep move-here '(or pathname string)))
                               (pathname move-here)
                               (system-relative-pathname system "asdf-output/")))
           (operation (apply #'operate operation-name
                             system
                             (remove-plist-keys '(:monolithic :type :move-here) args)))
           (system (find-system system))
           (files (and system (output-files operation system))))
      (if (or move-here (and (null move-here-p)
                             (member operation-name '(:program :binary))))
          (loop :with dest-path = (resolve-symlinks* (ensure-directories-exist move-here-path))
                :for f :in files
                :for new-f = (make-pathname :name (pathname-name f)
                                            :type (pathname-type f)
                                            :defaults dest-path)
                :do (rename-file-overwriting-target f new-f)
                :collect new-f)
          files))))
291 292 293 294 295 296

;;;
;;; LOAD-FASL-OP
;;;
;;; This is like ASDF's LOAD-OP, but using monolithic fasl files.
;;;
297 298 299 300 301 302 303
(with-upgradability ()
  (defmethod component-depends-on ((o load-fasl-op) (c system))
    (declare (ignorable o))
    `((,o ,@(loop :for dep :in (component-sibling-dependencies c)
                  :collect (resolve-dependency-spec c dep)))
      (,(if (user-system-p c) 'fasl-op 'load-op) ,c)
      ,@(call-next-method)))
304

305 306 307
  (defmethod input-files ((o load-fasl-op) (c system))
    (when (user-system-p c)
      (output-files (find-operation o 'fasl-op) c)))
308

309 310 311
  (defmethod perform ((o load-fasl-op) c)
    (declare (ignorable o c))
    nil)
312

313 314
  (defmethod perform ((o load-fasl-op) (c system))
    (perform-lisp-load-fasl o c))
315

316 317
  (defmethod mark-operation-done :after ((o load-fasl-op) (c system))
    (mark-operation-done (find-operation o 'load-op) c)))
318 319 320 321 322 323 324

;;;
;;; PRECOMPILED FILES
;;;
;;; This component can be used to distribute ASDF systems in precompiled form.
;;; Only useful when the dependencies have also been precompiled.
;;;
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
(with-upgradability ()
  (defmethod trivial-system-p ((s system))
    (every #'(lambda (c) (typep c 'compiled-file)) (component-children s)))

  (defmethod output-files (o (c compiled-file))
    (declare (ignorable o c))
    nil)
  (defmethod input-files (o (c compiled-file))
    (declare (ignorable o))
    (component-pathname c))
  (defmethod perform ((o load-op) (c compiled-file))
    (perform-lisp-load-fasl o c))
  (defmethod perform ((o load-source-op) (c compiled-file))
    (perform (find-operation o 'load-op) c))
  (defmethod perform ((o load-fasl-op) (c compiled-file))
    (perform (find-operation o 'load-op) c))
  (defmethod perform (o (c compiled-file))
    (declare (ignorable o c))
    nil))
344 345 346 347

;;;
;;; Pre-built systems
;;;
348 349 350 351
(with-upgradability ()
  (defmethod trivial-system-p ((s prebuilt-system))
    (declare (ignorable s))
    t)
352

353 354 355
  (defmethod perform ((o lib-op) (c prebuilt-system))
    (declare (ignorable o c))
    nil)
356

357 358 359
  (defmethod component-depends-on ((o lib-op) (c prebuilt-system))
    (declare (ignorable o c))
    nil)
360

361 362 363
  (defmethod component-depends-on ((o monolithic-lib-op) (c prebuilt-system))
    (declare (ignorable o))
    nil))
364

365

366 367 368
;;;
;;; PREBUILT SYSTEM CREATOR
;;;
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
(with-upgradability ()
  (defmethod output-files ((o binary-op) (s system))
    (list (make-pathname :name (component-name s) :type "asd"
                         :defaults (component-pathname s))))

  (defmethod perform ((o binary-op) (s system))
    (let* ((dependencies (component-depends-on o s))
           (fasl (first (apply #'output-files (first dependencies))))
           (library (first (apply #'output-files (second dependencies))))
           (asd (first (output-files o s)))
           (name (pathname-name asd))
           (name-keyword (intern (string name) (find-package :keyword))))
      (with-open-file (s asd :direction :output :if-exists :supersede
                             :if-does-not-exist :create)
        (format s ";;; Prebuilt ASDF definition for system ~A" name)
        (format s ";;; Built for ~A ~A on a ~A/~A ~A"
                (lisp-implementation-type)
                (lisp-implementation-version)
                (software-type)
                (machine-type)
                (software-version))
        (let ((*package* (find-package :keyword)))
          (pprint `(defsystem ,name-keyword
392 393
                     :class prebuilt-system
                     :components ((:compiled-file ,(pathname-name fasl)))
394
                     :lib ,(and library (file-namestring library)))
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
                  s)))))

  #-(or ecl mkcl)
  (defmethod perform ((o fasl-op) (c system))
    (let* ((input-files (input-files o c))
           (fasl-files (remove (compile-file-type) input-files :key #'pathname-type :test-not #'string=))
           (non-fasl-files (remove (compile-file-type) input-files :key #'pathname-type :test #'string=))
           (output-files (output-files o c))
           (output-file (first output-files)))
      (unless input-files (format t "WTF no input-files for ~S on ~S !???" o c))
      (when input-files
        (assert output-files)
        (when non-fasl-files
          (error "On ~A, asdf-bundle can only bundle FASL files, but these were also produced: ~S"
                 (implementation-type) non-fasl-files))
        (when (and (typep o 'monolithic-bundle-op)
                   (or (monolithic-op-prologue-code o) (monolithic-op-epilogue-code o)))
          (error "prologue-code and epilogue-code are not supported on ~A"
                 (implementation-type)))
        (with-staging-pathname (output-file)
          (combine-fasls fasl-files output-file)))))

  (defmethod input-files ((o load-op) (s precompiled-system))
    (declare (ignorable o))
    (bundle-output-files (find-operation o 'fasl-op) s))

  (defmethod component-depends-on ((o load-fasl-op) (s precompiled-system))
    (declare (ignorable o))
    `((load-op ,s) ,@(call-next-method))))

  #| ;; Example use:
426 427 428 429 430
(asdf:defsystem :precompiled-asdf-utils :class asdf::precompiled-system :fasl (asdf:apply-output-translations (asdf:system-relative-pathname :asdf-utils "asdf-utils.system.fasl")))
(asdf:load-system :precompiled-asdf-utils)
|#

#+ecl
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
(with-upgradability ()
  (defmethod perform ((o bundle-op) (c system))
    (let* ((object-files (input-files o c))
           (output (output-files o c))
           (bundle (first output))
           (kind (bundle-type o)))
      (create-image
       bundle (append object-files (bundle-op-lisp-files o))
       :kind kind
       :entry-point (component-entry-point c)
       :prologue-code
       (when (typep o 'monolithic-bundle-op)
         (monolithic-op-prologue-code o))
       :epilogue-code
       (when (typep o 'monolithic-bundle-op)
         (monolithic-op-epilogue-code o))
       :build-args (bundle-op-build-args o)))))
448 449

#+mkcl
450
(with-upgradability ()
451 452 453
  (defmethod perform ((o lib-op) (s system))
    (apply #'compiler::build-static-library (first output)
           :lisp-object-files (input-files o s) (bundle-op-build-args o)))
454

455 456 457
  (defmethod perform ((o fasl-op) (s system))
    (apply #'compiler::build-bundle (second output)
           :lisp-object-files (input-files o s) (bundle-op-build-args o)))
458

459
  (defun bundle-system (system &rest args &key force (verbose t) version &allow-other-keys)
460 461
    (declare (ignore force verbose version))
    (apply #'operate 'binary-op system args)))
462 463

#+(or ecl mkcl)
464 465 466 467
(with-upgradability ()
  (defun register-pre-built-system (name)
    (register-system (make-instance 'system :name (coerce-name name) :source-file nil))))