;;;; This file contains parts of the Alien implementation that
;;;; are not part of the compiler.

;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.

(in-package "SB-ALIEN")

#-sb-xc-host (sb-impl::define-thread-local *saved-fp* nil)

(defvar *default-c-string-external-format* nil)


;;;; utility functions

(defun align-offset (offset alignment)
  (let ((extra (rem offset alignment)))
    (if (zerop extra) offset (+ offset (- alignment extra)))))

(defun guess-alignment (bits)
  (cond ((null bits) nil)
        #-(or (and x86 (not win32)) (and ppc darwin)) ((> bits 32) 64)
        ((> bits 16) 32)
        ((> bits 8) 16)
        ((> bits 1) 8)
        (t 1)))


;;;; ALIEN-TYPE-INFO stuff

(defglobal *alien-type-classes* (make-array 32 :initial-element nil))
(declaim (simple-vector *alien-type-classes*))

(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)

(defconstant type-hash-nbits (- sb-vm:n-positive-fixnum-bits 5))
(defun alien-type-class-id (type)
  (ldb (byte 5 type-hash-nbits) (alien-type-hash type)))
(defun alien-type-class (type)
  (aref *alien-type-classes* (alien-type-class-id type)))

;;; Despite the minor annoyance of having to hand-code this list,
;;; building up the name->id mapping dynamically from forms seen
;;; at compile-time is frankly not worth the extra effort.
(defun alien-type-class-name->id (name)
  (or (position name '(root integer boolean enum float single-float double-float
                       system-area-pointer alien-value pointer mem-block array
                       record fun values c-string))
      (error "alien-type-class ~S does not have an index" name)))

(defstruct (alien-type-class (:copier nil))
  (name nil :type symbol)
  (defstruct-name nil :type symbol)
  (include nil :type (or null alien-type-class))
  (unparse nil :type (or null function))
  (type= nil :type (or null function))
  (lisp-rep nil :type (or null function))
  (alien-rep nil :type (or null function))
  (extract-gen nil :type (or null function))
  (deposit-gen nil :type (or null function))
  (naturalize-gen nil :type (or null function))
  (deport-gen nil :type (or null function))
  (deport-alloc-gen nil :type (or null function))
  (deport-pin-p nil :type (or null function))
  ;; Cast?
  (arg-tn nil :type (or null function))
  (result-tn nil :type (or null function))
  (subtypep nil :type (or null function)))

(defmethod print-object ((type-class alien-type-class) stream)
  (print-unreadable-object (type-class stream :type t)
    (prin1 (alien-type-class-name type-class) stream)))

(defun alien-type-class-or-lose (name)
  ;; Linear search is perfectly ok here, as it is not performance-critical
  (dovector (x *alien-type-classes* (error "no alien type class ~S" name))
    (when (and x (eq (alien-type-class-name x) name))
      (return x))))

(defun create-alien-type-class-if-necessary (name defstruct-name include)
  (let* ((id (alien-type-class-name->id name))
         (old (aref *alien-type-classes* id))
         (include (and include (alien-type-class-or-lose include))))
    (if old
        (setf (alien-type-class-include old) include)
        (let ((new (make-alien-type-class :name name
                                     :defstruct-name defstruct-name
                                     :include include)))
          (setf (aref *alien-type-classes* id) new)))))

(defconstant-eqx +method-slot-alist+
  '((:unparse . alien-type-class-unparse)
    (:type= . alien-type-class-type=)
    (:subtypep . alien-type-class-subtypep)
    (:lisp-rep . alien-type-class-lisp-rep)
    (:alien-rep . alien-type-class-alien-rep)
    (:extract-gen . alien-type-class-extract-gen)
    (:deposit-gen . alien-type-class-deposit-gen)
    (:naturalize-gen . alien-type-class-naturalize-gen)
    (:deport-gen . alien-type-class-deport-gen)
    (:deport-alloc-gen . alien-type-class-deport-alloc-gen)
    (:deport-pin-p . alien-type-class-deport-pin-p)
    ;; cast?
    (:arg-tn . alien-type-class-arg-tn)
    (:result-tn . alien-type-class-result-tn))
  #'equal)

(defun method-slot (method)
  (cdr (or (assoc method +method-slot-alist+)
           (error "no method ~S" method))))

) ; EVAL-WHEN

(defglobal *hashset-defining-forms* nil)

