esp8266/cores/esp8266/StackThunk.cpp

/*
  StackThunk.c - Allow use second stack for BearSSL calls

  BearSSL uses a significant amount of stack space, much larger than
  the default Arduino core stack. These routines handle swapping
  between a secondary, user-allocated stack on the heap and the real
  stack.

  Copyright (c) 2017 Earle F. Philhower, III. All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  Modified 8 May 2015 by Hristo Gochkov (proper post and file upload handling)
*/

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>

#include "debug.h"
#include "StackThunk.h"

#include <pgmspace.h>
#include <ets_sys.h>

#include <umm_malloc/umm_malloc.h>
#include <umm_malloc/umm_heap_select.h>

extern "C" {

extern void optimistic_yield(uint32_t);

uint32_t *stack_thunk_ptr = NULL;
uint32_t *stack_thunk_top = NULL;

uint32_t *stack_thunk_save = NULL;  /* Saved A1 while in BearSSL */
uint32_t *stack_thunk_yield_save = NULL;  /* Saved A1 when yielding from within BearSSL */

uint32_t stack_thunk_refcnt = 0;

/* Largest stack usage seen in the wild at  6120 */
#define _stackSize (6200/4)
#define _stackPaint 0xdeadbeef

/* Add a reference, and allocate the stack if necessary */
void stack_thunk_add_ref()
{
  stack_thunk_refcnt++;
  if (stack_thunk_refcnt == 1) {
    DBG_MMU_PRINTF("\nStackThunk malloc(%u)\n", _stackSize * sizeof(uint32_t));
    // The stack must be in DRAM, or an Soft WDT will follow. Not sure why,
    // maybe too much time is consumed with the non32-bit exception handler.
    // Also, interrupt handling on an IRAM stack would be very slow.
    // Strings on the stack would be very slow to access as well.
    HeapSelectDram ephemeral;
    stack_thunk_ptr = (uint32_t *)malloc(_stackSize * sizeof(uint32_t));
    DBG_MMU_PRINTF("StackThunk stack_thunk_ptr: %p\n", stack_thunk_ptr);
    if (!stack_thunk_ptr) {
        // This is a fatal error, stop the sketch
        DEBUGV("Unable to allocate BearSSL stack\n");
        abort();
    }
    stack_thunk_top = stack_thunk_ptr + _stackSize - 1;
    stack_thunk_save = NULL;
    stack_thunk_yield_save = NULL;
    stack_thunk_repaint();
  }
}

/* Drop a reference, and free stack if no more in use */
void stack_thunk_del_ref()
{
  if (stack_thunk_refcnt == 0) {
    /* Error! */
    return;
  }
  stack_thunk_refcnt--;
  if (!stack_thunk_refcnt) {
    free(stack_thunk_ptr);
    stack_thunk_ptr = NULL;
    stack_thunk_top = NULL;
    stack_thunk_save = NULL;
    stack_thunk_yield_save = NULL;
  }
}

void stack_thunk_repaint()
{
  for (int i=0; i < _stackSize; i++) {
    stack_thunk_ptr[i] = _stackPaint;
  }
}

/* Simple accessor functions used by postmortem */
uint32_t stack_thunk_get_refcnt() {
  return stack_thunk_refcnt;
}

uint32_t stack_thunk_get_stack_top() {
  return (uint32_t)stack_thunk_top;
}

uint32_t stack_thunk_get_stack_bot() {
  return (uint32_t)stack_thunk_ptr;
}

uint32_t stack_thunk_get_cont_sp() {
  return (uint32_t)stack_thunk_save;
}

/* Return the number of bytes ever used since the stack was created */
uint32_t stack_thunk_get_max_usage()
{
  uint32_t cnt = 0;

  /* No stack == no usage by definition! */
  if (!stack_thunk_ptr) {
    return 0;
  }

  for (cnt=0; (cnt < _stackSize) && (stack_thunk_ptr[cnt] == _stackPaint); cnt++) {
    /* Noop, all work done in for() */
  }
  return 4 * (_stackSize - cnt);
}

/* Print the stack from the first used 16-byte chunk to the top, decodable by the exception decoder */
void stack_thunk_dump_stack()
{
  uint32_t *pos = stack_thunk_ptr;
  while (pos < stack_thunk_top) {
    if ((pos[0] != _stackPaint) || (pos[1] != _stackPaint) || (pos[2] != _stackPaint) || (pos[3] != _stackPaint))
      break;
    pos += 4;
  }
  ets_printf(">>>stack>>>\n");
  while (pos < stack_thunk_top) {
    ets_printf("%08x:  %08x %08x %08x %08x\n", (int32_t)pos, pos[0], pos[1], pos[2], pos[3]);
    pos += 4;
  }
  ets_printf("<<<stack<<<\n");
}

/* Called when the stack overflow is detected by a thunk.  Main memory is corrupted at this point.
 * Do not return, use libssp-compatible function to notify postmortem and immediately reboot. */
void stack_thunk_fatal_smashing()
{
    ets_printf("FATAL ERROR: BSSL stack smashing detected\n");
    __stack_chk_fail();
}

/* Called within bearssl code instead of optimistic_yield(...) */
void stack_thunk_yield();
asm(
    ".section     .text.stack_thunk_yield,\"ax\",@progbits\n\t"
    ".literal_position\n\t"
    ".align       4\n\t"
    ".global      stack_thunk_yield\n\t"
    ".type        stack_thunk_yield, @function\n\t"
    "\n"
"stack_thunk_yield:\n\t"
/* Keep the original caller */
    "addi         a1, a1, -16\n\t"
    "s32i.n       a0, a1, 12\n\t"
/* Swap bearssl <-> cont stacks */
    "movi         a2, stack_thunk_yield_save\n\t"
    "s32i.n       a1, a2, 0\n\t"
    "movi         a2, stack_thunk_save\n\t"
/* But, only when inside of bssl stack (saved a1 != 0) */
    "l32i.n       a3, a2, 0\n\t"
    "beqz         a3, stack_thunk_yield_do_yield\n\t"
    "l32i.n       a1, a2, 0\n\t"
/* optimistic_yield(10000) without extra l32r */
"stack_thunk_yield_do_yield:\n\t"
    "movi         a2, 0x10\n\t"
    "addmi        a2, a2, 0x2700\n\t"
    "call0        optimistic_yield\n\t"
/* Swap bearssl <-> cont stacks, again */
    "movi         a2, stack_thunk_yield_save\n\t"
    "l32i.n       a1, a2, 0\n\t"
/* Restore caller */
    "l32i.n       a0, a1, 12\n\t"
    "addi         a1, a1, 16\n\t"
    "ret.n\n\t"
    ".size stack_thunk_yield, .-stack_thunk_yield\n\t"
);

}