• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
      • X86isa
        • Program-execution
        • Sdm-instruction-set-summary
        • Tlb
        • Running-linux
        • Introduction
        • Asmtest
        • X86isa-build-instructions
        • Publications
        • Contributors
        • Machine
          • X86isa-state
          • Syscalls
          • Cpuid
          • Linear-memory
          • Rflag-specifications
          • Characterizing-undefined-behavior
          • Top-level-memory
          • App-view
          • X86-decoder
          • Physical-memory
          • Decoding-and-spec-utils
          • Instructions
            • Two-byte-opcodes
            • One-byte-opcodes
              • X86-sal/sar/shl/shr/rcl/rcr/rol/ror
              • X86-add/adc/sub/sbb/or/and/xor/cmp-test-e-i
              • X86-far-jmp-op/en-d
              • X86-add/xadd/adc/sub/sbb/or/and/xor/cmp/test-e-g
              • X86-add/adc/sub/sbb/or/and/xor/cmp-test-rax-i
              • X86-add/adc/sub/sbb/or/and/xor/cmp-g-e
              • X86-push-segment-register
              • X86-pusha
              • X86-shld/shrd
              • X86-mov-op/en-oi
              • X86-inc/dec-4x
              • X86-cmps
              • X86-xchg
              • X86-popa
              • X86-one-byte-jcc
              • X86-movs
              • X86-push-general-register
              • X86-idiv
              • X86-div
              • X86-pop-general-register
              • X86-ret
                • X86-push-i
                • X86-pop-ev
                • X86-imul-op/en-rmi
                • X86-push-ev
                • X86-mul
                • X86-imul-op/en-m
                • X86-stos
                • X86-not/neg-f6-f7
                • X86-call-ff/2-op/en-m
                • X86-iret
                • X86-inc/dec-fe-ff
                • X86-mov-op/en-rm
                • X86-mov-op/en-mr
                • X86-near-jmp-op/en-m
                • X86-mov-op/en-mi
                • X86-loop
                • X86-out
                • X86-call-e8-op/en-m
                • X86-movsxd
                • X86-mov-op/en-fd
                • X86-cmc/clc/stc/cld/std
                • X86-near-jmp-op/en-d
                • X86-mov-op/en-td
                • X86-popf
                • X86-lea
                • X86-jrcxz
                • X86-cbw/cwd/cdqe
                • X86-pushf
                • X86-leave
                • X86-lahf
                • X86-sahf
                • X86-cwd/cdq/cqo
                • X86-rdtsc
                • X86-sti
                • X86-int3
                • X86-hlt
                • X86-cli
              • Fp-opcodes
              • Instruction-semantic-functions
              • X86-illegal-instruction
              • Implemented-opcodes
              • Opcode-maps
              • X86-general-protection
              • X86-device-not-available
              • X86-step-unimplemented
              • Privileged-opcodes
              • Three-byte-opcodes
            • Register-readers-and-writers
            • X86-modes
            • Segmentation
            • Other-non-deterministic-computations
            • Environment
            • Paging
          • Implemented-opcodes
          • To-do
          • Proof-utilities
          • Peripherals
          • Model-validation
          • Modelcalls
          • Concrete-simulation-examples
          • Utils
          • Debugging-code-proofs
        • Axe
        • Execloader
      • Math
      • Testing-utilities
    • One-byte-opcodes

    X86-ret

    Signature
    (x86-ret proc-mode start-rip temp-rip 
             prefixes rex-byte opcode modr/m sib x86) 
     
      → 
    x86
    Returns
    x86 — Type (x86p x86), given (x86p x86).

    Definitions and Theorems

    Function: x86-ret

    (defun x86-ret (proc-mode start-rip temp-rip
                              prefixes rex-byte opcode modr/m sib x86)
     (declare (xargs :stobjs (x86)))
     (declare (type (integer 0 4) proc-mode)
              (type (signed-byte 48) start-rip)
              (type (signed-byte 48) temp-rip)
              (type (unsigned-byte 52) prefixes)
              (type (unsigned-byte 8) rex-byte)
              (type (unsigned-byte 8) opcode)
              (type (unsigned-byte 8) modr/m)
              (type (unsigned-byte 8) sib))
     (declare (ignorable proc-mode start-rip temp-rip
                         prefixes rex-byte opcode modr/m sib))
     (declare (xargs :guard (and (prefixes-p prefixes)
                                 (modr/m-p modr/m)
                                 (sib-p sib)
                                 (rip-guard-okp proc-mode temp-rip))))
     (let ((__function__ 'x86-ret))
      (declare (ignorable __function__))
      (b* ((?ctx 'x86-ret))
       (b*
        ((rsp (read-*sp proc-mode x86))
         ((the (integer 2 8) operand-size)
          (select-operand-size proc-mode nil rex-byte nil 0 t t t x86))
         ((mv flg (the (signed-byte 48) new-rsp)
              x86)
          (if (not (equal opcode 194))
              (b* (((mv flg1 new-rsp)
                    (add-to-*sp proc-mode rsp operand-size x86))
                   ((when flg1) (mv flg1 0 x86)))
                (mv nil new-rsp x86))
            (b* (((mv flg1 (the (unsigned-byte 16) imm16)
                      x86)
                  (rme16-opt proc-mode temp-rip 1 :x nil x86))
                 ((when flg1) (mv flg1 0 x86))
                 ((mv flg1 new-rsp)
                  (add-to-*sp proc-mode rsp (+ operand-size imm16)
                              x86))
                 ((when flg1) (mv flg1 0 x86)))
              (mv nil new-rsp x86))))
         ((when flg)
          (!!ms-fresh :imm-rml16-error flg))
         (badlength?
              (and (eql opcode 194)
                   (check-instruction-length start-rip temp-rip 2)))
         ((when badlength?)
          (!!fault-fresh :gp 0
                         :instruction-length badlength?))
         (check-alignment? (alignment-checking-enabled-p x86))
         ((mv flg (the (signed-byte 64) tos) x86)
          (if (= operand-size 8)
              (rime-size-opt proc-mode operand-size
                             rsp 2 :r check-alignment? x86
                             :mem-ptr? nil
                             :check-canonicity t)
            (rme-size-opt proc-mode operand-size
                          rsp 2 :r check-alignment? x86
                          :mem-ptr? nil)))
         ((when flg)
          (cond ((and (consp flg)
                      (eql (car flg) :non-canonical-address))
                 (!!fault-fresh :ss 0 :riml64-error flg))
                ((and (consp flg)
                      (eql (car flg)
                           :unaligned-linear-address))
                 (!!fault-fresh :ac 0
                                :memory-access-unaligned rsp))
                (t (!!fault-fresh flg))))
         ((unless (if (equal proc-mode 0)
                      (canonical-address-p tos)
                    (b* (((the (unsigned-byte 32) cs.limit)
                          (seg-hidden-limiti 1 x86)))
                      (or (equal opcode 203)
                          (and (<= 0 tos) (<= tos cs.limit))))))
          (!!fault-fresh :gp 0
                         :bad-return-address tos))
         ((mv new-rsp x86)
          (if
           (equal opcode 203)
           (b*
            (((mv flg cs-selector x86)
              (rme-size-opt proc-mode operand-size
                            new-rsp 2 :r check-alignment? x86
                            :mem-ptr? nil))
             ((when flg)
              (b*
               ((x86
                    (cond ((and (consp flg)
                                (eql (car flg) :non-canonical-address))
                           (!!fault-fresh :ss 0 :riml64-error flg))
                          ((and (consp flg)
                                (eql (car flg)
                                     :unaligned-linear-address))
                           (!!fault-fresh :ac 0
                                          :memory-access-unaligned rsp))
                          (t (!!fault-fresh flg)))))
               (mv 0 x86)))
             (cs-selector (loghead 16 cs-selector))
             ((mv flg cs-descriptor x86)
              (get-segment-descriptor 1 cs-selector x86))
             ((when flg)
              (b* (((when (equal flg t))
                    (b* ((x86 (!!ms-fresh :get-segment-descriptor)))
                      (mv 0 x86)))
                   (x86 (!!fault-fresh (car flg)
                                       (cadr flg)
                                       (caddr flg))))
                (mv 0 x86)))
             (x86 (load-segment-reg 1 cs-selector cs-descriptor x86))
             ((mv flg new-rsp)
              (add-to-*sp proc-mode new-rsp operand-size x86))
             ((when flg)
              (b* ((x86 (!!fault-fresh :ss 0 :pop flg)))
                (mv 0 x86))))
            (mv new-rsp x86))
           (mv new-rsp x86)))
         ((when (or (fault x86) (ms x86))) x86)
         (x86 (write-*sp proc-mode new-rsp x86))
         (x86 (!rip (the (signed-byte 48) tos) x86)))
        x86))))

    Theorem: x86p-of-x86-ret

    (defthm x86p-of-x86-ret
      (implies (x86p x86)
               (b* ((x86 (x86-ret proc-mode start-rip temp-rip prefixes
                                  rex-byte opcode modr/m sib x86)))
                 (x86p x86)))
      :rule-classes :rewrite)