Purpose: Defines files and directories to be ignored by Git.

Key Logic: Lists files and directories to be ignored by Git.

Notes: Files and directories like .o, .obj, .exe, .pyc, and logs are excluded from version control.

Purpose: Provides guidelines for contributing to the XED project, including license information and sign-off.

Key Logic: Documents contribution guidelines and sign-off process.

Notes: Includes sign-off line for contributors.

Purpose: Specifies the Apache License 2.0 for the XED project.

Key Logic: Lists the terms and conditions for using, reproducing, and distributing the XED project.

Notes: Provides the license terms and conditions.

Purpose: Provides instructions for building and using the XED project, including source build and building examples.

Dependencies: genutil, mbuild

Key Logic: Outlines the steps for building the XED project and using the examples.

Notes: Includes abbreviated instructions for building and using the XED project.

Purpose: Specifies external dependencies and their usage in the project.

Dependencies: None

Key Logic: Lists external dependencies and their usage in the project.

Notes: Contains a list of system calls and variables used by the project.

Purpose: This file contains the main documentation for Intel XED build process, including build guides, installation instructions, and system requirements.

Imports: doxygen

Key Components:

• @if (conditional): Conditional inclusion based on the value of the EXTERNAL macro.
• @mainpage (macro): Defines the main page for the documentation.
• @section (macro): Defines a section within the documentation.
• @ref (macro): Defines a reference within the documentation.
• @if (conditional): Conditional inclusion based on the value of the INTERNAL macro.

Data Structures: None

Algorithms: None

Configuration: The build system uses the compilers from the user's PATH by default, but can be overridden with command line options.

Notes: The file includes a table of contents and links to various sections of the documentation.

Purpose: Defines private functions for chip features testing and checking.

Exports: xed_test_chip_features, xed_test_features

Imports: xed_types.h, xed-chip-features.h, xed-isa-set.h

Important Functions:

• xed_test_chip_features
• xed_test_features

Dependencies: xed_types.h, xed-chip-features.h, xed-isa-set.h

Key Logic: Provides functions for testing chip features and checking ISA sets.

Notes: Includes private header files for internal use.

Purpose: Defines functions for overriding chip modes and features.

Exports: xed_chip_modes_override1, xed_chip_modes_override2, set_decoder_control_ops

Imports: xed-chip-enum.h, xed-decoded-inst.h, xed-chip-features.h, xed-chip-features-private.h, xed-operand-accessors.h, xed-isa-set.h

Important Functions:

• xed_chip_modes_override1
• xed_chip_modes_override2
• set_decoder_control_ops

Dependencies: xed-chip-enum.h, xed-decoded-inst.h, xed-chip-features.h, xed-chip-features-private.h, xed-operand-accessors.h, xed-isa-set.h

Key Logic: Provides functions for overriding chip modes and features.

Notes: Includes private and public header files for internal use.

Purpose: Defines functions for setting chip modes and features.

Exports: set_chip_modes

Imports: xed-chip-enum.h, xed-decoded-inst.h, xed-chip-features.h

Important Functions:

• set_chip_modes

Dependencies: xed-chip-enum.h, xed-decoded-inst.h, xed-chip-features.h

Key Logic: Provides functions for setting chip modes and features.

Notes: Includes public header files for external use.

Purpose: Defines macros and variables for profiling XED (X86 Decoder) operations, including iteration counts and node frequency.

Exports: BUMP_PROFILE

Imports: xed_common_hdrs.h, xed_types.h, xed_error_enum.h, xed_operand_values_interface.h, xed_operand_width_enum.h

Dependencies: xed_common_hdrs.h, xed_types.h, xed_error_enum.h, xed_operand_values_interface.h, xed_operand_width_enum.h

Key Logic: Defines macros for profiling XED operations and initializes arrays for iteration counts and node frequency.

Notes: Defines macros for profiling XED operations and initializes arrays for iteration counts and node frequency.

Purpose: Contains static inline functions for checking register values and setting error flags in decoded instructions.

Exports: xed_check_reg

Imports: xed_common_hdrs.h, xed_types.h, xed_error_enum.h, xed_operand_values_interface.h

Dependencies: xed_common_hdrs.h, xed_types.h, xed_error_enum.h, xed_operand_values_interface.h

