Merge remote-tracking branch 'origin/main' into frontendtestinggh-1479

5 files changed, 210 insertions, 0 deletions

diff --git a/lib/handlers/assembly-documentation/amd64.js b/lib/handlers/assembly-documentation/amd64.js
new file mode 100644
index 000000000..5b2f6b7d6
--- /dev/null
+++ b/lib/handlers/assembly-documentation/amd64.js
@@ -0,0 +1,42 @@
+// Copyright (c) 2021, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+//     * 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.
+//
+// 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 HOLDER 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.
+
+import { getAsmOpcode } from '../asm-docs-amd64';
+import { BaseAssemblyDocumentationHandler } from '../base-assembly-documentation-handler';
+
+const ATT_SUFFIX_REMOVER = /^([a-z]+)[blqw]$/i;
+
+export class Amd64DocumentationHandler extends BaseAssemblyDocumentationHandler {
+    getInstructionInformation(instruction) {
+        // Try both default and with AT&T suffix removed
+        let info = getAsmOpcode(instruction);
+        if (!info) {
+            const alternativeInstruction = ATT_SUFFIX_REMOVER.exec(instruction);
+            if (alternativeInstruction) {
+                info = getAsmOpcode(alternativeInstruction[1]);
+            }
+        }
+        return info || null;
+    }
+}
diff --git a/lib/handlers/assembly-documentation/arm32.js b/lib/handlers/assembly-documentation/arm32.js
new file mode 100644
index 000000000..66c680409
--- /dev/null
+++ b/lib/handlers/assembly-documentation/arm32.js
@@ -0,0 +1,71 @@
+// Copyright (c) 2021, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+//     * 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.
+//
+// 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 HOLDER 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.
+
+import { getAsmOpcode } from '../asm-docs-arm32';
+import { BaseAssemblyDocumentationHandler } from '../base-assembly-documentation-handler';
+
+const CONDITIONAL_INSTRUCTION_REGEXP = /^([A-Za-z]+?)(EQ|NE|CS|CC|MI|PL|VS|VC|HI|LS|GE|LT|GT|LE|AL)$/;
+
+export class Arm32DocumentationHandler extends BaseAssemblyDocumentationHandler {
+    // Notes for conditionals:
+    // https://developer.arm.com/documentation/dui0473/m/condition-codes/condition-code-suffixes-and-related-flags
+    getOpcodeConditional(opcode) {
+        if (!opcode) return;
+
+        const conditionals = {
+            EQ: 'If equal, ',
+            NE: 'If not equal, ',
+            CS: 'If carry set, ',
+            CC: 'If carry clear, ',
+            MI: 'If negative, ',
+            PL: 'If positive or zero, ',
+            VS: 'If overflow, ',
+            VC: 'If no overflow, ',
+            HI: 'If unsigned higher, ',
+            LS: 'If unsigned lower or same, ',
+            GE: 'If signed greater than or equal, ',
+            LT: 'If signed less than, ',
+            GT: 'If signed greater than, ',
+            LE: 'If signed less than or equal, ',
+        };
+
+        const matches = opcode.match(CONDITIONAL_INSTRUCTION_REGEXP);
+        if (matches) {
+            const opcodeDescription = getAsmOpcode(matches[1]);
+            if (!opcodeDescription) return;
+
+            const conditionalText = conditionals[matches[2]] || '';
+
+            opcodeDescription.tooltip = conditionalText + opcodeDescription.tooltip;
+            opcodeDescription.html = conditionalText + opcodeDescription.html;
+
+            return opcodeDescription;
+        }
+    }
+
+    getInstructionInformation(instruction) {
+        const info = getAsmOpcode(instruction) || this.getOpcodeConditional(instruction);
+        return info || null;
+    }
+}
diff --git a/lib/handlers/assembly-documentation/java.js b/lib/handlers/assembly-documentation/java.js
new file mode 100644
index 000000000..5578eecff
--- /dev/null
+++ b/lib/handlers/assembly-documentation/java.js
@@ -0,0 +1,32 @@
+// Copyright (c) 2021, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+//     * 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.
+//
+// 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 HOLDER 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.
+
+import { getAsmOpcode } from '../asm-docs-java';
+import { BaseAssemblyDocumentationHandler } from '../base-assembly-documentation-handler';
+
+export class JavaDocumentationHandler extends BaseAssemblyDocumentationHandler {
+    getInstructionInformation(instruction) {
+        return getAsmOpcode(instruction) || null;
+    }
+}
diff --git a/lib/handlers/assembly-documentation/mos6502.js b/lib/handlers/assembly-documentation/mos6502.js
new file mode 100644
index 000000000..79293b487
--- /dev/null
+++ b/lib/handlers/assembly-documentation/mos6502.js
@@ -0,0 +1,8 @@
+import { getAsmOpcode } from '../asm-docs-6502';
+import { BaseAssemblyDocumentationHandler } from '../base-assembly-documentation-handler';
+
+export class Mos6502DocumentationHandler extends BaseAssemblyDocumentationHandler {
+    getInstructionInformation(instruction) {
+        return getAsmOpcode(instruction) || null;
+    }
+}
diff --git a/lib/handlers/assembly-documentation/router.js b/lib/handlers/assembly-documentation/router.js
new file mode 100644
index 000000000..2d35d084f
--- /dev/null
+++ b/lib/handlers/assembly-documentation/router.js
@@ -0,0 +1,57 @@
+// Copyright (c) 2021, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+//     * 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.
+//
+// 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 HOLDER 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.
+
+import { propsFor } from '../../properties';
+
+import { Amd64DocumentationHandler } from './amd64';
+import { Arm32DocumentationHandler } from './arm32';
+import { JavaDocumentationHandler } from './java';
+import { Mos6502DocumentationHandler } from './mos6502';
+
+/** @type {Record.<string, BaseAssemblyDocumentationHandler>} */
+const ASSEMBLY_DOCUMENTATION_HANDLERS = {
+    amd64: new Amd64DocumentationHandler(),
+    arm32: new Arm32DocumentationHandler(),
+    java: new JavaDocumentationHandler(),
+    6502: new Mos6502DocumentationHandler(),
+};
+
+const MAX_STATIC_AGE = propsFor('asm-docs')('staticMaxAgeSecs', 10);
+
+/**
+ * Initialize all Assembly Docs routes
+ *
+ * @param {e.Router} router
+ */
+export const setup = (router) => router.get('/asm/:arch/:opcode', (req, res) => {
+    if (MAX_STATIC_AGE > 0) {
+        res.setHeader('Cache-Control', `public, max-age=${MAX_STATIC_AGE}`);
+    }
+    const architecture = req.params.arch;
+    const handler = ASSEMBLY_DOCUMENTATION_HANDLERS[architecture];
+    if (handler !== undefined) {
+        return handler.handle(req, res);
+    }
+    res.status(404).json({ error: `No documentation for '${architecture}'` }).send();
+});