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)
{
    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 CmdClear(int argc, char **argv, char *cmdline)
{
    BLockBuf(BStdOut);
    
    BStdOut->wp = BStdOut->rp = BStdOut->buf;
    BStdOut->lastLF = 0;
    
    BUnlockBuf(BStdOut);
        
    return EOK;
}

error_t CmdDate(int argc, char **argv, char *cmdline)
{
    KernLog("%.10s\n", KeFormatCurTime());
    return EOK;
}

error_t CmdTime(int argc, char **argv, char *cmdline)
{
    KernLog("%s\n", &KeFormatCurTime()[13]);
    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.stackEndAddr,
                _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)
{
    /* if (argc != 2) */
    /*     return EINVAL; */

    /* ulong address = atoul(argv[1]); */
    /* KernLog("print: %s, %d\n", argv[1], address); */

    /* *((char*)address) += 1; */

    for (int i = 0; i < 32; i++) {
        KernLog("%dGB ", i);
        *((char*)(i*GB)) = 1;
    }

    return EOK;
}

error_t CmdArgs(int argc, char **argv, char *cmdline)
{
    int i;

    KernLog("cmdline: '%s'\nargc: %d\n", cmdline, argc);

    for (i = 0; i < argc; i++) {
        KernLog("argv[%d]: '%s'\n", i, argv[i]);
    }
    
    return EOK;
}

error_t CmdColor(int argc, char **argv, char *cmdline)
{
    int col = 0;
    char *p;
    
    if (argc > 2) {
        KernLog("Usage: 'color [#|list]'\n");
        return EINVAL;
    }
    
    if (argc == 1) {
        KernLog("Current color: %s (%d)\n", RtlColorNames[shcol], shcol);
    }

    else if (!strcmp(argv[1], "list")) {
        KernLog("Available colors:\n");
        for (col = 0; col <= VGA_COLOR_WHITE; col++) {
            KernLog("%d - %s\n", col, RtlColorNames[col]);
        }
    }
    
    else {
        p = argv[1];

        while (isdigit(*p) && col < VGA_COLOR_WHITE) {
            col = 10 * col + *p++ - '0';
        }

        if (*p || col < VGA_COLOR_BLACK || col > VGA_COLOR_WHITE) {
            KernLog("Invalid color: %d\n", col);
            KernLog("Usage: 'color [#|list]'\n");
            return EINVAL;
        }

        else {
            shcol = col;
        }
        
    }
    return EOK;
}

void MmInitPaging(void);

error_t CmdReloadPage(int argc, char **argv, char *cmdline)
{
    MmInitPaging();
    return EOK;
}

extern void KeStartShell(void);

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

error_t CmdStackOverflow(int argc, char **argv, char *cmdline)
{    
    CmdStackOverflow(0, 0, 0);
    return EOK;
}

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

Command_t cmdtable[] =
{
    { "args",       CmdArgs,            "Print command line" },
    { "beep",       CmdBeep,            "Make a beep" },
    { "cls",        CmdClear,           "Clears standard output" },
    { "color",      CmdColor,           "Change shell text color" },
    { "date",       CmdDate,            "Print date" },
    { "die",        CmdDie,             "Die painfully" },
    { "exit",       CmdQuit,            "Initiate shutdown" },
    { "help",       CmdHelp,            "Show this message" },
    { "rpag",       CmdReloadPage,      "Reload the pages directory" },
    { "march",      CmdStarWars,        "Play the Imperial March"},
    { "mmap",       CmdMemMap,          "Show memory map" },
    { "musage",     CmdMemUsage,        "Show memory statistics" },
    { "pfault",     CmdPF,              "Provoke a PF. Usage : pfault <address>" },
    { "pstest",     CmdPsTest,          "Scheduler test routine" },
    { "quit",       CmdQuit,            "Alias for 'exit'" },
    { "shell",      CmdShell,           "Start a new shell (nested)", },
    { "stkov",      CmdStackOverflow,   "Provoke a stack overflow" },
    { "time",       CmdTime,            "Print time" },
    { NULL, NULL, NULL }
};