Key Logic: Provides functions to check register values and set error flags in decoded instructions.

Notes: Provides functions to check register values and set error flags in decoded instructions.

Purpose: Contains static inline functions for decoded instruction management, including error handling and operand length calculation.

Exports: xed_decoded_inst_get_error, xed_decoded_inst_set_inst, xed_decoded_inst_compute_memory_operand_length, xed_decoded_inst_cache_memory_operand_length, xed_decoded_inst_set_length

Imports: xed_common_hdrs.h, xed_types.h, xed_portability.h, xed_decoded_inst.h

Dependencies: xed_common_hdrs.h, xed_types.h, xed_portability.h, xed_decoded_inst.h

Key Logic: Provides functions for managing decoded instructions, including error handling and operand length calculation.

Notes: Provides functions for managing decoded instructions, including error handling and operand length calculation.

Purpose: Contains functions for symbolic disassembly, including a function to retrieve symbolic disassembly information.

Exports: xed_get_symbolic_disassembly

Imports: xed_common_hdrs.h, xed_disas.h, xed_print_info.h

Dependencies: xed_common_hdrs.h, xed_disas.h, xed_print_info.h

Key Logic: Provides a function to retrieve symbolic disassembly information.

Notes: Provides a function to retrieve symbolic disassembly information.

Purpose: Contains functions for checking encoding arguments, including functions for invalid register checks.

Exports: xed_enc2_check_args, xed_enc2_invalid_cr, xed_enc2_invalid_dr, xed_enc2_invalid_seg, xed_enc2_invalid_gpr16, xed_enc2_invalid_gpr32, xed_enc2_invalid_gpr64, xed_enc2_invalid_gpr16_index

Imports: xed_common_hdrs.h, xed_types.h

Dependencies: xed_common_hdrs.h, xed_types.h

Key Logic: Provides functions for checking encoding arguments and handling invalid register checks.

Notes: Provides functions for checking encoding arguments and handling invalid register checks.

Purpose: Contains functions for encoding instructions, including functions for nonterminal instructions.

Exports: xed_encode_nonterminal_INSTRUCTIONS_EMIT, xed_encode_nonterminal_INSTRUCTIONS_BIND

Imports: xed_common_hdrs.h, xed_encode.h

Dependencies: xed_common_hdrs.h, xed_encode.h

Key Logic: Provides functions for encoding instructions, including nonterminal instructions.

Notes: Provides functions for encoding instructions, including nonterminal instructions.

Purpose: Defines private functions and constants used in the xed-encode module, including encoding functions and constants.

Exports: xed_encoder_request_ev_const, xed_encoder_request_ev, xed_encoder_request_vars_remove, xed_encoder_request_vars_zero

Imports: xed_encoder_request_t, xed_encoder_request_vars_t, xed_encoder_vars_t, xed_encoder_iforms_t, xed_error_enum_t, xed_operand_values_interface_t, xed_operand_width_enum_t, xed_ild_private_t

Important Functions:

• xed_encoder_request_ev_const
• xed_encoder_request_ev
• xed_encoder_request_vars_remove
• xed_encoder_request_vars_zero

Dependencies: xed_encoder_request_t, xed_encoder_request_vars_t, xed_encoder_request_vars_t, xed_encoder_iforms_t, xed_error_enum_t, xed_operand_values_interface_t, xed_operand_width_enum_t, xed_ild_private_t, xed_encoder_iforms_t, xed_encoder_gen_defs_t, memset

Key Logic: Provides static inline functions for managing encoding requests and variables, including handling of encoding request structures and variables.

Notes: The file includes various constants and pointers to other header files, such as xed-encode-types.h, xed-encode-tables.h, and xed-flags-private.h.

Purpose: Defines tables and constants used in the xed-encode module, including encoding groups and patterns.

Exports: xed_encode_groups, xed_enc_iclass2group, xed_enc_iclass2index_in_group, xed_encode_order, xed_encode_order_limit, xed_encode_fb_lu_table, xed_encode_emit_lu_table, xed_encode_fb_values_table

Imports: xed_encoder_function_pointer_t, xed_uint16_t, xed_uint8_t, xed_uint_t, xed_ptrn_func_ptr_t

