AllocationCommand.cc

/*
 * 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.
 */

#include "pedigree/kernel/debugger/commands/AllocationCommand.h"
#include "pedigree/kernel/Log.h"
#include "pedigree/kernel/debugger/Backtrace.h"
#include "pedigree/kernel/debugger/DebuggerIO.h"
#include "pedigree/kernel/linker/KernelElf.h"
#include "pedigree/kernel/process/Process.h"
#include "pedigree/kernel/process/Thread.h"
#include "pedigree/kernel/processor/Processor.h"
#include "pedigree/kernel/processor/ProcessorInformation.h"
#include "pedigree/kernel/utilities/Iterator.h"
#include "pedigree/kernel/utilities/demangle.h"
#include "pedigree/kernel/utilities/utility.h"

AllocationCommand g_AllocationCommand;

AllocationCommand::AllocationCommand()
    : DebuggerCommand(), Scrollable(), m_Allocations(), m_Frees(), m_nLines(0),
      m_Tree(), m_It(), m_nIdx(0), m_bAllocating(false)
{
}

AllocationCommand::~AllocationCommand()
{
}

void AllocationCommand::autocomplete(
    const HugeStaticString &input, HugeStaticString &output)
{
}

bool AllocationCommand::execute(
    const HugeStaticString &input, HugeStaticString &output,
    InterruptState &state, DebuggerIO *pScreen)
{
    postProcess();

    // How many lines do we have?
    m_nLines = NUM_BT_FRAMES + 1;

    m_Tree.clear();

    // Perform preprocessing. Horrible O(n^2) algorithm.
    for (Vector<Allocation *>::Iterator it = m_Allocations.begin();
         it != m_Allocations.end(); it++)
    {
        Allocation *pA = *it;
        // Create a checksum of the backtrace.
        uintptr_t accum = 0;
        for (int i = 0; i < NUM_BT_FRAMES; i++)
            accum ^= pA->ra[i];

        // Along with process ID...
        accum += pA->pid << 16;

        // Lookup the checksum.
        Allocation *pOther = m_Tree.lookup(accum);
        if (pOther == 0)
        {
            pA->n = 1;
            m_Tree.insert(accum, pA);
        }
        else
        {
            pOther->n++;
        }
    }

    m_It = m_Tree.begin();
    m_nIdx = 0;

    // Let's enter 'raw' screen mode.
    pScreen->disableCli();

    // Initialise the Scrollable class
    move(0, 1);
    resize(pScreen->getWidth(), pScreen->getHeight() - 2);
    setScrollKeys('j', 'k');

    // Clear the top status lines.
    pScreen->drawHorizontalLine(
        ' ', 0, 0, pScreen->getWidth() - 1, DebuggerIO::White,
        DebuggerIO::Green);

    // Write the correct text in the upper status line.
    pScreen->drawString(
        "Pedigree debugger - Page allocation resolver", 0, 0, DebuggerIO::White,
        DebuggerIO::Green);

    // Clear the bottom status lines.
    // TODO: If we use arrow keys and page up/down keys we actually can remove
    // the status line
    //       because the interface is then intuitive enough imho.
    pScreen->drawHorizontalLine(
        ' ', pScreen->getHeight() - 1, 0, pScreen->getWidth() - 1,
        DebuggerIO::White, DebuggerIO::Green);

    // Write some helper text in the lower status line.
    // TODO FIXME: Drawing this might screw the top status bar
    pScreen->drawString(
        "backspace: Page up. space: Page down. q: Quit. enter: Next allocation",
        pScreen->getHeight() - 1, 0, DebuggerIO::White, DebuggerIO::Green);
    pScreen->drawString(
        "backspace", pScreen->getHeight() - 1, 0, DebuggerIO::Yellow,
        DebuggerIO::Green);
    pScreen->drawString(
        "space", pScreen->getHeight() - 1, 20, DebuggerIO::Yellow,
        DebuggerIO::Green);
    pScreen->drawString(
        "q", pScreen->getHeight() - 1, 38, DebuggerIO::Yellow,
        DebuggerIO::Green);
    pScreen->drawString(
        "enter", pScreen->getHeight() - 1, 47, DebuggerIO::Yellow,
        DebuggerIO::Green);

    // Main loop.
    bool bStop = false;
    bool bReturn = true;
    while (!bStop)
    {
        refresh(pScreen);

        // Wait for input.
        char c = 0;
        while (!(c = pScreen->getChar()))
            ;

        // TODO: Use arrow keys and page up/down someday
        if (c == 'j')
        {
            scroll(-1);
        }
        else if (c == 'k')
        {
            scroll(1);
        }
        else if (c == ' ')
        {
            scroll(static_cast<ssize_t>(height()));
        }
        else if (c == 0x08)
        {
            scroll(-static_cast<ssize_t>(height()));
        }
        else if (c == '\n' || c == '\r')
        {
            m_nIdx++;
            m_It++;
            if (m_It == m_Tree.end())
            {
                m_It = m_Tree.begin();
                m_nIdx = 0;
            }
        }
        else if (c == 'q')
            bStop = true;
    }

    // HACK:: Serial connections will fill the screen with the last background
    // colour used.
    //        Here we write a space with black background so the CLI screen
    //        doesn't get filled by some random colour!
    pScreen->drawString(" ", 1, 0, DebuggerIO::White, DebuggerIO::Black);
    pScreen->enableCli();
    return bReturn;
}