(defmacro define-alien-type-class ((name &key include include-args) &rest slots)
  (binding*
      ((defstruct-name (symbolicate "ALIEN-" name "-TYPE"))
       ((include include-defstruct overrides)
        (etypecase include
          (null   (values nil 'alien-type nil))
          (symbol (values include
                          (alien-type-class-defstruct-name
                           (alien-type-class-or-lose include))
                          nil))
          (list   (values (car include)
                          (alien-type-class-defstruct-name
                           (alien-type-class-or-lose (car include)))
                          (cdr include)))))
       (allocator (symbolicate "!ALLOC-" defstruct-name))
       (allocator-args `(bits alignment ,@include-args
                              ,@(mapcar (lambda (x) (if (atom x) x (car x))) slots)))
       (constructor (symbolicate "!MAKE-" defstruct-name))
       (constructor-args
        (mapcar (lambda (s) (or (assoc (the symbol s) overrides) s))
                allocator-args))
       (hashset
        ;; FLOAT, MEM-BLOCK, and ALIEN-VALUE have no direct instances.
        ;; (This naming is confusing AF - ALIEN-VALUE means ALIEN-ALIEN-VALUE-TYPE)
        ;; float subtypes and SAP each have 1 instance.
        ;; ENUM and RECORD have handwritten caching constructors.
        (unless (member name '(float mem-block alien-value
                               single-float double-float system-area-pointer
                               record enum))
          (symbolicate "*" defstruct-name "-CACHE*"))))
    `(progn
       (eval-when (:compile-toplevel :load-toplevel :execute)
         (create-alien-type-class-if-necessary ',name ',defstruct-name
                                               ',(or include 'root)))
       (setf (info :source-location :alien-type ',name) (sb-c:source-location))
       (declaim (inline ,allocator))
       (defstruct (,defstruct-name (:include ,include-defstruct)
                                   (:copier nil)
                                   (:constructor ,allocator (hash ,@allocator-args)))
         ,@slots)
       ,@(cond
           (hashset
            `((eval-when (:compile-toplevel :execute)
                (setq *hashset-defining-forms*
                      (cons '(,name ,hashset
                              ,(package-symbolicate "SB-ALIEN" "MAKE-" defstruct-name)
                              ,constructor-args ,allocator ,allocator-args)
                            (remove ',name *hashset-defining-forms* :key 'car))))))
           ((member name '(record enum))
            ;; The keyword constructor is just a passthrough to the BOA constructor.
            ;; The parser itself understands how to hash-cons these.
            `((declaim (inline ,constructor))
              (defun ,constructor (&key ,@constructor-args)
                (let ((hash ,(ash (alien-type-class-name->id name) type-hash-nbits)))
                  (,allocator hash ,@allocator-args)))))
           ((member name '(single-float double-float system-area-pointer)) ; singletons
            `((declaim (inline ,constructor))
              (defun ,constructor (&key ,@constructor-args)
                (let ((hash ,(logior (ash (alien-type-class-name->id name) type-hash-nbits)
                                     (ldb (byte type-hash-nbits 0) (sb-xc:sxhash name)))))
                  (,allocator hash ,@allocator-args)))))))))

(defmacro define-alien-type-method ((class method) lambda-list &rest body)
  (let ((defun-name (symbolicate class "-" method "-METHOD")))
    `(progn
       (defun ,defun-name ,lambda-list
         ,@(when (eq method :unparse) `((declare (ignorable ,(second lambda-list)))))
         ,@body)
       (setf (,(method-slot method) (alien-type-class-or-lose ',class))
             #',defun-name))))

(defmacro invoke-alien-type-method (method type &rest args)
  (let ((slot (method-slot method)))
    (once-only ((type type))
      `(funcall (do ((class (alien-type-class ,type)
                            (alien-type-class-include class)))
                    ((null class)
                     (error "method ~S not defined for ~S"
                            ',method (alien-type-class ,type)))
                  (let ((fn (,slot class)))
                    (when fn
                      (return fn))))
                ,type ,@args))))


;;;; the root alien type

(eval-when (:compile-toplevel :load-toplevel :execute)
  (create-alien-type-class-if-necessary 'root 'alien-type nil))


;;;; type parsing and unparsing

(defvar *new-auxiliary-types* nil)

;;; Process stuff in a new scope.
(defmacro with-auxiliary-alien-types (env &body body)
  ``(symbol-macrolet ((&auxiliary-type-definitions&
                       ,(append *new-auxiliary-types*
                                (auxiliary-type-definitions ,env))))
      ,(let ((*new-auxiliary-types* nil))
         ,@body)))

;;; CMU CL used COMPILER-LET to bind *AUXILIARY-TYPE-DEFINITIONS*, and
;;; COMPILER-LET is no longer supported by ANSI or SBCL. Instead, we
;;; follow the suggestion in CLTL2 of using SYMBOL-MACROLET to achieve
;;; a similar effect.
(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
  (defun auxiliary-type-definitions (env)
    (multiple-value-bind (result expanded-p)
        (%macroexpand '&auxiliary-type-definitions& env)
      (if expanded-p
          result
          ;; This is like having the global symbol-macro definition be
          ;; NIL, but global symbol-macros make me vaguely queasy, so
          ;; I do it this way instead.
          nil))))

;;; Parse TYPE as an alien type specifier and return the resultant
;;; ALIEN-TYPE structure.
(defun parse-alien-type (type env)
  (declare (type sb-kernel:lexenv-designator env))
  (if (consp type)
      (let ((translator (info :alien-type :translator (car type))))
        (unless translator
          (error "unknown alien type: ~/sb-impl:print-type-specifier/"
                 type))
        (funcall translator type env))
      (ecase (info :alien-type :kind type)
        (:primitive
         (let ((translator (info :alien-type :translator type)))
           (unless translator
             (error "no translator for primitive alien type ~
                      ~/sb-impl:print-type-specifier/"
                    type))
           (funcall translator (list type) env)))
        (:defined
         (or (info :alien-type :definition type)
             (error "no definition for alien type ~/sb-impl:print-type-specifier/"
                    type)))
        (:unknown
         (error "unknown alien type: ~/sb-impl:print-type-specifier/"
                type)))))

(defun auxiliary-alien-type (kind name env)
  (declare (type sb-kernel:lexenv-designator env))
  (flet ((aux-defn-matches (x)
           (and (eq (first x) kind) (eq (second x) name))))
    (let ((in-auxiliaries
           (or (find-if #'aux-defn-matches *new-auxiliary-types*)
               (find-if #'aux-defn-matches (auxiliary-type-definitions env)))))
      (if in-auxiliaries
          (values (third in-auxiliaries) t)
          (info :alien-type kind name)))))

(defun (setf auxiliary-alien-type) (new-value kind name env)
  (declare (type sb-kernel:lexenv-designator env))
  (flet ((aux-defn-matches (x)
           (and (eq (first x) kind) (eq (second x) name))))
    (when (find-if #'aux-defn-matches *new-auxiliary-types*)
      (error "attempt to multiply define ~A ~S" kind name))
    (when (find-if #'aux-defn-matches (auxiliary-type-definitions env))
      (error "attempt to shadow definition of ~A ~S" kind name)))
  (push (list kind name new-value) *new-auxiliary-types*)
  new-value)

(defun verify-local-auxiliaries-okay ()
  (dolist (info *new-auxiliary-types*)
    (destructuring-bind (kind name defn) info
      (declare (ignore defn))
      (when (info :alien-type kind name)
        (error "attempt to shadow definition of ~A ~S" kind name)))))

(defun unparse-alien-type (type &optional abbreviate)
  "Convert the alien-type structure TYPE back into a list specification of
   the type."
  (declare (type alien-type type))
  (dx-let ((state (cons abbreviate nil)))
    (%unparse-alien-type state type)))

;;; Does all the work of UNPARSE-ALIEN-TYPE without rebinding the STATE.
(defun %unparse-alien-type (state type)
  (invoke-alien-type-method :unparse type state))
(defun %unparse-alien-types (state list)
  (mapcar (lambda (x) (%unparse-alien-type state x)) list))

;;;; alien type defining stuff

(defmacro define-alien-type-translator (name lambda-list &body body)
  (let ((defun-name (symbolicate "ALIEN-" name "-TYPE-TRANSLATOR"))
        (macro-lambda
         (make-macro-lambda nil lambda-list body
                            'define-alien-type-translator name)))
    `(progn
       (defun ,defun-name ,(second macro-lambda) ,@(cddr macro-lambda))
       (%define-alien-type-translator ',name #',defun-name))))

(defun %define-alien-type-translator (name translator)
  (setf (info :alien-type :kind name) :primitive)
  (setf (info :alien-type :translator name) translator)
  (clear-info :alien-type :definition name)
  name)

(defmacro define-alien-type (name type &environment env)
  "Define the alien type NAME to be equivalent to TYPE. Name may be NIL for
   STRUCT and UNION types, in which case the name is taken from the type
   specifier."
  (declare (symbol name))
  (with-auxiliary-alien-types env
    (let ((alien-type (parse-alien-type type env)))
      `(eval-when (:compile-toplevel :load-toplevel :execute)
         ,@(when *new-auxiliary-types*
             `((%def-auxiliary-alien-types ',*new-auxiliary-types*
                                           (sb-c:source-location))))
         ,@(when name
             `((%define-alien-type ',name ',alien-type (sb-c:source-location))))))))

(defun %def-auxiliary-alien-types (types source-location)
  (dolist (info types)
    ;; Clear up the type we're about to define from the toplevel
    ;; *new-auxiliary-types* (local scopes take care of themselves).
    ;; Unless this is done we never actually get back the full type
    ;; from INFO, since the *new-auxiliary-types* have precedence.
    (setf *new-auxiliary-types*
          (remove info *new-auxiliary-types*
                  :test (lambda (a b)
                          (and (eq (first a) (first b))
                               (eq (second a) (second b))))))
    (destructuring-bind (kind name defn) info
      (let ((old (info :alien-type kind name)))
        (unless (or (null old) (alien-type-= old defn))
          (warn "redefining ~A ~S to be:~%  ~S,~%was:~%  ~S"
                kind name defn old)))
      (setf (info :alien-type kind name) defn
            (info :source-location :alien-type name) source-location))))

(defun %define-alien-type (name new source-location)
  (ecase (info :alien-type :kind name)
    (:primitive
     (error "~/sb-impl:print-type-specifier/ is a built-in alien type."
            name))
    (:defined
     (let ((old (info :alien-type :definition name)))
       (unless (or (null old) (alien-type-= new old))
         (warn "redefining ~S to be:~% ~
                   ~/sb-impl:print-type-specifier/,~%was~% ~
                   ~/sb-impl:print-type-specifier/"
               name
               (unparse-alien-type new)
               (unparse-alien-type old)))))
    (:unknown))
  (setf (info :alien-type :definition name) new)
  (setf (info :alien-type :kind name) :defined)
  (setf (info :source-location :alien-type name) source-location)
  name)


;;;; Interfaces to the different methods

(defun alien-type-= (type1 type2)
  "Return T iff TYPE1 and TYPE2 describe equivalent alien types."
  (or (eq type1 type2)
      (and (eq (alien-type-class type1)
               (alien-type-class type2))
           (invoke-alien-type-method :type= type1 type2))))

(defun alien-subtype-p (type1 type2)
  "Return T iff the alien type TYPE1 is a subtype of TYPE2. Currently, the
   only supported subtype relationships are is that any pointer type is a
   subtype of (* t), and any array type first dimension will match
   (array <eltype> nil ...). Otherwise, the two types have to be
   ALIEN-TYPE-=."
  (or (eq type1 type2)
      (invoke-alien-type-method :subtypep type1 type2)))

(defun compute-naturalize-lambda (type)
  `(lambda (alien ignore)
     (declare (ignore ignore))
     ,(invoke-alien-type-method :naturalize-gen type 'alien)))

(defun compute-deport-lambda (type)
  (declare (type alien-type type))
  (/noshow "entering COMPUTE-DEPORT-LAMBDA" type)
  (multiple-value-bind (form value-type)
      (invoke-alien-type-method :deport-gen type 'value)
    `(lambda (value ignore)
       (declare (type ,(or value-type
                           (compute-lisp-rep-type type)
                           `(alien ,type))
                      value)
                (ignore ignore))
       ,form)))

(defun compute-deport-alloc-lambda (type)
  `(lambda (value ignore)
     (declare (ignore ignore))
     ,(invoke-alien-type-method :deport-alloc-gen type 'value)))

(defun compute-extract-lambda (type)
  (let ((extract (invoke-alien-type-method :extract-gen type 'sap 'offset)))
    `(lambda (sap offset ignore)
       (declare (type system-area-pointer sap)
                (type unsigned-byte offset)
                (ignore ignore))
       ,(if (eq (alien-type-class type) 'integer)
            extract
            `(naturalize ,extract ',type)))))

(defun compute-deposit-lambda (type)
  (declare (type alien-type type))
  `(lambda (value sap offset ignore)
     (declare (type system-area-pointer sap)
              (type unsigned-byte offset)
              (ignore ignore))
     (let ((alloc-tmp (deport-alloc value ',type)))
       (maybe-with-pinned-objects (alloc-tmp) (,type)
         (let ((value (deport alloc-tmp  ',type)))
           ,(invoke-alien-type-method :deposit-gen type 'sap 'offset 'value)
           ;; Note: the reason we don't just return the pre-deported value
           ;; is because that would inhibit any (deport (naturalize ...))
           ;; optimizations that might have otherwise happen. Re-naturalizing
           ;; the value might cause extra consing, but is flushable, so probably
           ;; results in better code.
           (naturalize value ',type))))))

(defun compute-lisp-rep-type (type)
  (invoke-alien-type-method :lisp-rep type))

;;; CONTEXT is either :NORMAL (the default) or :RESULT (alien function
;;; return values).  See the :ALIEN-REP method for INTEGER for
;;; details.
(defun compute-alien-rep-type (type &optional (context :normal))
  (invoke-alien-type-method :alien-rep type context))


;;;; default methods

(define-alien-type-method (root :subtypep) (type1 type2)
  (alien-type-= type1 type2))

(define-alien-type-method (root :lisp-rep) (type)
  (declare (ignore type))
  nil)

(define-alien-type-method (root :alien-rep) (type context)
  (declare (ignore type context))
  '*)

(define-alien-type-method (root :deport-alloc-gen) (type object)
  (declare (ignore type))
  object)

(define-alien-type-method (root :deport-pin-p) (type)
  (declare (ignore type))
  ;; Override this method to return T for classes which take a SAP to a
  ;; GCable lisp object when deporting.
  nil)

(define-alien-type-method (root :deposit-gen) (type sap offset value)
  `(setf ,(invoke-alien-type-method :extract-gen type sap offset) ,value))

;;;; the INTEGER type

;; INTEGER could probably rob 1 bit from the HASH field for SIGNED which would
;; reduce the structure to 4 words (down from 6 words) if #+compact-instance-header.
(define-alien-type-class (integer)
  ;; -SIGNED is mutable because of redefined ENUMs.
  ;; The new DEFINE-ALIEN-TYPE-CLASS macro doesn't handle non-nil slot defaults.
  (signed nil :type (member t nil)))

(define-alien-type-translator signed (&optional (bits sb-vm:n-word-bits))
  (make-alien-integer-type :bits bits :signed t))

(define-alien-type-translator integer (&optional (bits sb-vm:n-word-bits))
  (make-alien-integer-type :bits bits :signed t))

(define-alien-type-translator unsigned (&optional (bits sb-vm:n-word-bits))
  (make-alien-integer-type :bits bits :signed nil))

(define-alien-type-method (integer :unparse) (type state)
  (list (if (alien-integer-type-signed type) 'signed 'unsigned)
        (alien-integer-type-bits type)))

(define-alien-type-method (integer :type=) (type1 type2)
  (and (eq (alien-integer-type-signed type1)
           (alien-integer-type-signed type2))
       (= (alien-integer-type-bits type1)
          (alien-integer-type-bits type2))))

(define-alien-type-method (integer :lisp-rep) (type)
  (list (if (alien-integer-type-signed type) 'signed-byte 'unsigned-byte)
        (alien-integer-type-bits type)))

(define-alien-type-method (integer :alien-rep) (type context)
  ;; When returning integer values that are narrower than a machine
  ;; register from a function, some platforms leave the higher bits of
  ;; the register uninitialized.  On those platforms, we use an
  ;; alien-rep of the full register width when checking for purposes
  ;; of return values and override the naturalize method to perform
  ;; the sign extension (in compiler/{arch}/c-call.lisp).
  (ecase context
    ((:normal #-(or x86 x86-64) :result)
     (list (if (alien-integer-type-signed type) 'signed-byte 'unsigned-byte)
           (alien-integer-type-bits type)))
    #+(or x86 x86-64)
    (:result
     (list (if (alien-integer-type-signed type) 'signed-byte 'unsigned-byte)
           (max (alien-integer-type-bits type)
                sb-vm:n-machine-word-bits)))))

;;; As per the comment in the :ALIEN-REP method above, this is defined
;;; elsewhere for x86oids.
#-(or x86 x86-64)
(define-alien-type-method (integer :naturalize-gen) (type alien)
  (declare (ignore type))
  alien)

(define-alien-type-method (integer :deport-gen) (type value)
  (declare (ignore type))
  value)

(defun alien-integer->sap-ref-fun (signed bits)
  (if signed
      (case bits
        (8 'signed-sap-ref-8)
        (16 'signed-sap-ref-16)
        (32 'signed-sap-ref-32)
        (64 'signed-sap-ref-64))
      (case bits
        (8 'sap-ref-8)
        (16 'sap-ref-16)
        (32 'sap-ref-32)
        (64 'sap-ref-64))))

(define-alien-type-method (integer :extract-gen) (type sap offset)
  (declare (type alien-integer-type type))
  (let ((ref-fun (alien-integer->sap-ref-fun (alien-integer-type-signed type)
                                             (alien-integer-type-bits type))))
    (if ref-fun
        `(,ref-fun ,sap (/ ,offset sb-vm:n-byte-bits))
        (error "cannot extract ~W-bit integers"
               (alien-integer-type-bits type)))))

;;;; the BOOLEAN type

;;; INCLUDE-ARGS is just because DEFINE-ALIEN-TYPE-CLASS is too naive to insert
;;; ancestor arguments into the expansion of the derived class's defun.
(define-alien-type-class (boolean :include integer :include-args (signed)))

(define-alien-type-translator boolean (&optional (bits sb-vm:n-word-bits))
  (make-alien-boolean-type :bits bits :signed nil))

(define-alien-type-method (boolean :unparse) (type state)
  `(boolean ,(alien-boolean-type-bits type)))

(define-alien-type-method (boolean :lisp-rep) (type)
  (declare (ignore type))
  `(member t nil))

(define-alien-type-method (boolean :naturalize-gen) (type alien)
  (let ((bits (alien-boolean-type-bits type)))
    (if (= bits sb-vm:n-word-bits)
        `(not (zerop ,alien))
        `(logtest ,alien ,(ldb (byte bits 0) -1)))))

(define-alien-type-method (boolean :deport-gen) (type value)
  (declare (ignore type))
  `(if ,value 1 0))

;;;; the ENUM type

(define-alien-type-class (enum :include (integer (bits 32))
                               :include-args (signed))
  ;; These are all mutable. I'm not sure why we allow ENUMs to be
  ;; destructively modified rather than creating new instances.
  ;; Anyway, these instances get hash-consed, and if you do something to
  ;; mess up the hash-consing, well, ... that's your problem I guess?
  name          ; name of this enum (if any)
  from          ; alist from symbols to integers
  to            ; alist or vector from integers to symbols
  kind          ; kind of from mapping, :VECTOR or :ALIST
  offset)       ; offset to add to value for :VECTOR from mapping

(define-alien-type-method (enum :type=) (type1 type2)
  (and (eq (alien-enum-type-name type1) (alien-enum-type-name type2))
       (= (alien-enum-type-hash type1) (alien-enum-type-hash type2))
       (equal (alien-enum-type-from type1)
              (alien-enum-type-from type2))))

;;; Anonymous enums are hash-consed. Named ones don't need to be hash-consed,
;;; because there is at most one instance of the named enum in any environment.
(define-load-time-global *enum-type-cache*
  (make-hashset 32 #'enum-type=-method #'alien-type-hash
                :weakness t :synchronized t))

(macrolet
    ((calc-enum-hash ()
           ;; Slots which are pure functions of the mapping need not be mixed in:
           ;; * KIND is based on density of the numeric range
           ;; * SIGNED is true if and only if the minimum value is negative
           ;; * OFFSET is based on the minimum value if and only if the
           ;;   inverse map is stored as is a vector
       `(let ((h (sb-xc:sxhash name)))
          (dolist (elt (alien-enum-type-from result))
            ;; Mix by hand since our SXHASH has a cutoff on length, not to
            ;; mention that this potentially runs on either the host or the target,
            ;; and the host does't emulate the target's hashing of lists.
            (setf h (mix (mix (sb-xc:sxhash (car elt)) (sb-xc:sxhash (cdr elt)))
                         h)))
          (setf (ldb (byte type-hash-nbits 0) (alien-type-hash result)) h))))

(define-alien-type-translator enum (&whole
                                 type name
                                 &rest mappings
                                 &environment env)
  (declare (inline !make-alien-enum-type))
  (cond (mappings
         (dx-let ((result (!make-alien-enum-type :alignment (guess-alignment 32)
                                                 :name name)))
           (%parse-enum mappings result)
           (calc-enum-hash)
           (unless name
             (return-from alien-enum-type-translator
               (hashset-insert-if-absent *enum-type-cache* result #'sys-copy-struct)))
           (multiple-value-bind (old old-p) (auxiliary-alien-type :enum name env)
             (cond
               (old-p
                (unless (alien-type-= result old)
                   (cerror "Continue, clobbering the old definition"
                           "Incompatible alien enum type definition: ~S" name)
                   (setf (alien-enum-type-from old) (alien-enum-type-from result)
                         (alien-enum-type-hash old) (alien-enum-type-hash result)
                         (alien-enum-type-to old) (alien-enum-type-to result)
                         (alien-enum-type-kind old) (alien-enum-type-kind result)
                         (alien-enum-type-offset old) (alien-enum-type-offset result)
                         (alien-enum-type-signed old) (alien-enum-type-signed result)))
                old)
               (t
                (setf (auxiliary-alien-type :enum name env)
                      (sys-copy-struct result)))))))
        (name
         (multiple-value-bind (result found)
             (auxiliary-alien-type :enum name env)
           (unless found
             (error "unknown enum type: ~S" name))
           result))
        (t
         (error "empty enum type: ~S" type))))

(defun load-alien-enum (name mappings)
  (declare (inline !make-alien-enum-type))
  (dx-let ((result (!make-alien-enum-type :alignment (guess-alignment 32) :name name)))
    ;; dumped as dotted pairs, but re-parsed as 2-lists
    (%parse-enum (mapcar (lambda (x) (list (car x) (cdr x))) mappings)
                 result)
    (calc-enum-hash)
    (hashset-insert-if-absent *enum-type-cache* result #'sys-copy-struct))))

(defun %parse-enum (elements result)
  (when (null elements)
    (error "An enumeration must contain at least one element."))
  (let ((min nil)
        (max nil)
        (from-alist ())
        (prev -1))
    (declare (list from-alist))
    (dolist (el elements)
      (multiple-value-bind (sym val)
          (if (listp el)
              (values (first el) (second el))
              (values el (1+ prev)))
        (setf prev val)
        (unless (symbolp sym)
          (error "The enumeration element ~S is not a symbol." sym))
        (unless (integerp val)
          (error "The element value ~S is not an integer." val))
        (unless (and max (> max val)) (setq max val))
        (unless (and min (< min val)) (setq min val))
        (when (rassoc val from-alist)
          (style-warn "The element value ~S is used more than once." val))
        (when (assoc sym from-alist :test #'eq)
          (error "The enumeration element ~S is used more than once." sym))
        (push (cons sym val) from-alist)))
    (let* ((signed (minusp min))
           (min-bits (if signed
                         (1+ (max (integer-length min)
                                  (integer-length max)))
                         (integer-length max))))
      (when (> min-bits 32)
        (error "can't represent enums needing more than 32 bits"))
      (setf (alien-enum-type-signed result) signed)
      (setf from-alist (sort from-alist #'< :key #'cdr))
      (cond
       ;; If range is at least 20% dense, use vector mapping. Crossover
       ;; point solely on basis of space would be 25%. Vector mapping
       ;; is always faster, so give the benefit of the doubt.
       ((>= (/ (length from-alist) (1+ (- max min))) 2/10)
        ;; If offset is small and ignorable, ignore it to save time.
        (when (< 0 min 10) (setq min 0))
        (let ((to (make-array (1+ (- max min)))))
          (dolist (el from-alist)
            (setf (svref to (- (cdr el) min)) (car el)))
          (setf (alien-enum-type-to result) to))
        (setf (alien-enum-type-offset result) (- min)
              (alien-enum-type-kind result) :vector))
       (t
        (setf (alien-enum-type-to result) (mapcar (lambda (x) (cons (cdr x) (car x)))
                                                  from-alist)
              (alien-enum-type-offset result) nil
              (alien-enum-type-kind result) :alist)))
      (setf (alien-enum-type-from result) from-alist))))

(define-alien-type-method (enum :unparse) (type state)
  `(enum ,(alien-enum-type-name type)
         ,@(let ((prev -1))
             (mapcar (lambda (mapping)
                       (let ((sym (car mapping))
                             (value (cdr mapping)))
                         (prog1
                             (if (= (1+ prev) value)
                                 sym
                                 `(,sym ,value))
                           (setf prev value))))
                     (alien-enum-type-from type)))))

(define-alien-type-method (enum :lisp-rep) (type)
  `(member ,@(mapcar #'car (alien-enum-type-from type))))

(define-alien-type-method (enum :naturalize-gen) (type alien)
  (ecase (alien-enum-type-kind type)
    (:vector
     `(svref ',(alien-enum-type-to type)
             (+ ,alien ,(alien-enum-type-offset type))))
    (:alist
     `(ecase ,alien
        ,@(mapcar (lambda (mapping)
                    `(,(car mapping) ',(cdr mapping)))
                  (alien-enum-type-to type))))))

(define-alien-type-method (enum :deport-gen) (type value)
  `(ecase ,value
     ,@(mapcar (lambda (mapping)
                 `(,(car mapping) ,(cdr mapping)))
               (alien-enum-type-from type))))

;;;; the FLOAT types

(define-alien-type-class (float)
  ;; This seems nuts to define subtypes of the FLOAT type
  ;; but we also keep the Lisp type in a slot. Why do that?
  (type (missing-arg) :type symbol :read-only t))

(define-alien-type-method (float :unparse) (type state)
  (alien-float-type-type type))

(define-alien-type-method (float :lisp-rep) (type)
  (alien-float-type-type type))

(define-alien-type-method (float :alien-rep) (type context)
  (declare (ignore context))
  (alien-float-type-type type))

(define-alien-type-method (float :naturalize-gen) (type alien)
  (declare (ignore type))
  alien)

(define-alien-type-method (float :deport-gen) (type value)
  (declare (ignore type))
  value)

(define-alien-type-class (single-float :include (float)
                                       :include-args (type)))

(define-alien-type-method (single-float :extract-gen) (type sap offset)
  (declare (ignore type))
  `(sap-ref-single ,sap (/ ,offset sb-vm:n-byte-bits)))

(define-alien-type-class (double-float :include (float)
                                       :include-args (type)))

(define-alien-type-method (double-float :extract-gen) (type sap offset)
  (declare (ignore type))
  `(sap-ref-double ,sap (/ ,offset sb-vm:n-byte-bits)))


;;;; the SAP type

(define-alien-type-class (system-area-pointer))

(define-alien-type-method (system-area-pointer :unparse) (type state)
  (declare (ignore type))
  'system-area-pointer)

(define-alien-type-method (system-area-pointer :lisp-rep) (type)
  (declare (ignore type))
  'system-area-pointer)

(define-alien-type-method (system-area-pointer :alien-rep) (type context)
  (declare (ignore type context))
  'system-area-pointer)

(define-alien-type-method (system-area-pointer :naturalize-gen) (type alien)
  (declare (ignore type))
  alien)

(define-alien-type-method (system-area-pointer :deport-gen) (type object)
  (declare (ignore type))
  (/noshow "doing alien type method SYSTEM-AREA-POINTER :DEPORT-GEN" object)
  object)

(define-alien-type-method (system-area-pointer :extract-gen) (type sap offset)
  (declare (ignore type))
  `(sap-ref-sap ,sap (/ ,offset sb-vm:n-byte-bits)))

(macrolet
    ((def-singleton-type (type bits (ctor &rest rest))
       `(progn
          ;; Two alien-type instances can be TYPE= only if in the same type-class,
          ;; which is ascertained by the API. So the method on singletons can
          ;; always return T.
          (setf (alien-type-class-type= (alien-type-class-or-lose ',type)) #'constantly-t)
          (define-alien-type-translator ,type ()
                 ;; If the host lisp takes liberties (as permitted) with ordering ordering of
                 ;; L-T-V and toplevel forms, then it's quite likely clever enough to inline
                 ;; the structure constructor here, thus avoiding reliance on the DEFUN
                 ;; which might not be installed yet.
            (load-time-value
             (locally (declare (inline ,ctor))
               (,ctor :alignment (guess-alignment ,bits) :bits ,bits ,@rest))
             t)))))
  (def-singleton-type single-float 32 (!make-alien-single-float-type :type 'single-float))
  (def-singleton-type double-float 64 (!make-alien-double-float-type :type 'double-float))
  (def-singleton-type system-area-pointer sb-vm:n-machine-word-bits
      (!make-alien-system-area-pointer-type)))

;;;; the ALIEN-VALUE type

(define-alien-type-class (alien-value :include system-area-pointer))

(define-alien-type-method (alien-value :lisp-rep) (type)
  (declare (ignore type))
  nil)

(define-alien-type-method (alien-value :naturalize-gen) (type alien)
  `(%sap-alien ,alien ',type))

(define-alien-type-method (alien-value :deport-gen) (type value)
  (declare (ignore type))
  (/noshow "doing alien type method ALIEN-VALUE :DEPORT-GEN" value)
  `(alien-sap ,value))


;;;; the POINTER type

(define-alien-type-class (pointer :include (alien-value (bits
                                                         sb-vm:n-machine-word-bits)))
  (to nil :type (or alien-type null) :read-only t))

(define-alien-type-class (c-string :include (pointer
                                             (bits sb-vm:n-machine-word-bits))
                                   :include-args (to))
  (external-format :default :type keyword :read-only t)
  (element-type 'character :type (member character base-char) :read-only t)
  (not-null nil :type boolean :read-only t))

(define-alien-type-translator * (to &environment env)
  (make-alien-pointer-type :to (if (eq to t) nil (parse-alien-type to env))))

(define-alien-type-method (pointer :unparse) (type state)
  (let ((to (alien-pointer-type-to type)))
    `(* ,(if to (%unparse-alien-type state to) t))))

(define-alien-type-method (pointer :type=) (type1 type2)
  (let ((to1 (alien-pointer-type-to type1))
        (to2 (alien-pointer-type-to type2)))
    (if to1
        (if to2
            (alien-type-= to1 to2)
            nil)
        (null to2))))

(define-alien-type-method (pointer :subtypep) (type1 type2)
  (and (alien-pointer-type-p type2)
       (let ((to1 (alien-pointer-type-to type1))
             (to2 (alien-pointer-type-to type2)))
         (if to1
             (if to2
                 (alien-subtype-p to1 to2)
                 t)
             (null to2)))))

(define-alien-type-method (pointer :deport-gen) (type value)
  (/noshow "doing alien type method POINTER :DEPORT-GEN" type value)
  (values
   ;; FIXME: old version, highlighted a bug in xc optimization
   `(etypecase ,value
      (null
       (int-sap 0))
      (system-area-pointer
       ,value)
      ((alien ,type)
       (alien-sap ,value)))
   ;; new version, works around bug in xc optimization
   #+nil
   `(etypecase ,value
      (system-area-pointer
       ,value)
      ((alien ,type)
       (alien-sap ,value))
      (null
       (int-sap 0)))
   `(or null system-area-pointer (alien ,type))))

;;;; the MEM-BLOCK type

(define-alien-type-class (mem-block :include alien-value))

(define-alien-type-method (mem-block :extract-gen) (type sap offset)
  (declare (ignore type))
  `(sap+ ,sap (truncate ,offset sb-vm:n-byte-bits)))

(define-alien-type-method (mem-block :deposit-gen) (type sap offset value)
  (let ((bits (alien-mem-block-type-bits type)))
    (unless bits
      (error "can't deposit aliens of type ~S (unknown size)" type))
    `(sb-kernel:system-area-ub8-copy ,value 0 ,sap
      (truncate ,offset sb-vm:n-byte-bits)
      ',(truncate bits sb-vm:n-byte-bits))))

;;;; the ARRAY type

(define-alien-type-class (array :include mem-block)
  (element-type (missing-arg) :type alien-type :read-only t)
  (dimensions (missing-arg) :type list :read-only t))

(define-alien-type-translator array (ele-type &rest dims &environment env)

  (when dims
    (unless (typep (first dims) '(or index null))
      (error "The first dimension is not a non-negative fixnum or NIL: ~S"
             (first dims)))
    (let ((loser (find-if-not (lambda (x) (typep x 'index))
                              (rest dims))))
      (when loser
        (error "A dimension is not a non-negative fixnum: ~S" loser))))

  (let ((parsed-ele-type (parse-alien-type ele-type env)))
    (make-alien-array-type
     :element-type parsed-ele-type
     :dimensions dims
     :alignment (alien-type-alignment parsed-ele-type)
     :bits (if (and (alien-type-bits parsed-ele-type)
                    (every #'integerp dims))
               (* (align-offset (alien-type-bits parsed-ele-type)
                                (alien-type-alignment parsed-ele-type))
                  (reduce #'* dims))))))

(define-alien-type-method (array :unparse) (type state)
  `(array ,(%unparse-alien-type state (alien-array-type-element-type type))
          ,@(alien-array-type-dimensions type)))

(define-alien-type-method (array :type=) (type1 type2)
  (and (equal (alien-array-type-dimensions type1)
              (alien-array-type-dimensions type2))
       (alien-type-= (alien-array-type-element-type type1)
                     (alien-array-type-element-type type2))))

(define-alien-type-method (array :subtypep) (type1 type2)
  (and (alien-array-type-p type2)
       (let ((dim1 (alien-array-type-dimensions type1))
             (dim2 (alien-array-type-dimensions type2)))
         (and (= (length dim1) (length dim2))
              (or (and dim2
                       (null (car dim2))
                       (equal (cdr dim1) (cdr dim2)))
                  (equal dim1 dim2))
              (alien-subtype-p (alien-array-type-element-type type1)
                               (alien-array-type-element-type type2))))))

;;;; the RECORD type

(defstruct (alien-record-field (:constructor make-alien-record-field (name offset type))
                               (:copier nil))
  (name (missing-arg) :type symbol :read-only t)
  (type (missing-arg) :type alien-type :read-only t)
  (offset 0 :type unsigned-byte))
(defmethod print-object ((field alien-record-field) stream)
  (print-unreadable-object (field stream :type t)
    (format stream
            "~S ~S"
            (alien-record-field-type field)
            (alien-record-field-name field))))
(!set-load-form-method alien-record-field (:xc :target))

(define-alien-type-class (record :include mem-block)
  (kind :struct :type (member :struct :union) :read-only t)
  (name nil :type (or symbol null) :read-only t)
  (fields nil :type list)) ; mutable because of structural recursion and parser

(defun hash-alien-record-type (r)
  (declare (notinline sb-xc:sxhash))
  (labels ((hash-fields (fields)
             (let ((h (length fields)))
               (dolist (field fields h)
                 (setq h (mix h (hash-field field))))))
           (hash-field (field)
             (mix (mix (hash-sym (alien-record-field-name field))
                       (sb-xc:sxhash (alien-record-field-offset field)))
                  (alien-type-hash (alien-record-field-type field))))
           (hash-sym (symbol)
             ;; Since ALIEN-TYPE literals are reconstructed via load-forms that involve
             ;; the constructor, host object hashes don't have to be target-compatible.
             #+sb-xc-host (sb-xc:sxhash symbol)
             ;; This mixes in package-id when hashing field names.
             ;; The reason is that if you have 100 different packages each defining
             ;; (STRUCT FOO (WORD0 INT) (WORD1 INT)), then without a better hash
             ;; than symbol-name, those would cause a massive number of hash collisions.
             ;; This hash is resilient against RENAME-PACKAGE, but not against re-homing
             ;; a symbol. It's not important because at worst, you miss in the hashset.
             ;; We can't perfectly hash-cons record types anyway.
             ;; (Detecting isomorphism between possibly cyclic objects is hard)
             #-sb-xc-host (mix (sb-kernel:symbol-package-id symbol)
                               (sb-xc:sxhash symbol))))
    (mix (hash-sym (alien-record-type-name r))
         (hash-fields (alien-record-type-fields r)))))
(defun alien-record-type-equiv (a b)
  (let ((fields1 (alien-record-type-fields a))
        (fields2 (alien-record-type-fields b)))
    (and (eq (alien-record-type-name a) (alien-record-type-name b))
         (= (length fields1) (length fields2))
         (every (lambda (f1 f2)
                  (and (eq (alien-record-field-name f1) (alien-record-field-name f2))
                       (eq (alien-record-field-type f1) (alien-record-field-type f2))
                       (= (alien-record-field-offset f1) (alien-record-field-offset f2))))
                fields1 fields2))))

;;; FIXME: Can the hash function just be the slot reader now?
(define-load-time-global *struct-type-cache*
  (make-hashset 32 #'alien-record-type-equiv #'hash-alien-record-type
                :weakness t :synchronized t))
(define-load-time-global *union-type-cache*
  (make-hashset 32 #'alien-record-type-equiv #'hash-alien-record-type
                :weakness t :synchronized t))
(labels
    ((make (kind name bits alignment fields)
       (let ((new (!make-alien-record-type
                   :bits bits :alignment alignment
                   :name name :kind kind :fields fields)))
         ;; XXX: probably a screwed up hash if there is recursion involved
         (setf (ldb (byte type-hash-nbits 0) (alien-type-hash new))
               (hash-alien-record-type new))
         (if name
             ;; named ("tagged") alien record types hang off a hook in the
             ;; lexenv (or possibly global env)
             new
             ;; unnamed ones are hash-consed. These seem fairly rare.
             (hashset-insert-if-absent
              (if (eq kind :union) *union-type-cache* *struct-type-cache*)
              new
              #'identity))))
     (parse-alien-record-fields (kind fields env)
       ;; This is used by PARSE-ALIEN-TYPE to parse the fields of struct and union
       ;; types. KIND is the kind we are paring the fields of, and FIELDS is the
       ;; list of field specifications.
       ;;
       ;; Result is a list of field objects, overall alignment, and number of bits
       (declare (type list fields))
       (let ((total-bits 0)
             (overall-alignment 1)
             (parsed-fields nil))
         (dolist (field fields)
           (destructuring-bind (var type &key alignment bits offset) field
             (declare (ignore bits))
             (let* ((field-type (parse-alien-type type env))
                    (bits (alien-type-bits field-type))
                    (parsed-field (make-alien-record-field var 0 field-type)))
               (unless alignment
                 (setf alignment (alien-type-alignment field-type)))
               (push parsed-field parsed-fields)
               (when (null bits)
                 (error "unknown size: ~S" (unparse-alien-type field-type)))
               (when (null alignment)
                 (error "unknown alignment: ~S" (unparse-alien-type field-type)))
               (setf overall-alignment (max overall-alignment alignment))
               (ecase kind
                 (:struct
                  (let ((offset (or offset (align-offset total-bits alignment))))
                    (setf (alien-record-field-offset parsed-field) offset)
                    (setf total-bits (+ offset bits))))
                 (:union
                  (setf total-bits (max total-bits bits)))))))
         (values (nreverse parsed-fields)
                 overall-alignment
                 (align-offset total-bits overall-alignment))))
     (parse-alien-record-type (kind name fields env)
       (declare (type sb-kernel:lexenv-designator env))
       (cond
         (fields
          (binding* (((new-fields alignment bits)
                      (parse-alien-record-fields kind fields env))
                     (old (and name (auxiliary-alien-type kind name env)))
                     (old-fields (and old (alien-record-type-fields old)))
                     (redefined (and old (not old-fields))))
            (when (and old-fields (notevery #'record-fields-match-p old-fields new-fields))
              (cerror "Continue, clobbering the old definition."
                      "Incompatible alien record type definition~%Old: ~S~%New: ~S"
                      (unparse-alien-type old)
                      `(,(unparse-alien-record-kind kind) ,name
                        ,@(let ((state (cons nil nil)))
                            (mapcar (lambda (x) (unparse-alien-record-field state x))
                                    new-fields))))
              (setq redefined t))
            (when redefined
              ;; Assert that we're not mutating a cache entry - unnamed types
              ;; are hash-consed but named ones aren't.
              (aver name)
              (setf (alien-record-type-fields old) new-fields
                    (alien-record-type-alignment old) alignment
                    (alien-record-type-bits old) bits))
            (or old
                (let ((type (make kind name bits alignment new-fields)))
                  (when name
                    (setf (auxiliary-alien-type kind name env) type))
                  type))))
         (name
          (or (auxiliary-alien-type kind name env)
              (setf (auxiliary-alien-type kind name env)
                    (!make-alien-record-type :name name :kind kind))))
         (t
          (!make-alien-record-type :kind kind)))))
  (define-alien-type-translator union (name &rest fields &environment env)
    (parse-alien-record-type :union name fields env))
  (define-alien-type-translator struct (name &rest fields &environment env)
    (parse-alien-record-type :struct name fields env))
)
;; Named and unnamed record types can be hash-consed when loaded from fasl,
;; but this won't be used if there is a cycle involved.
(defun load-alien-record-type (kind name bits alignment field-names offsets &rest types)
  (let* ((fields (mapcar #'make-alien-record-field field-names offsets types))
         (new (!make-alien-record-type :bits bits :alignment alignment
                                       :name name :kind kind :fields fields)))
    (setf (ldb (byte type-hash-nbits 0) (alien-type-hash new))
          (hash-alien-record-type new))
    (hashset-insert-if-absent
     (if (eq kind :union) *union-type-cache* *struct-type-cache*)
     new
     #'identity)))

(define-alien-type-method (record :unparse) (type state)
  (if (car state) ; abbreviated
      `(,(alien-record-type-kind type) ,(alien-record-type-name type))
      `(,(unparse-alien-record-kind (alien-record-type-kind type))
        ,(alien-record-type-name type)
        ,@(unless (memq type (cdr state))
            (push type (cdr state))
            (mapcar (lambda (x) (unparse-alien-record-field state x))
                    (alien-record-type-fields type))))))

(defun unparse-alien-record-kind (kind)
  (case kind
    (:struct 'struct)
    (:union 'union)
    (t '???)))

(defun unparse-alien-record-field (state field)
  `(,(alien-record-field-name field)
     ,(%unparse-alien-type state (alien-record-field-type field))
     ,@(when (alien-record-field-offset field)
             (list :offset (alien-record-field-offset field)))))

;;; Test the record fields. Keep a hashtable table of already compared
;;; types to detect cycles.
(defun record-fields-match-p (field1 field2)
  (and (eq (alien-record-field-name field1)
           (alien-record-field-name field2))
       (eql (alien-record-field-offset field1)
            (alien-record-field-offset field2))
       (alien-type-= (alien-record-field-type field1)
                     (alien-record-field-type field2))))

(defvar *alien-type-matches* nil
  "A hashtable used to detect cycles while comparing record types.")

(define-alien-type-method (record :type=) (type1 type2)
  (and (eq (alien-record-type-name type1)
           (alien-record-type-name type2))
       (eq (alien-record-type-kind type1)
           (alien-record-type-kind type2))
       (eql (alien-type-bits type1)
            (alien-type-bits type2))
       (eql (alien-type-alignment type1)
            (alien-type-alignment type2))
       (flet ((match-fields (&optional old)
                (setf (gethash type1 *alien-type-matches*) (cons type2 old))
                (every #'record-fields-match-p
                       (alien-record-type-fields type1)
                       (alien-record-type-fields type2))))
         (if *alien-type-matches*
             (let ((types (gethash type1 *alien-type-matches*)))
               (or (memq type2 types) (match-fields types)))
             (let ((*alien-type-matches* (make-hash-table :test #'eq)))
               (match-fields))))))


;;;; the FUNCTION and VALUES alien types

;;; not documented in CMU CL:-(
;;;
;;; reverse engineering observations:
;;;   * seems to be set when translating return values
;;;   * seems to enable the translation of (VALUES), which is the
;;;     Lisp idiom for C's return type "void" (which is likely
;;;     why it's set when when translating return values)
(defvar *values-type-okay* nil)

;;; Calling-convention spec, typically one of predefined keywords.
;;; Add or remove as needed for target platform.  It makes sense to
;;; support :cdecl everywhere.
;;;
;;; Null convention is supposed to be platform-specific most-universal
;;; callout convention. For x86, SBCL calls foreign functions in a way
;;; allowing them to be either stdcall or cdecl; null convention is
;;; appropriate here, as it is for specifying callbacks that could be
;;; accepted by foreign code both in cdecl and stdcall form.
(def!type calling-convention () `(or null (member :stdcall :cdecl)))

;;; Convention could be a values type class, stored at result-type.
;;; However, it seems appropriate only for epilogue-related
;;; conventions, those not influencing incoming arg passing.
;;;
;;; As of x86's :stdcall and :cdecl, supported by now, both are
;;; epilogue-related, but future extensions (like :fastcall and
;;; miscellaneous non-x86 stuff) might affect incoming argument
;;; translation as well.

(defun hash-alien-type-list (list)
  (let ((h #36rALIEN))
    (dolist (type list h)
      (setq h (mix (alien-type-hash type) h)))))

(define-alien-type-class (fun :include mem-block)
  (result-type (missing-arg) :type alien-type :read-only t)
  (arg-types (missing-arg) :type list :read-only t)
  ;; The 3rd-party CFFI library uses presence of &REST in an argument list
  ;; as indicative of "..." in the C prototype. We can record that too.
  (varargs nil :type (or boolean fixnum (eql :unspecified)) :read-only t)
  (stub nil :type (or null function))
  (convention nil :type calling-convention :read-only t))
;;; The safe default is to assume that everything is varargs.
;;; On x86-64 we have to emit a spurious instruction because of it.
;;; So until all users fix their lambda lists to be explicit about &REST
;;; (which is never gonna happen), be backward-compatible, unless
;;; locally toggled to get rid of noise instructions if so inclined.
(defglobal *alien-fun-type-varargs-default* :unspecified)

;;; KLUDGE: non-intrusive, backward-compatible way to allow calling
;;; convention specification for function types is unobvious.
;;;
;;; By now, `RESULT-TYPE' is allowed, but not required, to be a list
;;; starting with a convention keyword; its second item is a real
;;; result-type in this case. If convention is ever to become a part
;;; of result-type, such a syntax can be retained.


(define-alien-type-translator function (result-type &rest arg-types
                                                    &environment env)
  (binding* (((bare-result-type calling-convention)
              (typecase result-type
                ((cons calling-convention *)
                 (values (second result-type) (first result-type)))
                (t result-type)))
             (varargs (or (eq (car (last arg-types)) '&rest)
                          (position '&optional arg-types)))
             (arg-types (if (integerp varargs)
                            (remove '&optional arg-types)
                            arg-types)))
    (make-alien-fun-type
     :convention calling-convention
     :result-type (let ((*values-type-okay* t))
                    (parse-alien-type bare-result-type env))
     :varargs (or varargs *alien-fun-type-varargs-default*)
     :arg-types (mapcar (lambda (arg-type)
                          (parse-alien-type arg-type env))
                        (if (eql varargs t)
                            (butlast arg-types)
                            arg-types)))))
(defun load-alien-fun-type (convention result varargs &rest args)
  (make-alien-fun-type :convention convention
                       :result-type result
                       :varargs varargs
                       :arg-types args))

(define-alien-type-method (fun :unparse) (type state)
  `(function ,(let ((result-type
                     (%unparse-alien-type state (alien-fun-type-result-type type)))
                    (convention (alien-fun-type-convention type)))
                (if convention (list convention result-type)
                    result-type))
             ,@(%unparse-alien-types state (alien-fun-type-arg-types type))
             ,@(when (alien-fun-type-varargs type)
                 '(&rest))))

(define-alien-type-method (fun :type=) (type1 type2)
  (and (alien-type-= (alien-fun-type-result-type type1)
                     (alien-fun-type-result-type type2))
       (eq (alien-fun-type-convention type1)
           (alien-fun-type-convention type2))
       (= (length (alien-fun-type-arg-types type1))
          (length (alien-fun-type-arg-types type2)))
       (every #'alien-type-=
              (alien-fun-type-arg-types type1)
              (alien-fun-type-arg-types type2))))

(define-alien-type-class (values)
  (values (missing-arg) :type list :read-only t))

(define-alien-type-translator values (&rest values &environment env)
  (unless *values-type-okay*
    (error "cannot use values types here"))
  (let ((*values-type-okay* nil))
    (make-alien-values-type
     :values (mapcar (lambda (alien-type) (parse-alien-type alien-type env))
                     values))))

(define-alien-type-method (values :unparse) (type state)
  `(values ,@(%unparse-alien-types state (alien-values-type-values type))))

(define-alien-type-method (values :type=) (type1 type2)
  (and (= (length (alien-values-type-values type1))
          (length (alien-values-type-values type2)))
       (every #'alien-type-=
              (alien-values-type-values type1)
              (alien-values-type-values type2))))


;;;; alien variables

(defmethod print-object ((info heap-alien-info) stream)
  (print-unreadable-object (info stream :type t)
    (format stream "~S ~S~@[ (data)~]"
            (heap-alien-info-alien-name info)
            (unparse-alien-type (heap-alien-info-type info))
            (heap-alien-info-datap info))))

;;; The form to evaluate to produce the SAP pointing to where in the heap
;;; it is.
(defun heap-alien-info-sap-form (info)
  `(foreign-symbol-sap ,(heap-alien-info-alien-name info)
                       ,(heap-alien-info-datap info)))

#-sb-xc-host ; No FOREIGN-SYMBOL-SAP
(defun heap-alien-info-sap (info)
  (foreign-symbol-sap (heap-alien-info-alien-name info)
                      (heap-alien-info-datap info)))

;;; information about local aliens. The WITH-ALIEN macro builds one of
;;; these structures and LOCAL-ALIEN and friends communicate
;;; information about how that local alien is represented.
(defstruct (local-alien-info
             (:copier nil)
             (:constructor make-local-alien-info
                           (&key type force-to-memory-p
                            &aux (force-to-memory-p (or force-to-memory-p
                                                        (alien-array-type-p type)
                                                        (alien-record-type-p type))))))
  ;; the type of the local alien
  (type (missing-arg) :type alien-type)
  ;; Must this local alien be forced into memory? Using the ADDR macro
  ;; on a local alien will set this.
  (force-to-memory-p nil :type (member t nil)))
(!set-load-form-method local-alien-info (:xc :target))
(defmethod print-object ((info local-alien-info) stream)
  (print-unreadable-object (info stream :type t)
    (format stream
            "~:[~;(forced to stack) ~]~S"
            (local-alien-info-force-to-memory-p info)
            (unparse-alien-type (local-alien-info-type info)))))

(defun cas-alien (symbol old new)
  (let ((info (info :variable :alien-info symbol)))
    (when info
      (let ((type (heap-alien-info-type info)))
        (when (and (typep type 'alien-integer-type)
                   (eq (alien-type-class-name (alien-type-class type)) 'integer)
                   (member (alien-integer-type-bits type)
                           '(8 16 32 #+64-bit 64)))
          (let ((signed (alien-integer-type-signed type))
                (bits (alien-integer-type-bits type))
                (sap-form `(foreign-symbol-sap ,(heap-alien-info-alien-name info) t)))
            (cond ((and signed (< bits sb-vm:n-word-bits))
                   (let ((mask (1- (ash 1 bits))))
                     `(sb-vm::sign-extend
                       (funcall #'(cas ,(alien-integer->sap-ref-fun nil bits))
                                (logand (the (signed-byte ,bits) ,old) ,mask)
                                (logand (the (signed-byte ,bits) ,new) ,mask)
                                ,sap-form 0)
                       ,bits)))
                  (t
                   `(funcall #'(cas ,(alien-integer->sap-ref-fun signed bits))
                             ,old ,new ,sap-form 0)))))))))

(defun sb-sys:extern-alien-name (name)
  (handler-case (cl:coerce name 'base-string)
    (error ()
      (error "invalid external alien name: ~S" name))))

#+sb-xc
(defmacro maybe-with-pinned-objects (variables types &body body)
  (declare (ignorable variables types))
  (let ((pin-variables
         ;; Only pin things on GENCGC, since on CHENEYGC it'd imply
         ;; disabling the GC.  Which is something we don't want to do
         ;; every time we're calling to C.
         #-cheneygc
         (loop for variable in variables
            for type in types
            when (invoke-alien-type-method :deport-pin-p type)
            collect variable)))
    (if pin-variables
        `(with-pinned-objects ,pin-variables
           ,@body)
        `(progn
           ,@body))))

(defun alien-type-cache-entry-eq (a b)
  ;; A and B are the same type, because each subtype of ALIEN-TYPE is in its own hashset.
  (aver (eq (type-of a) (type-of b))) ; could be removed when fully debugged
  (and (= (alien-type-hash a) (alien-type-hash b))
       (eql (alien-type-bits a) (alien-type-bits b))
       (eql (alien-type-alignment a) (alien-type-alignment b))
       (etypecase a
         (alien-integer-type ; also handles ALIEN-BOOLEAN-TYPE
          (aver (not (alien-enum-type-p a)))
          (eq (alien-integer-type-signed a) (alien-integer-type-signed b)))
         (alien-fun-type
          (and (eq (alien-fun-type-convention a) (alien-fun-type-convention b))
               (eq (alien-fun-type-varargs a) (alien-fun-type-varargs b))
               (eq (alien-fun-type-result-type a) (alien-fun-type-result-type b))
               (list-elts-eq (alien-fun-type-arg-types a) (alien-fun-type-arg-types b))))
         ;; C-STRING is a subtype of POINTER so pick it off first
         (alien-c-string-type ; the "TO" slot is invariant
          (and (eq (alien-c-string-type-element-type a) (alien-c-string-type-element-type b))
               (eq (alien-c-string-type-external-format a) (alien-c-string-type-external-format b))
               (eq (alien-c-string-type-not-null a) (alien-c-string-type-not-null b))))
         (alien-pointer-type
          (eq (alien-pointer-type-to a) (alien-pointer-type-to b)))
         (alien-array-type
          (and (eq (alien-array-type-element-type a) (alien-array-type-element-type b))
               (equal (alien-array-type-dimensions a) (alien-array-type-dimensions b))))
         (alien-values-type
          (eq (alien-values-type-values a) (alien-values-type-values b))))))

;;; Each alien-type gets its own hashset. The comparator function is universal.
;;; Because of that, the hashset aren't defined until all classes are defined,
;;; or else the accessors would use inefficient full calls.
;;; KLUDGE: ALIEN-FUN-TYPE can memoize an object of type COMPILED-FUNCTION,
;;; which means that if the compiler picks up a hash-consed instance
;;; that was used in a not-compile-time-optimized ALIEN-FUNCALL
;;; (see target-alieneval), the STUB slot will contain an undumpable object,
;;; and the compiler will croak on it.
(macrolet
  ((define-caching-constructors ()
     (flet
        ((hash-calculator (class-name)
           ;; Use our own SXHASH so that the intelligent hash comes out the same
           ;; between host and target. I don't think there are any instances dumped
           ;; in genesis, but just in case they are, it is essential that they have
           ;; hashes that are consistent with the target SXHASH.
           (macrolet ((mix* (&rest items)
                        (list 'quote (reduce (lambda (a b) `(mix ,a ,b)) items))))
             (ecase class-name
               ((alien-value mem-block) 0)
               (pointer '(if to (alien-type-hash to) #xBAD))
               (c-string ; Don't need ALIEN-POINTER-TYPE-TO as it's invariant
                (mix* (sb-xc:sxhash element-type) (sb-xc:sxhash external-format)
                      (sb-xc:sxhash not-null)))
               ((integer boolean) '(if signed 1 0))
               (array `(let ((h (alien-type-hash element-type)))
                         (dolist (dim dimensions h) (setf h (mix dim h)))))
               (fun (mix* (alien-type-hash result-type) (hash-alien-type-list arg-types)
                          (sb-xc:sxhash varargs) (sb-xc:sxhash convention)))
               (values '(hash-alien-type-list values))))))
       (collect ((forms) (globals))
         (dolist (list *hashset-defining-forms*
                       `(progn (setq *alien-type-hashsets*
                                   '(*struct-type-cache* *union-type-cache*
                                     *enum-type-cache* ,@(globals)))
                               ,@(forms)))
           (destructuring-bind (class-name hashset-var ctor ctor-args alloc alloc-args)
               list
             (forms
              `(define-load-time-global ,hashset-var
                   (make-hashset 32 #'alien-type-cache-entry-eq #'alien-type-hash
                                 :weakness t :synchronized t))
              `(defun ,ctor (&key ,@ctor-args)
                 (binding* ((alignment (or alignment (guess-alignment bits)))
                            (data-hash ,(hash-calculator class-name))
                            (size-hash
                             (mix (sb-xc:sxhash bits) (sb-xc:sxhash alignment)))
                            (hash (logior ,(ash (alien-type-class-name->id class-name)
                                                type-hash-nbits)
                                          (ldb (byte type-hash-nbits 0)
                                               (mix size-hash data-hash)))))
                   (dx-let ((key (,alloc hash ,@alloc-args)))
                     (hashset-insert-if-absent ,hashset-var key
                                               #'sys-copy-struct)))))
             (globals hashset-var)))))))
  (define-caching-constructors))

(defun acyclic-type-p (type)
  (named-let visit ((x type) (stack nil))
    (aver type)
    (when (member x stack) (return-from acyclic-type-p nil))
    (let ((stack (cons x stack)))
      (typecase x
        (alien-pointer-type
         (awhen (alien-pointer-type-to x) (visit it stack)))
        (alien-array-type
         (visit (alien-array-type-element-type x) stack))
        (alien-record-type
         (mapc (lambda (field) (visit (alien-record-field-type field) stack))
               (alien-record-type-fields x)))
        (alien-fun-type
         (visit (alien-fun-type-result-type x) stack)
         (dolist (x (alien-fun-type-arg-types x)) (visit x stack)))
        (alien-values-type
         (dolist (x (alien-values-type-values x)) (visit x stack))))))
  t)

;;; It's tricky (or impossible) to hash-cons if structural recursion is involved.
;;; We can always punt to MAKE-LOAD-FORM-SAVING-SLOTS which handles circularity,
;;; but then it doesn't know about hash-consing.
#|
 Note that there can be untagged (unnamed) record types involved in cycles.
 e.g. after executing
    (parse-alien-type '(struct foo (a (struct nil (x (* (struct foo))))) (b int)) nil)
 then
   (acyclic-type-p
     (alien-record-field-type
       (first (alien-record-type-fields (parse-alien-type '(struct foo) nil))))) => NIL
  so if that object were dumped literally - because we have some access path to it -
  then it can't necessarily be hash-consed.
|#

(defun integer-type (bits signed) ; trivial helpers
  (make-alien-integer-type :bits bits :signed signed))
(defun boolean-type (bits)
  (make-alien-boolean-type :bits bits :signed nil))
(defun single-float-type () (parse-alien-type 'single-float nil))
(defun double-float-type () (parse-alien-type 'double-float nil))
(defun sap-type () (parse-alien-type 'system-area-pointer nil))

;;; Genesis is limited in its ability to patch load-time-values into objects
;;; other than code components. For this reason we want to emit a single sexpr
;;; to handle all levels of structure nesting.
(defun make-type-load-form (x)
  ;; Cases have to be ordered most-specific-first!
  (etypecase x
    (alien-integer-type
     (cond ((alien-enum-type-p x)
            `(load-alien-enum ',(alien-enum-type-name x) ',(alien-enum-type-from x)))
           ((alien-boolean-type-p x)
            `(boolean-type ,(alien-boolean-type-bits x)))
           (t
            `(integer-type ,(alien-integer-type-bits x) ,(alien-integer-type-signed x)))))
    (alien-float-type
     (ecase (alien-float-type-type x)
       (single-float '(single-float-type))
       (double-float '(double-float-type))))
    ;; RECORD is-a MEM-BLOCK is-a ALIEN-VALUE is-a SYSTEM-AREA-POINTER
    (alien-record-type
     (and (acyclic-type-p x) ; hash-cons it
          (let ((fields (alien-record-type-fields x)))
            `(load-alien-record-type
              ,(alien-record-type-kind x)
              ',(alien-record-type-name x)
              ,(alien-record-type-bits x)
              ,(alien-record-type-alignment x)
              ',(mapcar #'alien-record-field-name fields)
              ',(mapcar #'alien-record-field-offset fields)
              ,@(mapcar (lambda (x) (make-type-load-form (alien-record-field-type x)))
                        fields)))))
    ;; ARRAY is-a MEM-BLOCK is-a ALIEN-VALUE is-a SYSTEM-AREA-POINTER
    (alien-array-type
     (and (acyclic-type-p x) ; hash-cons it
          `(make-alien-array-type
            :element-type ,(make-type-load-form (alien-array-type-element-type x))
            :dimensions ',(alien-array-type-dimensions x)
            :alignment ,(alien-type-alignment x)
            :bits ,(alien-type-bits x))))
    ;; C-STRING is-a POINTER is-a ALIEN-VALUE is-a SYSTEM-AREA-POINTER
    (alien-c-string-type
     `(load-alien-c-string-type ',(alien-c-string-type-element-type x)
                                ',(alien-c-string-type-external-format x)
                                ',(alien-c-string-type-not-null x)))
    (alien-pointer-type
     (and (acyclic-type-p x) ; hash-cons it
          `(make-alien-pointer-type
            ,@(awhen (alien-pointer-type-to x) `(:to ,(make-type-load-form it))))))
    ;; FUN is-a MEM-BLOCK is-a ALIEN-VALUE is-a SYSTEM-AREA-POINTER
    (alien-fun-type
     (if (acyclic-type-p x)
         ;; hash-cons it
         `(load-alien-fun-type ',(alien-fun-type-convention x)
                               ,(make-type-load-form (alien-fun-type-result-type x))
                               ,(alien-fun-type-varargs x)
                               ,@(mapcar #'make-type-load-form
                                         (alien-fun-type-arg-types x)))
         ;; there is some cycle involving this type
         (make-load-form-saving-slots
          x
          :slot-names '(hash bits alignment result-type arg-types varargs convention))))
    (alien-system-area-pointer-type '(sap-type))
    (alien-values-type
     (let ((types (alien-values-type-values x)))
       (if (every #'acyclic-type-p types)
           `(make-alien-values-type
             :values (list ,@(mapcar #'make-type-load-form types))))))))
(!set-load-form-method alien-type (:xc :target)
  (lambda (self env)
    (declare (ignore env))
    (aver (acyclic-type-p self))
    (let ((form (make-type-load-form self)))
      (the (not null) form))))

(defun show-alien-type-caches ()
  (dolist (var *alien-type-hashsets*)
    (let ((hs (symbol-value var)))
      (when (plusp (hashset-count hs))
        (format t "~A:~%" var)
        (let* ((v (sb-impl::hss-cells (sb-impl::hashset-storage hs)))
               (n (sb-impl::hs-cells-capacity v)))
          (dotimes (i n)
            (let ((entry (aref v i)))
              (when (and entry (not (eql entry 0)))
                (format t " ~A~%" entry)))))))))

;;; Directly printing an alien-record-type will include its field names,
;;; otherwise just the name.
(defmethod print-object ((type alien-type) stream)
  (if (alien-record-type-p type)
      (print-unreadable-object (type stream :type nil :identity t)
        (format stream "~S ~S ~@S" 'alien-type
                (list (alien-record-type-kind type) (alien-record-type-name type))
                (mapcar #'alien-record-field-name (alien-record-type-fields type))))
      (let ((expr (unparse-alien-type type t)))
        ;; Unparsed expression conveys its type. There's no need to print e.g.
        ;; #<alien-single-float-type single-float>
        (print-unreadable-object (type stream :type nil)
          (format stream "~A ~S" 'alien-type expr)))))

(push '("SB-ALIEN-INTERNALS"
        define-alien-type-translator ; not sure why this doesn't get dropped automatically
        define-alien-type-method) ; this is external, needed by compiler/*/c-call
      *!removable-symbols*)
