os-k/kaleid/kernel/sh/shcmds.c

//----------------------------------------------------------------------------//
//                           GNU GPL OS/K                                     //
//                                                                            //
//  Desc:       Kernel shell                                                  //
//                                                                            //
//                                                                            //
//  Copyright © 2018-2019 The OS/K Team                                       //
//                                                                            //
//  This file is part of OS/K.                                                //
//                                                                            //
//  OS/K is free software: you can redistribute it and/or modify              //
//  it under the terms of the GNU General Public License as published by      //
//  the Free Software Foundation, either version 3 of the License, or         //
//  any later version.                                                        //
//                                                                            //
//  OS/K 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 General Public License for more details.                              //
//                                                                            //
//  You should have received a copy of the GNU General Public License         //
//  along with OS/K.  If not, see <https://www.gnu.org/licenses/>.            //
//----------------------------------------------------------------------------//

#include "shell.h"

error_t CmdBeep(int argc, char **argv, char *cmdline)
{
    if (rand() % 64 == 0 || (argc > 1 && !strcmp(argv[1], "starwars"))) {
        IoDoStarWars();
    }

    else IoDoBeep();
    
    return EOK;
}

error_t CmdStarWars(int argc, char **argv, char *cmdline)
{
    IoDoStarWars();

    return EOK;
}

error_t CmdQuit(int argc, char **argv, char *cmdline)
{
    PoShutdown();
    return EOK;
}

error_t CmdHelp(int argc, char **argv, char *cmdline)
{
    uint i, count = 0;
    Command_t *cmd;

    if (argc == 1) {
        KernLog("List of all shell built-ins:\n");
        for (cmd = cmdtable; cmd->name != NULL; cmd++, count++) {
            KernLog("\t%s", cmd->name);
            for (i = strlen(cmd->name)/4; i<3; i++) {
                KernLog("\t");
            }
            KernLog("%s\n", cmd->help);
        }
        KernLog("End of list; %u commands total\n", count);
    }
    
    return EOK;
}

error_t CmdDate(int argc, char **argv, char *cmdline)
{
    IoPrintRtcTime();
    return EOK;
}

error_t CmdMemMap(int argc, char **argv, char *cmdline)
{
    MmPrintMemoryMap();
    return EOK;
}

