Merge pull request #663 from iranl/stack-trace

Stack trace on GH pages

.github/workflows/beta.yml

@@ -116,6 +116,7 @@ jobs:
           mkdir -p resources/
           mkdir -p src/
           cp -vf release/*/nuki_hub_*.bin ota/beta/
+          cp -vf release/*/nuki_hub_*.elf ota/beta/
           cp -vf master/resources/ota_manifest.py resources/ota_manifest.py
           cp -vf master/src/Config.h src/Config.h
           python3 resources/ota_manifest.py beta $Version

.github/workflows/nightly.yml

@@ -139,6 +139,7 @@ jobs:
           mkdir -p resources/
           mkdir -p src/
           cp -vf release/*/nuki_hub_*.bin ota/master/
+          cp -vf release/*/nuki_hub_*.elf ota/master/          
           cp -vf master/resources/ota_manifest.py resources/ota_manifest.py
           cp -vf master/src/Config.h src/Config.h
           python3 resources/ota_manifest.py master $Version

.github/workflows/release.yml

@@ -129,7 +129,7 @@ jobs:
 
             cd ../..
           done
-          
+
           # remove last character
           ARTIFACTS="${ARTIFACTS%?}"
           echo "artifacts=${ARTIFACTS}" | tee -a ${GITHUB_OUTPUT}
@@ -156,13 +156,15 @@ jobs:
           mkdir -p ota/master/
           mkdir -p resources/
           mkdir -p src/
