doc: documentation work

3 files changed, 331 insertions, 1 deletions

diff --git a/testsuite/Makefile.am b/testsuite/Makefile.am
index ee30e71..acfcd6a 100644
--- a/testsuite/Makefile.am
+++ b/testsuite/Makefile.am
@@ -14,7 +14,7 @@ XFAIL_TESTS = \
 	exec_opcodes_float \
 	exec_opcodes_pixel
 
-orcbin_PROGRAMS = $(TESTS)
+orcbin_PROGRAMS = $(TESTS) generate_xml_table generate_xml_table2
 
 CLEANFILES = temp-orc-test-*
 
diff --git a/testsuite/generate_xml_table.c b/testsuite/generate_xml_table.c
new file mode 100644
index 0000000..f4c2ba8
--- /dev/null
+++ b/testsuite/generate_xml_table.c
@@ -0,0 +1,100 @@
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <orc/orc.h>
+#include <orc-test/orctest.h>
+
+
+int error = FALSE;
+
+char * test_opcode (OrcStaticOpcode *opcode, OrcTarget *target,
+    unsigned int target_flags);
+
+int
+main (int argc, char *argv[])
+{
+  int i;
+  int j;
+  OrcOpcodeSet *opcode_set;
+  OrcTarget *targets[10];
+  unsigned int target_flags[10];
+  int n_targets;
+
+  orc_init();
+  orc_test_init();
+
+  targets[0] = orc_target_get_by_name("sse");
+  target_flags[0] = orc_target_get_default_flags(targets[0]);
+
+  targets[1] = orc_target_get_by_name("mmx");
+  target_flags[1] = orc_target_get_default_flags(targets[1]);
+
+  targets[2] = orc_target_get_by_name("altivec");
+  target_flags[2] = orc_target_get_default_flags(targets[2]);
+
+  targets[3] = orc_target_get_by_name("arm");
+  target_flags[3] = orc_target_get_default_flags(targets[3]);
+
+  n_targets=4;
+  
+  printf(
+"<table frame=\"all\" id=\"table-basictypes\" xreflabel=\"Table of Opcode Rule Coverage\">\n"
+"<title>Table of Opcode Rule Coverage</title>\n"
+"<tgroup cols=\"%d\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n"
+"<thead>\n"
+"<row>\n"
+"<entry>opcode name</entry>\n", n_targets+1);
+    for(j=0;j<n_targets;j++){
+      printf("<entry>%s</entry>\n",
+        orc_target_get_name(targets[j]));
+    }
+  printf(
+"</row>\n"
+"</thead>\n"
+"<tbody valign=\"top\">\n");
+
+  opcode_set = orc_opcode_set_get ("sys");
+
+  for(i=0;i<opcode_set->n_opcodes;i++){
+    printf("<row>\n");
+    printf("<entry>%s</entry>\n", opcode_set->opcodes[i].name);
+    for(j=0;j<n_targets;j++){
+      printf("<entry>%s</entry>\n",
+        test_opcode (opcode_set->opcodes + i, targets[j], target_flags[j]));
+    }
+    printf("</row>\n");
+  }
+  printf(
+"</tbody>\n"
+"</tgroup>\n"
+"</table>\n");
+
+  return 0;
+}
+
+char *
+test_opcode (OrcStaticOpcode *opcode, OrcTarget *target,
+    unsigned int target_flags)
+{
+  OrcProgram *p;
+  OrcCompileResult ret;
+
+  p = orc_test_get_program_for_opcode (opcode);
+  if (!p) return "fail";
+
+  ret = orc_program_compile_full (p, target, target_flags);
+  orc_program_free (p);
+
+  if (ORC_COMPILE_RESULT_IS_FATAL(ret)) {
+    //return "fail";
+    return "no";
+  }
+  if (ORC_COMPILE_RESULT_IS_SUCCESSFUL(ret)) {
+    return "yes";
+  }
+  return "no";
+}
+
diff --git a/testsuite/generate_xml_table2.c b/testsuite/generate_xml_table2.c
new file mode 100644
index 0000000..1d85de1
--- /dev/null
+++ b/testsuite/generate_xml_table2.c
@@ -0,0 +1,230 @@
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <orc/orc.h>
+#include <orc-test/orctest.h>
+
+
+int error = FALSE;
+
+char * get_desc (OrcStaticOpcode *opcode);
+char * get_code (OrcStaticOpcode *opcode);
+
+int
+main (int argc, char *argv[])
+{
+  int i;
+  OrcOpcodeSet *opcode_set;
+  OrcTarget *targets[10];
+  unsigned int target_flags[10];
+  int n_targets;
+
+  orc_init();
+  orc_test_init();
+
+  targets[0] = orc_target_get_by_name("sse");
+  target_flags[0] = orc_target_get_default_flags(targets[0]);
+
+  targets[1] = orc_target_get_by_name("mmx");
+  target_flags[1] = orc_target_get_default_flags(targets[1]);
+
+  targets[2] = orc_target_get_by_name("altivec");
+  target_flags[2] = orc_target_get_default_flags(targets[2]);
+
+  targets[3] = orc_target_get_by_name("arm");
+  target_flags[3] = orc_target_get_default_flags(targets[3]);
+
+  n_targets=4;
+  
+  printf(
+"<table frame=\"all\" id=\"table-basictypes\" xreflabel=\"Table of Opcodes\">\n"
+"<title>Table of Opcodes</title>\n"
+"<tgroup cols=\"3\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n"
+"<thead>\n"
+"<row>\n"
+"<entry>opcode</entry>\n"
+"<entry>destination</entry>\n"
+"<entry>source 1</entry>\n"
+"<entry>source 2</entry>\n"
+"<entry>description</entry>\n"
+"<entry>pseudo code</entry>\n"
+"</row>\n"
+"</thead>\n"
+"<tbody valign=\"top\">\n");
+
+  opcode_set = orc_opcode_set_get ("sys");
+
+  for(i=0;i<opcode_set->n_opcodes;i++){
+    printf("<row>\n");
+    printf("<entry>%s</entry>\n", opcode_set->opcodes[i].name);
+    printf("<entry>%d</entry>\n", opcode_set->opcodes[i].dest_size[0]);
+    printf("<entry>%d</entry>\n", opcode_set->opcodes[i].src_size[0]);
+    if (opcode_set->opcodes[i].src_size[1]) {
+      printf("<entry>%d</entry>\n", opcode_set->opcodes[i].src_size[1]);
+    } else {
+      printf("<entry></entry>\n");
+    }
+    printf("<entry>%s</entry>\n", get_desc(&opcode_set->opcodes[i]));
+    printf("<entry>%s</entry>\n", get_code(&opcode_set->opcodes[i]));
+    printf("</row>\n");
+  }
+  printf(
+"</tbody>\n"
+"</tgroup>\n"
+"</table>\n");
+
+  return 0;
+}
+
+struct a {
+  char *name;
+  char *code;
+  char *desc;
+};
+
+struct a ops[] = {
+  { "absb", "(a &lt; 0) ? -a : a", "absolute value" },
+  { "addb", "a + b", "add" },
+  { "addssb", "clamp(a + b)", "add with signed saturate" },
+  { "addusb", "clamp(a + b)", "add with unsigned saturate" },
+  { "andb", "a &amp; b", "bitwise AND" },
+  { "andnb", "a &amp; (~b)", "bitwise AND NOT" },
+  { "avgsb", "(a + b + 1)&gt;&gt;1", "signed average" },
+  { "avgub", "(a + b + 1)&gt;&gt;1", "unsigned average" },
+  { "cmpeqb", "(a == b) ? (~0) : 0", "compare equal" },
+  { "cmpgtsb", "(a &gt; b) ? (~0) : 0", "compare greater than" },
+  { "copyb", "a", "copy" },
+  { "maxsb", "(a &gt; b) ? a : b", "signed maximum" },
+  { "maxub", "(a &gt; b) ? a : b", "unsigned maximum" },
+  { "minsb", "(a &lt; b) ? a : b", "signed minimum" },
+  { "minub", "(a &lt; b) ? a : b", "unsigned minimum" },
+  { "mullb", "a * b", "low bits of multiply" },
+  { "mulhsb", "(a * b) &gt;&gt; 8", "high bits of signed multiply" },
+  { "mulhub", "(a * b) &gt;&gt; 8", "high bits of unsigned multiply" },
+  { "orb", "a | b", "bitwise or" },
+  { "shlb", "a &lt;&lt; b", "shift left" },
+  { "shrsb", "a &gt;&gt; b", "signed shift right" },
+  { "shrub", "a &gt;&gt; b", "unsigned shift right" },
+  { "signb", "sign(a)", "sign" },
+  { "subb", "a - b", "subtract" },
+  { "subssb", "clamp(a - b)", "subtract with signed saturate" },
+  { "subusb", "clamp(a - b)", "subtract with unsigned saturate" },
+  { "xorb", "a ^ b", "bitwise XOR" },
+
+  { "absw", "(a &lt; 0) ? -a : a", "absolute value" },
+  { "addw", "a + b", "add" },
+  { "addssw", "clamp(a + b)", "add with signed saturate" },
+  { "addusw", "clamp(a + b)", "add with unsigned saturate" },
+  { "andw", "a &amp; b", "bitwise AND" },
+  { "andnw", "a &amp; (~b)", "bitwise AND NOT" },
+  { "avgsw", "(a + b + 1)&gt;&gt;1", "signed average" },
+  { "avguw", "(a + b + 1)&gt;&gt;1", "unsigned average" },
+  { "cmpeqw", "(a == b) ? (~0) : 0", "compare equal" },
+  { "cmpgtsw", "(a &gt; b) ? (~0) : 0", "compare greater than" },
+  { "copyw", "a", "copy" },
+  { "maxsw", "(a &gt; b) ? a : b", "signed maximum" },
+  { "maxuw", "(a &gt; b) ? a : b", "unsigned maximum" },
+  { "minsw", "(a &lt; b) ? a : b", "signed minimum" },
+  { "minuw", "(a &lt; b) ? a : b", "unsigned minimum" },
+  { "mullw", "a * b", "low bits of multiply" },
+  { "mulhsw", "(a * b) &gt;&gt; 8", "high bits of signed multiply" },
+  { "mulhuw", "(a * b) &gt;&gt; 8", "high bits of unsigned multiply" },
+  { "orw", "a | b", "bitwise or" },
+  { "shlw", "a &lt;&lt; b", "shift left" },
+  { "shrsw", "a &gt;&gt; b", "signed shift right" },
+  { "shruw", "a &gt;&gt; b", "unsigned shift right" },
+  { "signw", "sign(a)", "sign" },
+  { "subw", "a - b", "subtract" },
+  { "subssw", "clamp(a - b)", "subtract with signed saturate" },
+  { "subusw", "clamp(a - b)", "subtract with unsigned saturate" },
+  { "xorw", "a ^ b", "bitwise XOR" },
+
+  { "absl", "(a &lt; 0) ? -a : a", "absolute value" },
+  { "addl", "a + b", "add" },
+  { "addssl", "clamp(a + b)", "add with signed saturate" },
+  { "addusl", "clamp(a + b)", "add with unsigned saturate" },
+  { "andl", "a &amp; b", "bitwise AND" },
+  { "andnl", "a &amp; (~b)", "bitwise AND NOT" },
+  { "avgsl", "(a + b + 1)&gt;&gt;1", "signed average" },
+  { "avgul", "(a + b + 1)&gt;&gt;1", "unsigned average" },
+  { "cmpeql", "(a == b) ? (~0) : 0", "compare equal" },
+  { "cmpgtsl", "(a &gt; b) ? (~0) : 0", "compare greater than" },
+  { "copyl", "a", "copy" },
+  { "maxsl", "(a &gt; b) ? a : b", "signed maximum" },
+  { "maxul", "(a &gt; b) ? a : b", "unsigned maximum" },
+  { "minsl", "(a &lt; b) ? a : b", "signed minimum" },
+  { "minul", "(a &lt; b) ? a : b", "unsigned minimum" },
+  { "mulll", "a * b", "low bits of multiply" },
+  { "mulhsl", "(a * b) &gt;&gt; 8", "high bits of signed multiply" },
+  { "mulhul", "(a * b) &gt;&gt; 8", "high bits of unsigned multiply" },
+  { "orl", "a | b", "bitwise or" },
+  { "shll", "a &lt;&lt; b", "shift left" },
+  { "shrsl", "a &gt;&gt; b", "signed shift right" },
+  { "shrul", "a &gt;&gt; b", "unsigned shift right" },
+  { "signl", "sign(a)", "sign" },
+  { "subl", "a - b", "subtract" },
+  { "subssl", "clamp(a - b)", "subtract with signed saturate" },
+  { "subusl", "clamp(a - b)", "subtract with unsigned saturate" },
+  { "xorl", "a ^ b", "bitwise XOR" },
+
+  { "convsbw", "a", "convert signed" },
+  { "convubw", "a", "convert unsigned" },
+  { "convswl", "a", "convert signed" },
+  { "convuwl", "a", "convert unsigned" },
+  { "convwb", "a", "convert" },
+  { "convssswb", "clamp(a)", "convert signed to signed with saturation" },
+  { "convsuswb", "clamp(a)", "convert signed to unsigned with saturation" },
+  { "convusswb", "clamp(a)", "convert unsigned to signed with saturation" },
+  { "convuuswb", "clamp(a)", "convert unsigned to unsigned with saturation" },
+  { "convlw", "a", "convert" },
+  { "convssslw", "clamp(a)", "convert signed to unsigned with saturation" },
+  { "convsuslw", "clamp(a)", "convert signed to signed with saturation" },
+  { "convusslw", "clamp(a)", "convert unsigned to unsigned with saturation" },
+  { "convuuslw", "clamp(a)", "convert unsigned to signed with saturation" },
+  { "mulsbw", "a * b", "multiply signed" },
+  { "mulubw", "a * b", "multiply unsigned" },
+  { "mulswl", "a * b", "multiply signed" },
+  { "muluwl", "a * b", "multiply unsigned" },
+  { "mergewl", "special", "merge halves" },
+  { "mergebw", "special", "merge halves" },
+  { "select0wb", "special", "select first half" },
+  { "select1wb", "special", "select second half" },
+  { "select0lw", "special", "select first half" },
+  { "select1lw", "special", "select second half" },
+  { "swapw", "special", "endianness swap" },
+  { "swapl", "special", "endianness swap" },
+
+  { "accw", "+= a", "accumulate" },
+  { "accl", "+= a", "accumulate" },
+  { "accsadubl", "+= abs(a - b)", "accumulate absolute difference" }
+};
+
+
+char *
+get_desc (OrcStaticOpcode *opcode)
+{
+  int i;
+  for(i=0;i<sizeof(ops)/sizeof(ops[0]);i++){
+    if (strcmp (opcode->name, ops[i].name) == 0) {
+      return ops[i].desc;
+    }
+  }
+  return "";
+}
+
+char *
+get_code (OrcStaticOpcode *opcode)
+{
+  int i;
+  for(i=0;i<sizeof(ops)/sizeof(ops[0]);i++){
+    if (strcmp (opcode->name, ops[i].name) == 0) {
+      return ops[i].code;
+    }
+  }
+  return "";
+}
+