Adding upstream version 115.7.0esr.upstream/115.7.0esr

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 422 insertions, 0 deletions

diff --git a/js/src/zydis/Zydis/FormatterATT.c b/js/src/zydis/Zydis/FormatterATT.c
new file mode 100644
index 0000000000..f49712dd97
--- /dev/null
+++ b/js/src/zydis/Zydis/FormatterATT.c
@@ -0,0 +1,422 @@
+/***************************************************************************************************
+
+  Zyan Disassembler Library (Zydis)
+
+  Original Author : Florian Bernd, Joel Hoener
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+
+***************************************************************************************************/
+
+#include "zydis/Zydis/Internal/FormatterATT.h"
+
+/* ============================================================================================== */
+/* Constants                                                                                      */
+/* ============================================================================================== */
+
+#include "zydis/Zydis/Generated/FormatterStrings.inc"
+
+/* ============================================================================================== */
+/* Formatter functions                                                                            */
+/* ============================================================================================== */
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Instruction                                                                                    */
+/* ---------------------------------------------------------------------------------------------- */
+
+ZyanStatus ZydisFormatterATTFormatInstruction(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+    ZYAN_ASSERT(context->instruction);
+    ZYAN_ASSERT(context->operands);
+
+    ZYAN_CHECK(formatter->func_print_prefixes(formatter, buffer, context));
+    ZYAN_CHECK(formatter->func_print_mnemonic(formatter, buffer, context));
+
+    ZyanUPointer state_mnemonic;
+    ZYDIS_BUFFER_REMEMBER(buffer, state_mnemonic);
+
+    const ZyanI8 c = (ZyanI8)context->instruction->operand_count_visible - 1;
+    for (ZyanI8 i = c; i >= 0; --i)
+    {
+        const ZydisDecodedOperand* const operand = &context->operands[i];
+
+        // Print embedded-mask registers as decorator instead of a regular operand
+        if ((i == 1) && (operand->type == ZYDIS_OPERAND_TYPE_REGISTER) &&
+            (operand->encoding == ZYDIS_OPERAND_ENCODING_MASK))
+        {
+            continue;
+        }
+
+        ZyanUPointer buffer_state;
+        ZYDIS_BUFFER_REMEMBER(buffer, buffer_state);
+
+        if (buffer_state != state_mnemonic)
+        {
+            ZYDIS_BUFFER_APPEND(buffer, DELIM_OPERAND);
+        } else
+        {
+            ZYDIS_BUFFER_APPEND(buffer, DELIM_MNEMONIC);
+        }
+
+        // Set current operand
+        context->operand = operand;
+
+        ZyanStatus status;
+        if (formatter->func_pre_operand)
+        {
+            status = formatter->func_pre_operand(formatter, buffer, context);
+            if (status == ZYDIS_STATUS_SKIP_TOKEN)
+            {
+                ZYAN_CHECK(ZydisFormatterBufferRestore(buffer, buffer_state));
+                continue;
+            }
+            if (!ZYAN_SUCCESS(status))
+            {
+                return status;
+            }
+        }
+
+        switch (operand->type)
+        {
+        case ZYDIS_OPERAND_TYPE_REGISTER:
+            status = formatter->func_format_operand_reg(formatter, buffer, context);
+            break;
+        case ZYDIS_OPERAND_TYPE_MEMORY:
+            status = formatter->func_format_operand_mem(formatter, buffer, context);
+            break;
+        case ZYDIS_OPERAND_TYPE_POINTER:
+            status = formatter->func_format_operand_ptr(formatter, buffer, context);
+            break;
+        case ZYDIS_OPERAND_TYPE_IMMEDIATE:
+            status = formatter->func_format_operand_imm(formatter, buffer, context);
+            break;
+        default:
+            return ZYAN_STATUS_INVALID_ARGUMENT;
+        }
+        if (status == ZYDIS_STATUS_SKIP_TOKEN)
+        {
+            ZYAN_CHECK(ZydisFormatterBufferRestore(buffer, buffer_state));
+            continue;
+        }
+        if (!ZYAN_SUCCESS(status))
+        {
+            return status;
+        }
+
+        if (formatter->func_post_operand)
+        {
+            status = formatter->func_post_operand(formatter, buffer, context);
+            if (status == ZYDIS_STATUS_SKIP_TOKEN)
+            {
+                ZYAN_CHECK(ZydisFormatterBufferRestore(buffer, buffer_state));
+                continue;
+            }
+            if (ZYAN_SUCCESS(status))
+            {
+                return status;
+            }
+        }
+
+#if !defined(ZYDIS_DISABLE_AVX512) || !defined(ZYDIS_DISABLE_KNC)
+        if ((context->instruction->encoding == ZYDIS_INSTRUCTION_ENCODING_EVEX) ||
+            (context->instruction->encoding == ZYDIS_INSTRUCTION_ENCODING_MVEX))
+        {
+            if  ((i == 0) && 
+                (context->instruction->operand_count_visible > 1) && 
+                (context->operands[1].encoding == ZYDIS_OPERAND_ENCODING_MASK))
+            {
+                ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                    ZYDIS_DECORATOR_MASK));
+            }
+            if (operand->type == ZYDIS_OPERAND_TYPE_MEMORY)
+            {
+                ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                    ZYDIS_DECORATOR_BC));
+                if (context->instruction->encoding == ZYDIS_INSTRUCTION_ENCODING_MVEX)
+                {
+                    ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                        ZYDIS_DECORATOR_CONVERSION));
+                    ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                        ZYDIS_DECORATOR_EH));
+                }
+            } else
+            {
+                ZyanBool decorate_operand;
+                if (i == (context->instruction->operand_count_visible - 1))
+                {
+                    decorate_operand = operand->type != ZYDIS_OPERAND_TYPE_IMMEDIATE;
+                }
+                else
+                {
+                    decorate_operand =
+                        (context->instruction->operand_count_visible > (i + 1)) &&
+                        ((context->operands[i + 1].type == ZYDIS_OPERAND_TYPE_IMMEDIATE) ||
+                        (context->operands[i + 1].visibility == ZYDIS_OPERAND_VISIBILITY_HIDDEN));
+                }
+                if (decorate_operand)
+                {
+                    if (context->instruction->encoding == ZYDIS_INSTRUCTION_ENCODING_MVEX)
+                    {
+                        ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                            ZYDIS_DECORATOR_SWIZZLE));
+                    }
+                    ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                        ZYDIS_DECORATOR_RC));
+                    ZYAN_CHECK(formatter->func_print_decorator(formatter, buffer, context,
+                        ZYDIS_DECORATOR_SAE));
+                }
+            }
+        }
+#endif
+    }
+
+    return ZYAN_STATUS_SUCCESS;
+}
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Operands                                                                                       */
+/* ---------------------------------------------------------------------------------------------- */
+
+ZyanStatus ZydisFormatterATTFormatOperandMEM(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+
+    ZYAN_CHECK(formatter->func_print_segment(formatter, buffer, context));
+
+    const ZyanBool absolute = !formatter->force_relative_riprel &&
+        (context->runtime_address != ZYDIS_RUNTIME_ADDRESS_NONE);
+    if (absolute && context->operand->mem.disp.has_displacement &&
+        (context->operand->mem.index == ZYDIS_REGISTER_NONE) &&
+       ((context->operand->mem.base  == ZYDIS_REGISTER_NONE) ||
+        (context->operand->mem.base  == ZYDIS_REGISTER_EIP ) ||
+        (context->operand->mem.base  == ZYDIS_REGISTER_RIP )))
+    {
+        // EIP/RIP-relative or absolute-displacement address operand
+        ZYAN_CHECK(formatter->func_print_address_abs(formatter, buffer, context));
+    } else
+    {
+        const ZyanBool should_print_reg = context->operand->mem.base != ZYDIS_REGISTER_NONE;
+        const ZyanBool should_print_idx = context->operand->mem.index != ZYDIS_REGISTER_NONE;
+        const ZyanBool neither_reg_nor_idx = !should_print_reg && !should_print_idx;
+
+        // Regular memory operand
+        if (neither_reg_nor_idx)
+        {
+            ZYAN_CHECK(formatter->func_print_address_abs(formatter, buffer, context));
+        } else if (context->operand->mem.disp.has_displacement && context->operand->mem.disp.value)
+        {
+            ZYAN_CHECK(formatter->func_print_disp(formatter, buffer, context));
+        }
+
+        if (neither_reg_nor_idx)
+        {
+            return ZYAN_STATUS_SUCCESS;
+        }
+
+        ZYDIS_BUFFER_APPEND(buffer, MEMORY_BEGIN_ATT);
+
+        if (should_print_reg)
+        {
+            ZYAN_CHECK(formatter->func_print_register(formatter, buffer, context,
+                context->operand->mem.base));
+        }
+        if (should_print_idx)
+        {
+            ZYDIS_BUFFER_APPEND(buffer, DELIM_MEMORY);
+            ZYAN_CHECK(formatter->func_print_register(formatter, buffer, context,
+                context->operand->mem.index));
+            if (context->operand->mem.scale &&
+                (context->operand->mem.type != ZYDIS_MEMOP_TYPE_MIB) &&
+                ((context->operand->mem.scale > 1) || formatter->force_memory_scale))
+            {
+                ZYDIS_BUFFER_APPEND_TOKEN(buffer, ZYDIS_TOKEN_DELIMITER);
+                ZYDIS_BUFFER_APPEND(buffer, DELIM_MEMORY);
+                ZYDIS_BUFFER_APPEND_TOKEN(buffer, ZYDIS_TOKEN_IMMEDIATE);
+                ZYAN_CHECK(ZydisStringAppendDecU(&buffer->string, context->operand->mem.scale, 0,
+                    ZYAN_NULL, ZYAN_NULL));
+            }
+        }
+
+        ZYDIS_BUFFER_APPEND(buffer, MEMORY_END_ATT);
+        return ZYAN_STATUS_SUCCESS;
+    }
+
+    return ZYAN_STATUS_SUCCESS;
+}
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Elemental tokens                                                                               */
+/* ---------------------------------------------------------------------------------------------- */
+
+ZyanStatus ZydisFormatterATTPrintMnemonic(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+    ZYAN_ASSERT(context->instruction);
+    ZYAN_ASSERT(context->operands);
+
+    const ZydisShortString* mnemonic = ZydisMnemonicGetStringWrapped(
+        context->instruction->mnemonic);
+    if (!mnemonic)
+    {
+        ZYDIS_BUFFER_APPEND_CASE(buffer, INVALID_MNEMONIC, formatter->case_mnemonic);
+        return ZYAN_STATUS_SUCCESS;
+    }
+
+    ZYDIS_BUFFER_APPEND_TOKEN(buffer, ZYDIS_TOKEN_MNEMONIC);
+    if (context->instruction->meta.branch_type == ZYDIS_BRANCH_TYPE_FAR)
+    {
+        ZYAN_CHECK(ZydisStringAppendShortCase(&buffer->string, &STR_FAR_ATT,
+            formatter->case_mnemonic));
+    }
+    ZYAN_CHECK(ZydisStringAppendShortCase(&buffer->string, mnemonic, formatter->case_mnemonic));
+
+    // Append operand-size suffix
+    ZyanU32 size = 0;
+    for (ZyanU8 i = 0; i < context->instruction->operand_count_visible; ++i)
+    {
+        const ZydisDecodedOperand* const operand = &context->operands[i];
+        if ((operand->type == ZYDIS_OPERAND_TYPE_MEMORY) &&
+            ((operand->mem.type == ZYDIS_MEMOP_TYPE_MEM) ||
+             (operand->mem.type == ZYDIS_MEMOP_TYPE_VSIB)))
+        {
+            size = ZydisFormatterHelperGetExplicitSize(formatter, context, operand);
+            break;
+        }
+    }
+
+    switch (size)
+    {
+    case   8: ZydisStringAppendShort(&buffer->string, &STR_SIZE_8_ATT  ); break;
+    case  16: ZydisStringAppendShort(&buffer->string, &STR_SIZE_16_ATT ); break;
+    case  32: ZydisStringAppendShort(&buffer->string, &STR_SIZE_32_ATT ); break;
+    case  64: ZydisStringAppendShort(&buffer->string, &STR_SIZE_64_ATT ); break;
+    case 128: ZydisStringAppendShort(&buffer->string, &STR_SIZE_128_ATT); break;
+    case 256: ZydisStringAppendShort(&buffer->string, &STR_SIZE_256_ATT); break;
+    case 512: ZydisStringAppendShort(&buffer->string, &STR_SIZE_512_ATT); break;
+    default:
+        break;
+    }
+
+    if (formatter->print_branch_size)
+    {
+        switch (context->instruction->meta.branch_type)
+        {
+        case ZYDIS_BRANCH_TYPE_NONE:
+            break;
+        case ZYDIS_BRANCH_TYPE_SHORT:
+            return ZydisStringAppendShortCase(&buffer->string, &STR_SHORT,
+                formatter->case_mnemonic);
+        case ZYDIS_BRANCH_TYPE_NEAR:
+            return ZydisStringAppendShortCase(&buffer->string, &STR_NEAR,
+                formatter->case_mnemonic);
+        default:
+            return ZYAN_STATUS_INVALID_ARGUMENT;
+        }
+    }
+
+    return ZYAN_STATUS_SUCCESS;
+}
+
+ZyanStatus ZydisFormatterATTPrintRegister(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context, ZydisRegister reg)
+{
+    ZYAN_UNUSED(context);
+
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+
+    ZYDIS_BUFFER_APPEND(buffer, REGISTER);
+    const ZydisShortString* str = ZydisRegisterGetStringWrapped(reg);
+    if (!str)
+    {
+        return ZydisStringAppendShortCase(&buffer->string, &STR_INVALID_REG,
+            formatter->case_registers);
+    }
+    return ZydisStringAppendShortCase(&buffer->string, str, formatter->case_registers);
+}
+
+ZyanStatus ZydisFormatterATTPrintAddressABS(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+
+    if ((context->instruction->meta.branch_type != ZYDIS_BRANCH_TYPE_NONE) &&
+        (context->operand->type == ZYDIS_OPERAND_TYPE_MEMORY))
+    {
+        ZYDIS_BUFFER_APPEND(buffer, MUL);
+    }
+
+    return ZydisFormatterBasePrintAddressABS(formatter, buffer, context);
+}
+
+ZyanStatus ZydisFormatterATTPrintDISP(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+
+    ZYDIS_BUFFER_APPEND_TOKEN(buffer, ZYDIS_TOKEN_DISPLACEMENT);
+    switch (formatter->disp_signedness)
+    {
+    case ZYDIS_SIGNEDNESS_AUTO:
+    case ZYDIS_SIGNEDNESS_SIGNED:
+        ZYDIS_STRING_APPEND_NUM_S(formatter, formatter->disp_base, &buffer->string,
+            context->operand->mem.disp.value, formatter->disp_padding, 
+            formatter->hex_force_leading_number, ZYAN_FALSE);
+        break;
+    case ZYDIS_SIGNEDNESS_UNSIGNED:
+        ZYDIS_STRING_APPEND_NUM_U(formatter, formatter->disp_base, &buffer->string,
+            context->operand->mem.disp.value, formatter->disp_padding, 
+            formatter->hex_force_leading_number);
+        break;
+    default:
+        return ZYAN_STATUS_INVALID_ARGUMENT;
+    }
+
+    return ZYAN_STATUS_SUCCESS;
+}
+
+ZyanStatus ZydisFormatterATTPrintIMM(const ZydisFormatter* formatter,
+    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)
+{
+    ZYAN_ASSERT(formatter);
+    ZYAN_ASSERT(buffer);
+    ZYAN_ASSERT(context);
+
+    ZYDIS_BUFFER_APPEND(buffer, IMMEDIATE);
+    return ZydisFormatterBasePrintIMM(formatter, buffer, context);
+}
+
+/* ---------------------------------------------------------------------------------------------- */
+
+/* ============================================================================================== */