Dependencies: xed_encoder_function_pointer_t, xed_uint16_t, xed_uint8_t, xed_uint_t, xed_ptrn_func_ptr_t

Key Logic: Provides constants and pointers to tables used in encoding functions.

Notes: The file includes tables for encoding groups, patterns, and values, as well as function pointers for encoding.

Purpose: Defines types and constants used in the xed-encode module, including encoding function pointers and structures.

Exports: xed_encode_function_pointer_t, xed_nt_func_ptr_t, xed_ntluf_func_ptr_t, xed_ptrn_func_ptr_t, xed_encoder_iform_t, xed_encoder_vars_t

Imports: xed_encoder_request_t, xed_encoder_request_vars_t, xed_encoder_request_vars_t, xed_encoder_iforms_t, xed_error_enum_t, xed_operand_values_interface_t, xed_operand_width_enum_t, xed_ild_private_t

Dependencies: xed_encoder_request_t, xed_encoder_request_vars_t, xed_encoder_request_vars_t, xed_encoder_iforms_t, xed_error_enum_t, xed_operand_values_interface_t, xed_operand_width_enum_t, xed_ild_private_t, xed_encoder_gen_defs_t

Key Logic: Defines the structure and function pointers used in encoding.

Notes: The file includes types for encoding function pointers, encoding variables, and encoding forms.

Purpose: Defines flags and complex flags used in the xed-flags module, including complex flag structures and functions.

Exports: XED_FLAG_CASE_IMMED_ZERO, XED_FLAG_CASE_IMMED_ONE, XED_FLAG_CASE_IMMED_OTHER, XED_FLAG_CASE_HAS_REP, XED_FLAG_CASE_NO_REP, xed_complex_flag_t, xed_complex_flag_zero

Imports: xed_flag_cases_enum_t, xed_complex_flag_t

Important Functions:

• xed_complex_flag_zero

Dependencies: xed_flag_cases_enum_t, xed_complex_flag_t

Key Logic: Defines complex flag structures and functions for handling flags and complex flags.

Notes: The file includes flags and complex flag structures for managing and handling flags in the xed-flags module.

Purpose: Defines the xed-ild-extension module, which is an extension to the instruction length decoder.

Dependencies: xed_ild_private_t

Key Logic: Provides constants and structures for the xed-ild-extension module.

Notes: The file is empty and does not export any symbols or import any headers.

Purpose: A script for managing the build process of the XED project, including compiling and linking.

Imports: sys, os, genutil

Dependencies: genutil

Key Logic: Executes the build process based on command-line arguments.

Notes: Includes additional imports for managing the build process.

Purpose: This file contains a list of all the function and class names exported by the XED (eXtended Disassembly Engine) library. It is a reference file for developers to understand the API.

Exports: str2xed_address_width_enum_t, str2xed_attribute_enum_t, str2xed_category_enum_t, str2xed_chip_enum_t, str2xed_cpuid_rec_enum_t, str2xed_error_enum_t, str2xed_exception_enum_t, str2xed_extension_enum_t

Imports: os, flask

Key Components:

• xed_decode (function): Decodes instructions based on the XED (eXtended Disassembly Engine) library.
• xed_attribute (class): Manages and provides attributes related to XED disassembly.

Data Structures: None explicitly defined, but various enums and types are used.

Algorithms: None explicitly defined, but the decoding process involves algorithmic logic.

Configuration: None explicitly defined, but the library is configured through external settings or parameters.

Notes: This file is a reference for the exported symbols and does not contain any implementation details. Developers should consult the library's documentation for more information on each function and class.

Purpose: Contains detailed notes on the project, particularly on the Intel X86 Encoder Decoder.

Dependencies: None

Key Logic: Lists and explains various tokens and their usage in the project.

Notes: Lists tokens and their usage in the project, including additional imports found.

Purpose: Provides legal information and license details for the project.

Dependencies: None

Key Logic: Contains a legal disclaimer and copyright information.

Notes: Contains legal information and license details.

Purpose: Runs tests for the XED project using various test directories and configurations.

Imports: os, flask, pandas

Dependencies: os, flask, pandas

Key Logic: Executes a command to run tests for different configurations and test directories.

Notes: The command runs multiple tests using different configurations and directories.