Backtrace.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef BACKTRACE_H
#define BACKTRACE_H

#include "pedigree/kernel/processor/state.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/StaticString.h"

#define MAX_STACK_FRAMES 12

class Backtrace
{
    friend class AllocationCommand;
    friend class LocksCommand;
    friend class SlamAllocator;

  public:
    Backtrace();
    ~Backtrace();

    void performBacktrace(InterruptState &state);

    size_t numStackFrames();

    uintptr_t getReturnAddress(size_t n);

    uintptr_t getBasePointer(size_t n);

    void prettyPrint(
        HugeStaticString &buf, size_t nFrames = 0, size_t nFromFrame = 0);

  private:
    void performDwarfBacktrace(InterruptState &state);

  public:
    void performBpBacktrace(uintptr_t base, uintptr_t instruction);
#ifdef ARM_COMMON
    void performArmBacktrace(uintptr_t base, uintptr_t instruction);
#endif
  private:
    uintptr_t m_pReturnAddresses[MAX_STACK_FRAMES];
    uintptr_t m_pBasePointers[MAX_STACK_FRAMES];

    ProcessorState m_pStates[MAX_STACK_FRAMES];

    size_t m_nStackFrames;
};

#endif