-          cp -vf release/*/nuki_hub_*.bin ota/          
+          cp -vf release/*/nuki_hub_*.bin ota/
+          cp -vf release/*/nuki_hub_*.elf ota/
           cp -vf master/resources/ota_manifest.py resources/ota_manifest.py
           cp -vf master/src/Config.h src/Config.h
           python3 resources/ota_manifest.py release $Version
           python3 resources/ota_manifest.py beta none
           find * -not -path "ota*" -delete
           rm -rf ota/beta/*.bin
+          rm -rf ota/beta/*.elf
           rm -rf .github .gitignore .gitmodules
           touch ota/beta/empty
           touch ota/master/empty
@@ -189,7 +191,7 @@ jobs:
           ref: master
       - name: Set new version
         run: |
-          python3 resources/next_version.py      
+          python3 resources/next_version.py
       - name: Commit config to master
         uses: stefanzweifel/git-auto-commit-action@v5
         with:

stacktrace/esp_exception_decoder_rs.js

@@ -0,0 +1,302 @@
+
+let wasm;
+
+const heap = new Array(32).fill(undefined);
+
+heap.push(undefined, null, true, false);
+
+function getObject(idx) { return heap[idx]; }
+
+let heap_next = heap.length;
+
+function dropObject(idx) {
+    if (idx < 36) return;
+    heap[idx] = heap_next;
+    heap_next = idx;
+}
+
+function takeObject(idx) {
+    const ret = getObject(idx);
+    dropObject(idx);
+    return ret;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+let cachegetUint8Memory0 = null;
+function getUint8Memory0() {
+    if (cachegetUint8Memory0 === null || cachegetUint8Memory0.buffer !== wasm.memory.buffer) {
+        cachegetUint8Memory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachegetUint8Memory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    return cachedTextDecoder.decode(getUint8Memory0().subarray(ptr, ptr + len));
+}
+
+let cachegetInt32Memory0 = null;
+function getInt32Memory0() {
+    if (cachegetInt32Memory0 === null || cachegetInt32Memory0.buffer !== wasm.memory.buffer) {
+        cachegetInt32Memory0 = new Int32Array(wasm.memory.buffer);
+    }
+    return cachegetInt32Memory0;
+}
+
+const u32CvtShim = new Uint32Array(2);
+
+const uint64CvtShim = new BigUint64Array(u32CvtShim.buffer);
+
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let cachedTextEncoder = new TextEncoder('utf-8');
+
+const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
+    ? function (arg, view) {
+    return cachedTextEncoder.encodeInto(arg, view);
+}
+    : function (arg, view) {
+    const buf = cachedTextEncoder.encode(arg);
+    view.set(buf);
+    return {
+        read: arg.length,
+        written: buf.length
+    };
+});
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length);
+        getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len);
+
+    const mem = getUint8Memory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3);
+        const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
+        const ret = encodeString(arg, view);
+
+        offset += ret.written;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1);
+    getUint8Memory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+/**
+* @param {Uint8Array} bin
+* @param {string} dump
+* @returns {Array<any>}
+*/
+export function decode(bin, dump) {
+    var ptr0 = passArray8ToWasm0(bin, wasm.__wbindgen_malloc);
+    var len0 = WASM_VECTOR_LEN;
+    var ptr1 = passStringToWasm0(dump, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    var len1 = WASM_VECTOR_LEN;
+    var ret = wasm.decode(ptr0, len0, ptr1, len1);
+    return takeObject(ret);
+}
+
+/**
+*/
+export class DecodedAddress {
+
+    static __wrap(ptr) {
+        const obj = Object.create(DecodedAddress.prototype);
+        obj.ptr = ptr;
+
+        return obj;
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.ptr;
+        this.ptr = 0;
+
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_decodedaddress_free(ptr);
+    }
+    /**
+    */
+    get address() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.__wbg_get_decodedaddress_address(retptr, this.ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            u32CvtShim[0] = r0;
+            u32CvtShim[1] = r1;
+            const n0 = uint64CvtShim[0];
+            return n0;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * @param {BigInt} arg0
+    */
+    set address(arg0) {
+        uint64CvtShim[0] = arg0;
+        const low0 = u32CvtShim[0];
+        const high0 = u32CvtShim[1];
+        wasm.__wbg_set_decodedaddress_address(this.ptr, low0, high0);
+    }
+    /**
+    * @returns {string}
+    */
+    get function_name() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.decodedaddress_function_name(retptr, this.ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(r0, r1);
+        }
+    }
+    /**
+    * @param {string} function_name
+    */
+    set function_name(function_name) {
+        var ptr0 = passStringToWasm0(function_name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        wasm.decodedaddress_set_function_name(this.ptr, ptr0, len0);
+    }
+    /**
+    * @returns {string}
+    */
+    get location() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.decodedaddress_location(retptr, this.ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(r0, r1);
+        }
+    }
+    /**
+    * @param {string} location
+    */
+    set location(location) {
+        var ptr0 = passStringToWasm0(location, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        wasm.decodedaddress_set_location(this.ptr, ptr0, len0);
+    }
+}
+
+async function load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+
+            } catch (e) {
+                if (module.headers.get('Content-Type') != 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else {
+                    throw e;
+                }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+
+        } else {
+            return instance;
+        }
+    }
+}
+
+async function init(input) {
+    if (typeof input === 'undefined') {
+        input = new URL('esp_exception_decoder_rs_bg.wasm', import.meta.url);
+    }
+    const imports = {};
+    imports.wbg = {};
+    imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
+        takeObject(arg0);
+    };
+    imports.wbg.__wbg_decodedaddress_new = function(arg0) {
+        var ret = DecodedAddress.__wrap(arg0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_new_949bbc1147195c4e = function() {
+        var ret = new Array();
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_push_284486ca27c6aa8b = function(arg0, arg1) {
+        var ret = getObject(arg0).push(getObject(arg1));
+        return ret;
+    };
+    imports.wbg.__wbindgen_throw = function(arg0, arg1) {
+        throw new Error(getStringFromWasm0(arg0, arg1));
+    };
+
+    if (typeof input === 'string' || (typeof Request === 'function' && input instanceof Request) || (typeof URL === 'function' && input instanceof URL)) {
+        input = fetch(input);
+    }
+
+
+
+    const { instance, module } = await load(await input, imports);
+
+    wasm = instance.exports;
+    init.__wbindgen_wasm_module = module;
+
+    return wasm;
+}
+
+export default init;
+

stacktrace/index.html

@@ -0,0 +1,181 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <meta charset="utf-8">
+    <title>NukiHub Stack trace decoder</title>
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@picocss/pico@1.3.3/css/pico.min-dist.css">
+    <style>
+      hgroup {
+        margin: var(--typography-spacing-vertical) 0;
+      }
+      main {
+        margin-top: 0;
+      }
+      h3 {
+        font-size: 1.4rem;
+        --typography-spacing-vertical: 1rem;
+        display: inline-block;
+      }
+      input {
+        display: inline-block !important;
+        width: auto !important;
+      }
+      body>footer, body>header, body>main {
+        padding: 0 var(--spacing);
+      }
+      section {
+        margin-bottom: 0;
+      }
+      textarea {
+        padding: 5px;
+        font-size: 0.75rem;
+        font-family: monospace;
+      }
+      textarea[disabled] {
+        cursor: default;
+        --background-color: var(--form-element-background-color);
+        --border-color: var(--form-element-border-color);
+        opacity: var(--form-element-opacity);
+      }
+      ul {
+        padding-left: 0;
+      }
+      ul li {
+        list-style: none;
+        word-break: break-all;
+        font-size: 0.7rem;
+        margin-bottom: 0;
+      }
+    </style>
+    <script>
+        window.addEventListener("load", function(event) {
+            const selectEl = document.querySelector("#elffile");
+
+            fetch("https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/dummy.bin").then(function(response) {
+                if (!response.ok) {
+                    throw new Error("Not 2xx response", {cause: response});
+                }
+                else {
+                    for (let i = 0; i < selectEl.options.length; i++) {
+                        const text = selectEl.options[i].value;
+                        if (text == '') {
+                            selectEl.remove(i);
+                            i--;
+                        }
+                    }
+                }
+            }).catch(function(err) {
+                for (let i = 0; i < selectEl.options.length; i++) {
+                    const text = selectEl.options[i].value;
+                    if (text.includes('/beta/')) {
+                        selectEl.remove(i);
+                        i--;
+                    }
+                }
+            });
+        },{ once: true });
+    </script>
+  </head>
+
+  <body>
+    <header>
+      <hgroup>
+        <h1>NukiHub Stack Trace Decoder</h1>
+      </hgroup>
+    </header>
+    <main>
+      <section>
+        <h3>Binary:</h3>
+        <select id="elffile">
+            <optgroup label="Release version">
+            <option label="NukiHub ESP32" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32.elf"></option>
+            <option label="NukiHub ESP32-C3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32c3.elf"></option>
+            <option label="NukiHub ESP32-C6" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32c6.elf"></option>
+            <option label="NukiHub ESP32-S3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32s3.elf"></option>
+            <option label="NukiHub ESP32-S3 OCTAL PSRAM" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32s3oct.elf"></option>
+            <option label="NukiHub ESP32-P4" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32p4.elf"></option>
+            <option label="NukiHub ESP32-SOLO1" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32solo1.elf"></option>
+            <option label="NukiHub GL-S10" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/nuki_hub_esp32gls10.elf"></option>
+            </optgroup>
+            <optgroup label="Beta version">
+            <option class="beta" label="NukiHub ESP32" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32.elf"></option>
+            <option class="beta" label="NukiHub ESP32-C3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32c3.elf"></option>
+            <option class="beta" label="NukiHub ESP32-C6" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32c6.elf"></option>
+            <option class="beta" label="NukiHub ESP32-S3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32s3.elf"></option>
+            <option class="beta" label="NukiHub ESP32-S3 OCTAL PSRAM" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32s3oct.elf"></option>
+            <option class="beta" label="NukiHub ESP32-P4" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32p4.elf"></option>
+            <option class="beta" label="NukiHub ESP32-SOLO1" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32solo1.elf"></option>
+            <option class="beta" label="NukiHub GL-S10" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/beta/nuki_hub_esp32gls10.elf"></option>
+            <option class="beta" label="No Beta available" disabled value=""></option>
+            </optgroup>
+            <optgroup label="Development version">
+            <option label="NukiHub ESP32" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32.elf"></option>
+            <option label="NukiHub ESP32-C3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32c3.elf"></option>
+            <option label="NukiHub ESP32-C6" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32c6.elf"></option>
+            <option label="NukiHub ESP32-S3" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32s3.elf"></option>
+            <option label="NukiHub ESP32-S3 OCTAL PSRAM" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32s3oct.elf"></option>
+            <option label="NukiHub ESP32-P4" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32p4.elf"></option>
+            <option label="NukiHub ESP32-SOLO1" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32solo1.elf"></option>
+            <option label="NukiHub GL-S10" value="https://raw.githubusercontent.com/technyon/nuki_hub/binary/ota/master/nuki_hub_esp32gls10.elf"></option>
+            </optgroup>
+        </select>
+      </section>
+      <section>
+        <h3>Stack trace:</h3>
+        <textarea id="stacktrace" width="100%" rows="10"></textarea>
+        <button aria-busy="true" id="run-button" disabled>Loading...</button>
+      </section>
+      <section id="output" hidden>
+        <h3>Output:</h3>
+        <ul id="decoded-list"></ul>
+      </section>
+    </main>
+
+    <script type="module">
+      // Load the WASM lib
+      import init, {decode as esp_exception_decode} from "./esp_exception_decoder_rs.js";
+
+      // Get some references to the DOM
+      const stacktrace = document.querySelector('#stacktrace');
+      const elffile = document.querySelector('#elffile');
+      const run_button = document.querySelector('#run-button');
+
+      const section_output = document.querySelector('#output');
+      const decoded_list = document.querySelector('#decoded-list');
+
+      (async function run() {
+        await init();
+
+        // Update the button state
+        run_button.textContent = 'Run!';
+        run_button.removeAttribute('disabled');
+        run_button.setAttribute('aria-busy', 'disabled');
+
+        const req = new XMLHttpRequest();
+        req.responseType = "arraybuffer";
+        req.onload = (event) => {
+          const arrayBuffer = req.response; // Note: not req.responseText
+          if (arrayBuffer) {
+            const elf_bytes = new Uint8Array(arrayBuffer);
+            const decoded_addresses = esp_exception_decode(elf_bytes, stacktrace.value);
+            // Unhide and update the decoded text area with the result from decode call
+            section_output.removeAttribute('hidden');
+            decoded_list.textContent = '';
+            decoded_addresses.forEach((e) => {
+              const entry_elm = document.createElement('li');
+              entry_elm.innerHTML = `0x${e.address.toString(16)}: <strong>${e.function_name}</strong> at <mark>${e.location}</mark>`;
+              decoded_list.appendChild(entry_elm);
+            });
+          }
+        };
+
+        // Setup the click event
+        run_button.addEventListener('click', (e) => {
+          req.open("GET", elffile.value, true);
+          req.send(null);
+        });
+      })();
+    </script>
+  </body>
+</html>