const char *AllocationCommand::getLine1(
    size_t index, DebuggerIO::Colour &colour, DebuggerIO::Colour &bgColour)
{
    static NormalStaticString Line;
    Line.clear();

    Allocation *pA = m_It.value();

    bgColour = DebuggerIO::Black;
    if (index == 0)
    {
        colour = DebuggerIO::Yellow;
        Line += pA->n;
        Line += " allocations from this source (";
        Line += m_nIdx;
        Line += "/";
        Line += m_Tree.count();
        Line += ") PID: ";
        Line += pA->pid;
        return Line;
    }
    index--;

    colour = DebuggerIO::White;
    uintptr_t symStart = 0;

    const char *pSym =
        KernelElf::instance().globalLookupSymbol(pA->ra[index], &symStart);
    if (pSym == 0)
    {
        Line.append(pA->ra[index], 16);
    }
    else
    {
        LargeStaticString sym(pSym);

        Line += "[";
        Line.append(symStart, 16);
        Line += "] ";
        static symbol_t symbol;
        demangle(sym, &symbol);
        Line += static_cast<const char *>(symbol.name);
    }

    return Line;
}
const char *AllocationCommand::getLine2(
    size_t index, size_t &colOffset, DebuggerIO::Colour &colour,
    DebuggerIO::Colour &bgColour)
{
    static LargeStaticString Line;
    Line.clear();

    return Line;
}

size_t AllocationCommand::getLineCount()
{
    return m_nLines;
}

void AllocationCommand::allocatePage(physical_uintptr_t page)
{
    // Get a backtrace.
    Backtrace bt;
    bt.performBpBacktrace(0, 0);

    Allocation *pA = new Allocation;
    pA->page = page;
    MemoryCopy(
        &pA->ra, bt.m_pReturnAddresses, NUM_BT_FRAMES * sizeof(uintptr_t));

#ifdef THREADS
    Process *pP = Processor::information().getCurrentThread()->getParent();
    if (pP)
        pA->pid = pP->getId();
    else
#endif
        pA->pid = -1;

    m_Allocations.pushBack(pA);
}

void AllocationCommand::freePage(physical_uintptr_t page)
{
    m_Frees.pushBack(reinterpret_cast<void *>(page));
}

void AllocationCommand::postProcess()
{
    NOTICE("Beginning free-list post processing...");
    for (Vector<void *>::Iterator it = m_Frees.begin(); it != m_Frees.end();
         it++)
    {
        physical_uintptr_t page = reinterpret_cast<physical_uintptr_t>(*it);

        // Look through the allocations vector for this address.
        for (Vector<Allocation *>::Iterator it2 = m_Allocations.begin();
             it2 != m_Allocations.end(); it2++)
        {
            if ((*it2)->page == page)
            {
                delete (*it2);
                m_Allocations.erase(it2);
                break;
            }
        }

        m_Frees.erase(it);
        it = m_Frees.begin();
    }
    NOTICE("End free-list post processing.");
}

void AllocationCommand::checkpoint()
{
    NOTICE("Allocation checkpoint.");
    // TODO delete().
    m_Allocations.clear();
    m_Frees.clear();
}