• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
      • Svex-stvs
      • Svex-decomposition-methodology
      • Sv-versus-esim
      • Svex-decomp
      • Svex-compose-dfs
      • Svex-compilation
      • Moddb
      • Svmods
      • Svstmt
      • Sv-tutorial
      • Expressions
      • Symbolic-test-vector
      • Vl-to-svex
        • Vl-to-sv
        • Vl-design->sv-design
          • Vl-simpconfig
          • Vl-hierarchy-sv-translation
          • Vl-expr-svex-translation
            • Sv::vl-expr.lisp
              • Vl-scopecontext-to-addr
              • Vl-binaryop-to-svex
              • Vl-expr-to-svex-maybe-typed
              • Vl-datatype-syscall-to-svex
              • Vl-operandinfo-to-svex-preproc
              • Vl-structmemberlist->types
              • Vl-seltrace-to-svex-select
              • Vl-portdecllist->types
              • Vl-operandinfo-to-svex-select
              • Vl-plusminus-partselect->svex
              • Vl-arrayrange->rel-lsb-and-width
              • Vl-unaryop-to-svex
              • Vl-funcall-args-to-ordered
              • Vl-expr-to-svex-lhs
              • Vl-operandinfo-to-svex
              • Vl-array-assignpat-keyval-resolve
              • Vl-err->vfatal
              • Vl-datatypelist-usertype-resolve
              • Vl-upscope-to-svex-upscope
              • Vl-err->fatal
              • Vl-streaming-concat-trunc/extend
              • Vl-operandinfo-base-svar
              • Vl-index-shift-amount
              • Vttree->constraints
              • Vl-slicesize-resolve
              • Vl-function-map-find-matching-aux
              • Vl-funname-lookup
              • Vl-datatype-size-warn
              • Svex-repeat-aux
              • Vl-$test$plusargs-to-svex
              • Svex-extend
              • Vl-structmemberlist-shift-bits
              • Vl-datatype-slot-width/range
              • Vl-datatype-index-shift-amount
              • Vl-datatype-field-shift-amount
              • 4vec-extend
              • Vl-function-pair-inputs-with-actuals
              • Vl-expr-to-svex-untyped
              • Vl-function-map-check-matching
              • Vl-datatype-syscall-remove-dims
              • Svex-concat-list-aux
              • Vttree-add-constraints
              • Vttree-add-warnings
              • Vl-check-struct-assignpat-keys
              • Vl-check-array-assignpat-keys
              • Sv::constraintlist-subst-memo
              • Vl-svex-keyval-index-lookup
              • Vl-function-map-find-matching
              • Vl-convert-dollarsign-to-expr
              • Vttree->constraints-acc
              • Vl-seltrace-type
              • Vl-seltrace-to-path
              • Vl-keyval-member-lookup
              • Svex-repeat
              • Vttree->warnings-acc
              • Vl-trunc/extend-type-err
              • Constraintlist-add-ctx
              • Vl-hidtrace-add-to-path
              • Svex-multiconcat
              • Vttree-join
              • Vl-value-to-string-aux
              • Vl-seltrace-add-to-path
              • Vl-value-to-4vec
              • Vl-expr-to-svex-selfdet
              • Vl-svex-keyval-default-lookup
              • Vl-$test$plusargs-p
              • Vl-value-to-svex
              • Vl-value-in-range
              • Vl-keyval-default-lookup
              • Sv::svexlist-args-extract-constants
              • Vl-string->bits
              • Vl-size-to-unsigned-logic
              • Vl-hidtrace-to-path
              • Svex-concat-list
              • Vttree->warnings
              • Vl-seltrace-unres-count
              • Vl-datatype-index-is-bitselect
              • Vl-bitlist->4vec
              • Vl-svex-keyvallist-vars
              • Vl-hidstep->svex-index
              • Vl-selstep->svex-name
              • Vl-datatypelist-resolved-p
              • Vl-datatype-$unpacked_dimensions
              • Vl-datatype-$dimensions
              • Vl-bitlist->offset
              • Vl-bitlist->onset
              • Vl-streamexprlist-has-with
              • Vl-hidstep-resolved-p
              • Vl-expr-needs-type-context
              • Vl-streamexprlist->exprs
              • Vl-integer-to-string
              • Vl-hidtrace-resolved-p
              • Vl-selstep-resolved-p
              • Vl-select-resolved-p
              • Vl-svex-keyvallist
              • Vl-datatypelist
              • Svex-x
            • Vttree
          • Vl-design->svex-modalist
          • Vl-svstmt
        • Vl-to-sv-main
        • Vl-simplify-sv
        • Vl-user-paramsettings->unparam-names
        • Vl-user-paramsettings->modnames
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Sv::vl-expr.lisp

