summaryrefslogtreecommitdiff
path: root/arch/x86/code_generator/README.md
diff options
context:
space:
mode:
authorRusty Wagner <rusty.wagner@gmail.com>2024-03-05 19:50:13 -0500
committerRusty Wagner <rusty.wagner@gmail.com>2024-03-05 20:34:34 -0500
commite093c21ed880ac3eb72119be15093ee04f8ce299 (patch)
tree9f720ebdc0ae415734b1199ed341668c69710a94 /arch/x86/code_generator/README.md
parent0609276712622908254065546102381466033141 (diff)
Move architecture modules into the API repo
Diffstat (limited to 'arch/x86/code_generator/README.md')
-rw-r--r--arch/x86/code_generator/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/arch/x86/code_generator/README.md b/arch/x86/code_generator/README.md
new file mode 100644
index 00000000..5c53ad1f
--- /dev/null
+++ b/arch/x86/code_generator/README.md
@@ -0,0 +1,11 @@
+This README explains the process of generating the input and output type information for x86 intrinsics.
+
+It takes two major steps:
+
+1. Tweak the xed build process and generate the information for each iform.
+ - Apply the `patch.diff` to `$XED_SOURCE/pysrc/generator.py`
+ - Build xed and harvest the `iform-type-dump.txt`
+ - Copy the `iform-type-dump.txt` to the current folder
+
+2. run the `parse-iform-types.py`
+ - It will generate `../x86_intrinsic_input_type.cpp` and `../x86_intrinsic_output_type.cpp`. \ No newline at end of file