error_t CmdMemUsage(int argc, char **argv, char *cmdline)
{
    char var;
    (void)var;

    size_t stack_cur;
    size_t img_diff, stack_diff;
    size_t heap_start, heap_end;
    size_t heap_diff, heap_max;

    ulong flags = KePauseIRQs();

    heap_start = (size_t)_heap_start;
    heap_end = (size_t)_heap_end;
    heap_max = _heap_max;
    
    KeRestoreIRQs(flags);
    
    img_diff = (size_t)BtLoaderInfo.kernelEndAddr
             - (size_t)BtLoaderInfo.kernelAddr;

    stack_diff = (size_t)BtLoaderInfo.stackEndAddr
             - ((size_t)BtLoaderInfo.kernelEndAddr + 16);

    heap_diff = (size_t)heap_end - (size_t)heap_start;
    
    stack_cur = (size_t)BtLoaderInfo.stackEndAddr - (size_t)&var;

    KernLog("Kernel image\n");

    KernLog("\tstarts at:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                BtLoaderInfo.kernelAddr,
                _ADDR_TO_MB((size_t)BtLoaderInfo.kernelAddr),
                _ADDR_TO_KB((size_t)BtLoaderInfo.kernelAddr),
                _ADDR_TO_B((size_t)BtLoaderInfo.kernelAddr));

    KernLog("\tends at:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                (size_t)BtLoaderInfo.kernelEndAddr,
                _ADDR_TO_MB((size_t)BtLoaderInfo.kernelEndAddr),
                _ADDR_TO_KB((size_t)BtLoaderInfo.kernelEndAddr),
                _ADDR_TO_B((size_t)BtLoaderInfo.kernelEndAddr));

    KernLog("\tsize:\t\t\t%4luMB + %4luKB + %4luB (%p)\n",
                _ADDR_TO_MB(img_diff),
                _ADDR_TO_KB(img_diff),
                _ADDR_TO_B(img_diff),
                img_diff);

    KernLog("Kernel stack\n");

    KernLog("\tstarts at:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                BtLoaderInfo.kernelEndAddr,
                _ADDR_TO_MB((size_t)BtLoaderInfo.stackEndAddr),
                _ADDR_TO_KB((size_t)BtLoaderInfo.stackEndAddr),
                _ADDR_TO_B((size_t)BtLoaderInfo.stackEndAddr));
    
    KernLog("\tcurrently at:\t%p (%4luMB + %4luKB + %4luB)\n",
                (size_t)&var,
                _ADDR_TO_MB((size_t)&var),
                _ADDR_TO_KB((size_t)&var),
                _ADDR_TO_B((size_t)&var));

    KernLog("\tmin address:\t%p (%4luMB + %4luKB + %4luB)\n",
                (size_t)BtLoaderInfo.kernelEndAddr+16,
                _ADDR_TO_MB((size_t)BtLoaderInfo.kernelEndAddr+16),
                _ADDR_TO_KB((size_t)BtLoaderInfo.kernelEndAddr+16),
                _ADDR_TO_B((size_t)BtLoaderInfo.kernelEndAddr+16));

    KernLog("\tsize (cur):\t\t%4luMB + %4luKB + %4luB (%p)\n",
                _ADDR_TO_MB(stack_cur),
                _ADDR_TO_KB(stack_cur),
                _ADDR_TO_B(stack_cur),
                stack_cur);

    KernLog("\tsize (max):\t\t%4luMB + %4luKB + %4luB (%p)\n",
                _ADDR_TO_MB(stack_diff),
                _ADDR_TO_KB(stack_diff),
                _ADDR_TO_B(stack_diff),
                stack_diff);

    KernLog("Kernel heap\n");

    KernLog("\tstarts at:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                heap_start, _ADDR_TO_MB(heap_start),
                _ADDR_TO_KB(heap_start),
                _ADDR_TO_B(heap_start));

    KernLog("\tends at:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                heap_end, _ADDR_TO_MB(heap_end),
                _ADDR_TO_KB(heap_end),
                _ADDR_TO_B(heap_end));

    KernLog("\tmax addr:\t\t%p (%4luMB + %4luKB + %4luB)\n",
                heap_start + heap_max,
                _ADDR_TO_MB(heap_start + heap_max),
                _ADDR_TO_KB(heap_start + heap_max),
                _ADDR_TO_B(heap_start + heap_max));

    KernLog("\tsize (cur):\t\t%4luMB + %4luKB + %4luB (%p)\n",
                _ADDR_TO_MB(heap_diff),
                _ADDR_TO_KB(heap_diff),
                _ADDR_TO_B(heap_diff),
                heap_diff);

    KernLog("\tsize (max):\t\t%4luMB + %4luKB + %4luB (%p)\n",
                _ADDR_TO_MB(heap_max),
                _ADDR_TO_KB(heap_max),
                _ADDR_TO_B(heap_max),
                heap_max);

    return EOK;
}

extern void pstest(void);

error_t CmdPsTest(int argc, char **argv, char *cmdline)
{
    pstest();
    return EOK;
}

error_t CmdDie(int argc, char **argv, char *cmdline)
{
    *(char *)NULL += 1;
    return EOK;
}

error_t CmdPF(int argc, char **argv, char *cmdline)
{
    *((char*)0xDEADBEEF0) = 1;
    return EOK;
}

error_t CmdShell(int argc, char **argv, char *cmdline)
{
    extern void KeStartShell(void);
    KeStartShell();
    return EOK;
}

//----------------------------------------------------------------------------//

Command_t cmdtable[] =
{
    { "beep", CmdBeep, "Make a beep" },
    { "date", CmdDate, "Print date" },
    { "die", CmdDie, "Die painfully" },
    { "exit", CmdQuit, "Initiate shutdown" },
    { "help", CmdHelp, "Show this message" },
    { "march", CmdStarWars, "Play the Imperial March"},
    { "mmap", CmdMemMap, "Show memory map" },
    { "musage", CmdMemUsage, "Show memory statistics" },
    { "pfault", CmdPF, "Provokes a PF" },
    { "pstest", CmdPsTest, "Scheduler test routine" },
    { "shell", CmdShell, "New shell instance" },
    { "quit", CmdQuit, "Alias for 'exit'" },
    { NULL, NULL, NULL }
};