Vl-datatype-field-shift-amount

Signature

(vl-datatype-field-shift-amount x field) → (mv err shift)

Arguments

x — Guard (vl-datatype-p x).

field — Guard (stringp field).

Returns

err — Type (iff (vl-msg-p err) err).

shift — Type (implies (not err) (integerp shift)).

Definitions and Theorems

Function: vl-datatype-field-shift-amount

(defun vl-datatype-field-shift-amount (x field)
 (declare (xargs :guard (and (vl-datatype-p x)
                             (stringp field))))
 (declare (xargs :guard (vl-datatype-resolved-p x)))
 (let ((__function__ 'vl-datatype-field-shift-amount))
  (declare (ignorable __function__))
  (b*
   ((field (string-fix field))
    (x (vl-maybe-usertype-resolve x))
    (udims (vl-datatype->udims x))
    (pdims (vl-datatype->pdims x))
    ((when (or (consp udims) (consp pdims)))
     (mv
      (vmsg
       "Can't select field ~s0 from datatype ~a1 because it has dimensions"
       field x)
      nil)))
   (vl-datatype-case
    x :vl-union
    (if (vl-find-structmember field x.members)
        (mv nil 0)
      (mv (vmsg "~s0 is not a member of ~a1" field x)
          nil))
    :vl-struct (vl-structmemberlist-shift-bits (rev x.members)
                                               field)
    :otherwise
    (mv
     (vmsg
         "Can't select field ~s0 from non-struct/union datatype ~a1"
         field x)
     nil)))))

Theorem: return-type-of-vl-datatype-field-shift-amount.err

(defthm return-type-of-vl-datatype-field-shift-amount.err
  (b* (((mv ?err ?shift)
        (vl-datatype-field-shift-amount x field)))
    (iff (vl-msg-p err) err))
  :rule-classes :rewrite)

Theorem: return-type-of-vl-datatype-field-shift-amount.shift

(defthm return-type-of-vl-datatype-field-shift-amount.shift
  (b* (((mv ?err ?shift)
        (vl-datatype-field-shift-amount x field)))
    (implies (not err) (integerp shift)))
  :rule-classes :type-prescription)

Theorem: vl-datatype-field-shift-amount-of-vl-datatype-fix-x

(defthm vl-datatype-field-shift-amount-of-vl-datatype-fix-x
  (equal (vl-datatype-field-shift-amount (vl-datatype-fix x)
                                         field)
         (vl-datatype-field-shift-amount x field)))

Theorem: vl-datatype-field-shift-amount-vl-datatype-equiv-congruence-on-x

(defthm
   vl-datatype-field-shift-amount-vl-datatype-equiv-congruence-on-x
  (implies (vl-datatype-equiv x x-equiv)
           (equal (vl-datatype-field-shift-amount x field)
                  (vl-datatype-field-shift-amount x-equiv field)))
  :rule-classes :congruence)

Theorem: vl-datatype-field-shift-amount-of-str-fix-field

(defthm vl-datatype-field-shift-amount-of-str-fix-field
  (equal (vl-datatype-field-shift-amount x (str-fix field))
         (vl-datatype-field-shift-amount x field)))

Theorem: vl-datatype-field-shift-amount-streqv-congruence-on-field

(defthm vl-datatype-field-shift-amount-streqv-congruence-on-field
  (implies (streqv field field-equiv)
           (equal (vl-datatype-field-shift-amount x field)
                  (vl-datatype-field-shift-amount x field-equiv)))
  :rule-classes :congruence)