# Copyright (c) 2007-2008 The Hewlett-Packard Development Company
# All rights reserved.
#
# Redistribution and use of this software in source and binary forms,
# with or without modification, are permitted provided that the
# following conditions are met:
#
# The software must be used only for Non-Commercial Use which means any
# use which is NOT directed to receiving any direct monetary
# compensation for, or commercial advantage from such use.  Illustrative
# examples of non-commercial use are academic research, personal study,
# teaching, education and corporate research & development.
# Illustrative examples of commercial use are distributing products for
# commercial advantage and providing services using the software for
# commercial advantage.
#
# If you wish to use this software or functionality therein that may be
# covered by patents for commercial use, please contact:
#     Director of Intellectual Property Licensing
#     Office of Strategy and Technology
#     Hewlett-Packard Company
#     1501 Page Mill Road
#     Palo Alto, California  94304
#
# Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.  Redistributions
# in binary form must reproduce the above copyright notice, this list of
# conditions and the following disclaimer in the documentation and/or
# other materials provided with the distribution.  Neither the name of
# the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.  No right of
# sublicense is granted herewith.  Derivatives of the software and
# output created using the software may be prepared, but only for
# Non-Commercial Uses.  Derivatives of the software may be shared with
# others provided: (i) the others agree to abide by the list of
# conditions herein which includes the Non-Commercial Use restrictions;
# and (ii) such Derivatives of the software include the above copyright
# notice to acknowledge the contribution from this software where
# applicable, this list of conditions and the disclaimer below.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Authors: Gabe Black

microcode = '''
def macroop CMPS_M_M {
    # Find the constant we need to either add or subtract from rdi
    ruflag t0, 10
    movi t3, t3, dsz, flags=(CEZF,), dataSize=asz
    subi t4, t0, dsz, dataSize=asz
    mov t3, t3, t4, flags=(nCEZF,), dataSize=asz

    ld t1, seg, [1, t0, rsi]
    ld t2, es, [1, t0, rdi]
    sub t0, t1, t2, flags=(OF, SF, ZF, AF, PF, CF)

    add rdi, rdi, t3, dataSize=asz
    add rsi, rsi, t3, dataSize=asz
};

#
# Versions which have the rep prefix. These could benefit from some loop
# unrolling.
#

def macroop CMPS_E_M_M {
    and t0, rcx, rcx, flags=(EZF,), dataSize=asz
    br label("end"), flags=(CEZF,)

    # Find the constant we need to either add or subtract from rdi
    ruflag t0, 10
    movi t3, t3, dsz, flags=(CEZF,), dataSize=asz
    subi t4, t0, dsz, dataSize=asz
    mov t3, t3, t4, flags=(nCEZF,), dataSize=asz

topOfLoop:
    ld t1, seg, [1, t0, rsi]
    ld t2, es, [1, t0, rdi]
    sub t0, t1, t2, flags=(OF, SF, ZF, AF, PF, CF)

    subi rcx, rcx, 1, flags=(EZF,), dataSize=asz
    add rdi, rdi, t3, dataSize=asz
    add rsi, rsi, t3, dataSize=asz
    br label("topOfLoop"), flags=(CSTRZnEZF,)
end:
    fault "NoFault"
};

def macroop CMPS_N_M_M {
    and t0, rcx, rcx, flags=(EZF,), dataSize=asz
    br label("end"), flags=(CEZF,)

    # Find the constant we need to either add or subtract from rdi
    ruflag t0, 10
    movi t3, t3, dsz, flags=(CEZF,), dataSize=asz
    subi t4, t0, dsz, dataSize=asz
    mov t3, t3, t4, flags=(nCEZF,), dataSize=asz

topOfLoop:
    ld t1, seg, [1, t0, rsi]
    ld t2, es, [1, t0, rdi]
    sub t0, t1, t2, flags=(OF, SF, ZF, AF, PF, CF)

    subi rcx, rcx, 1, flags=(EZF,), dataSize=asz
    add rdi, rdi, t3, dataSize=asz
    add rsi, rsi, t3, dataSize=asz
    br label("topOfLoop"), flags=(CSTRnZnEZF,)
end:
    fault "NoFault"
};
'''