source: trunk/user/ksh/ksh.c @ 614

/////////////////////////////////////////////////////////////////////////////////////////
// File   :  ksh.c
// Date   :  October 2017
// Author :  Alain Greiner
/////////////////////////////////////////////////////////////////////////////////////////
// This application implements a minimal shell for ALMOS-MKH.
//
// This user KSH process contains two POSIX threads:
// - the "main" thread contains the infinite loop implementing
//   the children processes termination monitoring, using the wait() syscall.
// - the "interactive" thread contains the infinite loop implementing the command
//   interpreter attached to the TXT terminal, and handling one KSH command
//   per iteration. 
//
// The children processes are created by the <load> command, and are
// attached to the same TXT terminal as the KSH process itself.
// A child process can be lauched in foreground or in background: 
// . when the child process is running in foreground, the KSH process loses
//   the TXT terminal ownership, that is transfered to the child process.
// . when the child process is running in background: the KSH process keeps
//   the TXT terminal ownership.
//
// We use a semaphore to synchronize the two KSH threads. At each iteration, 
// the interactive thread check the semaphore (with a sem_wait). It blocks 
// and deschedules, if the KSH process loosed the TXT ownership (after a load,
// or for any other cause. It unblocks with the following policy:
// . if the command is "not a load", the semaphore is incremented by the 
//   cmd_***() function when the command is completed, to allow the KSH interactive()
//   function to get the next command in the while loop.    
// . if the command is a "load without &", the TXT is given to the NEW process by the
//   execve() syscall, and is released to the KSH process when NEW process terminates.
//   The KSH process is notified and the KSH main() function increments the semahore 
//   to allow the KSH interactive() function to handle commands.
// . if the command is a "load with &", the cmd_load() function returns the TXT 
//   to the KSH process and increment the semaphore, when the parent KSH process 
//   returns from the fork() syscall.
/////////////////////////////////////////////////////////////////////////////////////////

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/wait.h>
#include <signal.h>
#include <unistd.h>
#include <dirent.h>
#include <almosmkh.h>
#include <semaphore.h>
#include <hal_macros.h>
#include <sys/stat.h>
#include <sys/mman.h>
#include <fcntl.h>

#define CMD_MAX_SIZE   (256)    // max number of characters in one command
#define LOG_DEPTH      (32)     // max number of registered commands 
#define MAX_ARGS           (32)     // max number of arguments in a command

#define DEBUG_MAIN          0

#define DEBUG_CMD_CAT       0
#define DEBUG_CMD_CP        0
#define DEBUG_CMD_LOAD      0
#define DEBUG_CMD_LS        0

//////////////////////////////////////////////////////////////////////////////////////////
//         Structures
//////////////////////////////////////////////////////////////////////////////////////////

// one entry in the registered commands array
typedef struct log_entry_s 
{
        char          buf[CMD_MAX_SIZE];
        unsigned int  count;
}
log_entry_t;

// one entry in the supported command types array
typedef struct ksh_cmd_s 
{
        char * name;
        char * desc;
        void   (*fn)( int , char ** );
}
ksh_cmd_t;


//////////////////////////////////////////////////////////////////////////////////////////
//         Global Variables
//////////////////////////////////////////////////////////////////////////////////////////

ksh_cmd_t       cmd[];                    // array of supported commands

log_entry_t     log_entries[LOG_DEPTH];   // array of registered commands

unsigned int    ptw;                      // write pointer in log_entries[]
unsigned int    ptr;                      // read pointer in log_entries[]

pthread_attr_t  attr;                     // interactive thread attributes

sem_t           semaphore;                // block interactive thread when zero

//////////////////////////////////////////////////////////////////////////////////////////
//         Shell  Commands
//////////////////////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////
static void cmd_cat( int argc , char **argv )
{
        char         * path;
    struct stat    st;
    int            fd;
    int            size;
    char         * buf;

        if (argc != 2) 
    {
        fd   = -1;
        buf  = NULL;
        size = 0;
                printf("  usage: cat pathname\n");
            goto cmd_cat_exit;
    }

    path = argv[1];

    // open the file
    fd = open( path , O_RDONLY , 0 );
    if (fd < 0) 
    {
        buf  = NULL;
        size = 0;
            printf("  error: cannot open file <%s>\n", path);
            goto cmd_cat_exit;
    }

#if DEBUG_CMD_CAT
long long unsigned cycle;
get_cycle( &cycle );
printf("\n[%s] file %s open / cycle %d\n",
__FUNCTION__ , path , (int)cycle );
#endif

    // get file stats 
    if ( stat( path , &st ) == -1)
    {
        buf  = NULL;
        size = 0;
            printf("  error: cannot stat <%s>\n", path);
            goto cmd_cat_exit;
    }

        if ( S_ISDIR(st.st_mode) )
    {
        buf  = NULL;
        size = 0;
            printf("  error: <%s> is a directory\n", path);
            goto cmd_cat_exit;
    }

    // get file size
    size = st.st_size;

#if DEBUG_CMD_CAT
get_cycle( &cycle );
printf("\n[%s] get size %d / cycle %d\n",
__FUNCTION__ , size , (int)cycle );
#endif

    // MAP_FILE is default type when MAP_ANON and MAP_REMOTE are not specified
    buf = mmap( NULL , size , PROT_READ|PROT_WRITE , MAP_PRIVATE , fd , 0 );

    if ( buf == NULL )
    {
            printf("  error: cannot map file <%s>\n", path );
            goto cmd_cat_exit;
    }

#if DEBUG_CMD_CAT
get_cycle( &cycle );
printf("\n[%s] map file %d to buffer %x / cycle %d\n",
__FUNCTION__ , fd , buf , (int)cycle );
display_vmm( 0 , getpid() );
#endif

    // display the file content on TXT terminal
    write( 1 , buf , size );

    // release semaphore to get next command
    sem_post( &semaphore );

    return;

cmd_cat_exit:

        if (buf != NULL) munmap(buf, size);
        if (fd >= 0) close(fd);

    // release semaphore to get next command
    sem_post( &semaphore );

}   // end cmd_cat()

////////////////////////////////////////////
static void cmd_cd( int argc , char **argv )
{
        char * path;

        if (argc != 2)
    {
                printf("  usage: cd pathname\n");
        }
    else
    {
            path = argv[1];

        // call the relevant syscall
        if( chdir( path ) )
        {
            printf("  error: cannot found <%s> directory\n", path );
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}   // end cmd_cd()

/////////////////////////////////////////
static void cmd_cp(int argc, char **argv)
{
        int          src_fd;
    int          dst_fd;
        char       * srcpath;
    char       * dstpath;
        int          size;          // source file size
        int          bytes;         // number of transfered bytes
        char         buf[4096];
        struct stat  st;

        if (argc != 3) 
    {
        src_fd = -1;
        dst_fd = -1;
                printf("  usage: cp src_pathname dst_pathname\n");
        goto cmd_cp_exit;
        }

    srcpath = argv[1];
    dstpath = argv[2];

    // open the src file 
    src_fd = open( srcpath , O_RDONLY , 0 );

    if ( src_fd < 0 ) 
    {
        dst_fd = -1;
            printf("  error: cannot open <%s>\n", srcpath );
            goto cmd_cp_exit;
    }

#if DEBUG_CMD_CP
long long unsigned cycle;
get_cycle( &cycle );
printf("\n[%s] open file <%s> done / cycle %d\n",
__FUNCTION__ , srcpath , (int)cycle );
#endif

    // get file stats
    if ( stat( srcpath , &st ) )
    {
        dst_fd = -1;
            printf("  error: cannot stat <%s>\n", srcpath);
            goto cmd_cp_exit;
    }

#if DEBUG_CMD_CP
get_cycle( &cycle );
printf("\n[%s] stats file <%s> done / cycle %d\n",
__FUNCTION__ , srcpath , (int)cycle );
#endif

        if ( S_ISDIR(st.st_mode) )
    {
        dst_fd = -1;
                printf("  error: <%s> is a directory\n", srcpath);
                goto cmd_cp_exit;
        }

    // get src file size
        size = st.st_size;

        // open the dst file 
        dst_fd = open( dstpath , O_CREAT|O_TRUNC|O_RDWR , 0 );

        if ( dst_fd < 0 ) 
    {
                printf("  error: cannot open <%s>\n", dstpath );
                goto cmd_cp_exit;
        }

#if DEBUG_CMD_CP
get_cycle( &cycle );
printf("\n[%s] open file <%s> done / cycle %d\n",
__FUNCTION__ , dstpath , (int)cycle );
#endif

        if ( stat( dstpath , &st ) )
    {
                printf("  error: cannot stat <%s>\n", dstpath );
                goto cmd_cp_exit;
        }

#if DEBUG_CMD_CP
get_cycle( &cycle );
printf("\n[%s] stats file <%s> done / cycle %d\n",
__FUNCTION__ , dstpath , (int)cycle );
#endif

        if ( S_ISDIR(st.st_mode ) ) 
    {
                printf("  error: <%s> is a directory\n", dstpath );
                goto cmd_cp_exit;
        }

        bytes = 0;

        while (bytes < size)
        {
                int len = ((size - bytes) < 4096) ? (size - bytes) : 4096;

                // read the source 
                if ( read( src_fd , buf , len ) != len )
        {
                        printf("  error: cannot read from file <%s>\n", srcpath);
                        goto cmd_cp_exit;
                }

#if DEBUG_CMD_CP
get_cycle( &cycle );
printf("\n[%s] %d bytes read from <%s> / cycle %d\n",
__FUNCTION__ , len, srcpath , (int)cycle );
#endif

                // write to the destination 
                if ( write( dst_fd , buf , len ) != len )
        {
                        printf("  error: cannot write to file <%s>\n", dstpath);
                        goto cmd_cp_exit;
                }

#if DEBUG_CMD_CP
get_cycle( &cycle );
printf("\n[%s] %d bytes writen to <%s> / cycle %d\n",
__FUNCTION__ , len, dstpath , (int)cycle );
#endif

                bytes += len;
        }

cmd_cp_exit:

        if (src_fd >= 0) close(src_fd);
        if (dst_fd >= 0) close(dst_fd);

    // release semaphore to get next command
    sem_post( &semaphore );

}   // end cmd_cp()

/////////////////////////////////////////////////
static void cmd_display( int argc , char **argv )
{
    if( argc < 2 )
    {
        printf("  usage: display  vmm      cxy    pid\n"
               "         display  sched    cxy    lid\n"              
               "         display  process  cxy\n"              
               "         display  txt      txtid\n"              
               "         display  vfs\n"              
               "         display  chdev\n"              
               "         display  dqdt\n"              
               "         display  locks    pid    trdid\n"
               "         display  mapper   path   page_id  nbytes\n");
    }
    ////////////////////////////////////
    else if( strcmp( argv[1] , "vmm" ) == 0 )
    {
        if( argc != 4 )
        {
                    printf("  usage: display vmm cxy pid\n");
            }
        else
        {
                unsigned int cxy = atoi(argv[2]);
                unsigned int pid = atoi(argv[3]);

            if( display_vmm( cxy , pid ) )
            {
                printf("  error: no process %x in cluster %x\n", pid , cxy );
            }
        }
    }
    ///////////////////////////////////////////
    else if( strcmp( argv[1] , "sched" ) == 0 )
    {
        if( argc != 4 )
        {
                    printf("  usage: display sched cxy lid\n");
            }
        else
        {
                unsigned int cxy = atoi(argv[2]);
                unsigned int lid = atoi(argv[3]);

            if( display_sched( cxy , lid ) )
            {
                printf("  error: illegal arguments cxy = %x / lid = %d\n", cxy, lid );
            }
        }
    }
    /////////////////////////////////////////////
    else if( strcmp( argv[1] , "process" ) == 0 )
    {
        if( argc != 3 )
        {
                    printf("  usage: display process cxy\n");
            }
        else
        {
                unsigned int cxy = atoi(argv[2]);

            if( display_cluster_processes( cxy , 0 ) )
            {
                printf("  error: illegal argument cxy = %x\n", cxy );
            }
        }
    }
    /////////////////////////////////////////
    else if( strcmp( argv[1] , "txt" ) == 0 )
    {
        if( argc != 3 )
        {
                    printf("  usage: display txt txt_id\n");
            }
        else
        {
                unsigned int txtid = atoi(argv[2]);

            if( display_txt_processes( txtid ) )
            {
                printf("  error: illegal argument txtid = %d\n", txtid );
            }
        }
    }
    /////////////////////////////////////////
    else if( strcmp( argv[1] , "vfs" ) == 0 )
    {
        if( argc != 2 )
        {
                    printf("  usage: display vfs\n");
            }
        else
        {
            display_vfs();
        }
    }
    //////////////////////////////////////////
    else if( strcmp( argv[1] , "chdev" ) == 0 )
    {
        if( argc != 2 )
        {
                    printf("  usage: display chdev\n");
            }
        else
        {
            display_chdev();
        }
    }
    //////////////////////////////////////////
    else if( strcmp( argv[1] , "dqdt" ) == 0 )
    {
        if( argc != 2 )
        {
                    printf("  usage: display dqdt\n");
            }
        else
        {
            display_dqdt();
        }
    }
    ///////////////////////////////////////////
    else if( strcmp( argv[1] , "locks" ) == 0 )
    {
        if( argc != 4 )
        {
                    printf("  usage: display locks pid trdid\n");
            }
        else
        {
                unsigned int pid   = atoi(argv[2]);
            unsigned int trdid = atoi(argv[3]);

            if( display_busylocks( pid , trdid ) )
            {
                printf("  error: illegal arguments pid = %x / trdid = %x\n", pid, trdid );
            }
        }
    }
    ///////////////////////////////////////////
    else if( strcmp( argv[1] , "mapper" ) == 0 )
    {
        if( argc != 5 )
        {
                    printf("  usage: display mapper path page_id nbytes\n");
            }
        else
        {
                unsigned int page_id   = atoi(argv[3]);
            unsigned int nbytes    = atoi(argv[4]);

            if( display_mapper( argv[2] , page_id, nbytes ) )
            {
                printf("  error: cannot display page %d of mapper %s\n", page_id, argv[2] );
            }
        }
    }
    else
    {
        printf("  error: undefined display request : %s\n", argv[1] ); 
    }        

    // release semaphore to get next command
    sem_post( &semaphore );

} // end cmd_display()

/////////////////////////////////////////
static void cmd_fg(int argc, char **argv)
{
        unsigned int pid;

        if (argc != 2) 
    {
                printf("  usage: %s pid\n", argv[0]);
        }
    else
    {
        pid = atoi( argv[1] );   

        if( pid == 0 )
        {  
                    printf("  error: PID cannot be 0\n" );
            }
        else if( fg( pid ) )
        {
                    printf("  error: cannot find process %x\n", pid );
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_fg()

//////////////////////////////////////////////
static void cmd_help( int argc , char **argv )
{
        unsigned int i;

        if (argc != 1) 
    {
                printf("  usage: %s\n", argv[0]);
        }
    else
    {
            printf("available commands:\n");
            for (i = 0 ; cmd[i].name ; i++) 
        {
                    printf("\t%s\t : %s\n", cmd[i].name , cmd[i].desc);
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}   // end cmd_help()

//////////////////////////////////////////////
static void cmd_kill( int argc , char **argv )
{
        unsigned int pid;

        if (argc != 2) 
    {
                printf("  usage: %s pid\n", argv[0]);
        }
    else
    {
            pid = atoi( argv[1] );

        if( pid == 0 )
        {
                    printf("  error: kernel process 0 cannot be killed\n" );
            }

            else if( kill( pid , SIGKILL ) )
        {
                    printf("  error: process %x cannot be killed\n", pid );
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}   // end cmd_kill()

//////////////////////////////////////////////
static void cmd_load( int argc , char **argv )
{
        int                  ret_fork;           // return value from fork 
        int                  ret_exec;           // return value from exec
    unsigned int         ksh_pid;            // KSH process PID
        char               * pathname;           // path to .elf file
    unsigned int         background;         // background execution if non zero
    unsigned int         placement;          // placement specified if non zero
    unsigned int         cxy;                // target cluster if placement specified

        if( (argc < 2) || (argc > 4) )  
    {
                printf("  usage: %s pathname [cxy] [&]\n", argv[0] );
        }
    else
    {
            pathname = argv[1];

        if( argc == 2 )
        {
            background = 0;
            placement  = 0;
            cxy        = 0;
        }
        else if( argc == 3 )
        {
            if( (argv[2][0] == '&') && (argv[2][1] == 0) )
            {
                background = 1;
                placement  = 0;
                cxy        = 0;
            }
            else 
            {
                background = 0;
                placement  = 1;
                cxy        = atoi( argv[2] );
            }
        }
        else  // argc == 4
        { 
            background = ( (argv[3][0] == '&') && (argv[3][1] == 0) );
            placement  = 1;
            cxy        = atoi( argv[2] );
        }

        // get KSH process PID
        ksh_pid = getpid();

#if DEBUG_CMD_LOAD
long long unsigned cycle;
get_cycle( &cycle );
printf("\n[ksh] %s : ksh_pid %x / path %s / bg %d / place %d (%x) / cycle %d\n",
__FUNCTION__, ksh_pid, argv[1], background, placement, cxy, (int)cycle );
#endif

        // set target cluster if required
        if( placement ) place_fork( cxy );

        // KSH process fork CHILD process
            ret_fork = fork();

        if ( ret_fork < 0 )     // it is a failure reported to KSH
        {
            printf("  error: ksh process unable to fork\n");
        }
        else if (ret_fork == 0) // it is the CHILD process 
        {

#if DEBUG_CMD_LOAD
get_cycle( &cycle );
printf("\n[ksh] %s : child_pid %x after fork, before exec / cycle %d\n",
__FUNCTION__ , getpid(), (int)cycle );
#endif

            // CHILD process exec NEW process
            ret_exec = execve( pathname , NULL , NULL );

#if DEBUG_CMD_LOAD
get_cycle( &cycle );
printf("\n[ksh] %s : child_pid %x after exec / ret_exec %d / cycle %d\n",
__FUNCTION__ , getpid(), ret_exec, (int)cycle );
#endif

            // this is only executed in case of exec failure
            if( ret_exec )
            {
                printf("  error: child process unable to exec <%s>\n", pathname );
                exit( 0 );
            }   
            } 
        else                    // it is the KSH process : ret_fork is the new process PID
        {

#if DEBUG_CMD_LOAD
get_cycle( &cycle );
printf("\n[ksh] %s : ksh_pid %x after fork / ret_fork %x / cycle %d\n",
__FUNCTION__, getpid(), ret_fork, (int)cycle );
#endif

            if( background )    // child in background =>  KSH must keep TXT ownership
            {
                fg( ksh_pid );
            }
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );
    
}   // end cmd_load

/////////////////////////////////////////////
static void cmd_log( int argc , char **argv )
{
        unsigned int i;

        if (argc != 1)
    {
                printf("  usage: %s\n", argv[0], argc ); 
        }
    else
    {
            printf("--- registered commands ---\n");
            for (i = 0; i < LOG_DEPTH; i++) 
        {
                    printf(" - %d\t: %s\n", i, &log_entries[i].buf);
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

} // end cmd_log()


////////////////////////////////////////////
static void cmd_ls( int argc , char **argv )
{
        char           * pathname;
    struct dirent  * entry;
    DIR            * dir;

        if (argc > 2 )
    {
                printf("  usage: ls [path]\n");
        }
    else
    {
        // handle case with no argument

        // get target directory path
        if ( argc == 1 ) strcpy( pathname , "." );
        else             pathname = argv[1];

        // open target directory
            dir = opendir( pathname );

#if DEBUG_CMD_LS
printf("\n[ksh] %s : directory <%s> open / DIR %x\n",
__FUNCTION__, pathname , dir );
#endif

        if( dir == NULL)
            {
                    printf("  error : directory <%s> not found\n", pathname );
            goto cmd_ls_exit;
            }

        // loop on directory entries    
        while ( (entry = readdir(dir)) != NULL )
            {
                    printf("%s\n", entry->d_name);
            }

        // close target directory
            closedir( dir );

#if DEBUG_CMD_LS
printf("\n[ksh] %s : directory <%s> closed\n",
__FUNCTION__, pathname );
#endif

    }

cmd_ls_exit:

    // release semaphore to get next command
    sem_post( &semaphore );

} // end cmd_ls()

///////////////////////////////////////////////
static void cmd_mkdir( int argc , char **argv )
{
        char * pathname;

        if (argc != 2)
    {
                printf("  usage: mkdir pathname\n");
        }
    else
    {
        pathname = argv[1];

        mkdir( pathname , 0x777 );
    }

    // release semaphore to get next command
    sem_post( &semaphore );

} // end cmd_mkdir()

////////////////////////////////////////////
static void cmd_mv( int argc , char **argv )
{
        char * old_path;
    char * new_path;

        if (argc != 3) 
    {
                printf("  usage: mv old_pathname new_pathname\n");
        }
    else
    {
        old_path = argv[1];
        new_path = argv[2];

        // call the relevant syscall
        if( rename( old_path , new_path ) )
        {
            printf("  error: unable to rename <%s> to <%s>\n", old_path, new_path );
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_mv


////////////////////////////////////////////
static void cmd_ps( int argc , char **argv )
{
    unsigned int x_size;
    unsigned int y_size;
    unsigned int ncores;
    unsigned int x;
    unsigned int y;

        if (argc != 1)
    {
                printf("  usage: %s\n", argv[0]);
        }
    else
    {
        // get platform config
        get_config( &x_size , &y_size , &ncores );

        // scan all clusters
        for( x = 0 ; x < x_size ; x++ )
        {
            for( y = 0 ; y < y_size ; y++ )
            {
                // display only owned processes
                display_cluster_processes( HAL_CXY_FROM_XY(x,y), 1 ); 
            }
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_ps()

/////////////////////////////////////////////
static void cmd_pwd( int argc , char **argv )
{
        char buf[1024];

        if (argc != 1)
    {
                printf("  usage: %s\n", argv[0]);
        }
    else 
    {
        if ( getcwd( buf , 1024 ) ) 
        {
                    printf("  error: unable to get current directory\n");
            }
        else 
        {
                    printf("%s\n", buf);
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_pwd()

////////////////////////////////////////////
static void cmd_rm( int argc , char **argv )
{
        char * pathname;

        if (argc != 2)
    {
                printf("  usage: %s pathname\n", argv[0]);
        }
    else
    {
            pathname = argv[1];

        if ( unlink( pathname ) )
        {
                    printf("  error: unable to remove <%s>\n", pathname );
            }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end_cmd_rm()

///////////////////////////////////////////////
static void cmd_rmdir( int argc , char **argv )
{
    // same as cmd_rm()
        cmd_rm(argc, argv);
}

///////////////////////////////////////////////
static void cmd_trace( int argc , char **argv )
{
    unsigned int cxy;
    unsigned int lid;

        if (argc != 3)
    {
                printf("  usage: trace cxy lid \n");
        }
    else
    {
        cxy = atoi(argv[1]);
        lid = atoi(argv[2]);

        if( trace( 1 , cxy , lid ) )
        {
            printf("  error: core[%x,%d] not found\n", cxy, lid );
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_trace

///////////////////////////////////////////////
static void cmd_untrace( int argc , char **argv )
{
    unsigned int cxy;
    unsigned int lid;

        if (argc != 3)
    {
                printf("  usage: untrace cxy lid \n");
        }
    else
    {
        cxy = atoi(argv[1]);
        lid = atoi(argv[2]);

        if( trace( 0 , cxy , lid ) )
        {
            printf("  error: core[%x,%d] not found\n", cxy, lid );
        }
    }

    // release semaphore to get next command
    sem_post( &semaphore );

}  // end cmd_untrace()

///////////////////////////////////////////////////////////////////////////////////
// Array of commands
///////////////////////////////////////////////////////////////////////////////////

ksh_cmd_t cmd[] =
{
        { "cat",     "display file content",                            cmd_cat     },
        { "cd",      "change current directory",                        cmd_cd      },
        { "cp",      "replicate a file in file system",                 cmd_cp      },
    { "fg",      "put a process in foreground",                     cmd_fg      },
    { "display", "display vmm/sched/process/vfs/chdev/txt",         cmd_display },
        { "load",    "load an user application",                        cmd_load    },
        { "help",    "list available commands",                         cmd_help    },
        { "kill",    "kill a process (all threads)",                    cmd_kill    },
        { "log",     "list registered commands",                        cmd_log     },
        { "ls",      "list directory entries",                          cmd_ls      },
        { "mkdir",   "create a new directory",                          cmd_mkdir   },
        { "mv",      "move a file in file system",                      cmd_mv      },
        { "pwd",     "print current working directory",                 cmd_pwd     },
        { "ps",      "display all processes",                           cmd_ps      },
        { "rm",      "remove a file from file system",                  cmd_rm      },
        { "rmdir",   "remove a directory from file system",             cmd_rmdir   },
        { "trace",   "activate trace for a given core",                 cmd_trace   },
        { "untrace", "desactivate trace for a given core",              cmd_untrace },
        { NULL,      NULL,                                                                              NULL        }
};

////////////////////////////////////////////////////////////////////////////////////
// This function analyses one command (with arguments), executes it, and returns.
////////////////////////////////////////////////////////////////////////////////////
static void __attribute__ ((noinline)) parse( char * buf )
{
        int argc = 0;
        char *argv[MAX_ARGS];
        int i;
        int len = strlen(buf);

        // build argc/argv
        for (i = 0; i < len; i++) 
    {
                if (buf[i] == ' ') 
        {
                        buf[i] = '\0';
                }
        else if (i == 0 || buf[i - 1] == '\0') 
        {
                        if (argc < MAX_ARGS) 
            {
                                argv[argc] = &buf[i];
                                argc++;
                        }
                }
        }

    // analyse command type
        if (argc > 0)
    {
                int found = 0;

                argv[argc] = NULL;

                // try to match typed command 
                for (i = 0 ; cmd[i].name ; i++)
        {
                        if (strcmp(argv[0], cmd[i].name) == 0)
            {
                                cmd[i].fn(argc, argv);
                                found = 1;
                                break;
                        }
                }

                if (!found)  // undefined command
        {
                        printf("  error : undefined command <%s>\n", argv[0]);

            // release semaphore to get next command
            sem_post( &semaphore );
                }
        }
}  // end parse()

///////////////////////////////
static void interactive( void )
{
        char           c;                                               // read character
        char           buf[CMD_MAX_SIZE];               // buffer for one command
    unsigned int   end_command;             // last character found in a command
        unsigned int   count;                   // pointer in command buffer
        unsigned int   i;                                               // index for loops
        unsigned int   state;                   // escape sequence state


/* To lauch one command without interactive mode 
   
if( sem_wait( &semaphore ) )
{
    printf("\n[ksh error] cannot found semafore\n" );
    exit( 1 );
}
else
{
    printf("\n[ksh] ls bin/user\n");
}

strcpy( buf , "ls bin/user" );
parse( buf );

*/

        enum fsm_states 
    {
                NORMAL = 0,
                ESCAPE = 1,
                BRAKET = 2,
        };

        // This lexical analyser writes one command line in the command buffer.
        // It is implemented as a 3 states FSM to handle the following escape sequences:
        // - ESC [ A : up arrow
        // - ESC [ B : down arrow
        // - ESC [ C : right arrow
        // - ESC [ D : left arrow
        // The three states have the following semantic:
        // - NORMAL : no (ESC) character has been found
        // - ESCAPE : the character (ESC) has been found
        // - BRAKET : the wo characters (ESC,[) have been found

    // external loop on the commands
    // the in teractive thread should not exit this loop
        while (1)
        {
            // initialize command buffer
            memset( buf, 0x20 , sizeof(buf) );   // TODO useful ?
            count = 0;
            state = NORMAL;

        // decrement semaphore, and block if the KSH process is not the TXT owner
        if ( sem_wait( &semaphore ) )
        {
            printf("\n[ksh error] cannot found semafore\n" );
            exit( 1 );
        }

        // display prompt on a new line
        printf("\n[ksh] ");
 
        end_command = 0;

        // internal loop on characters in one command
        while( end_command == 0 )
        {
            // get one character from TXT_RX
                c = (char)getchar();

            if( c == 0 ) continue;

                    if( state == NORMAL )  // we are not in an escape sequence
                    {
                                if ((c == '\b') || (c == 0x7F))  // backspace => remove one character
                                {
                                    if (count > 0)
                    {
                                        printf("\b \b");
                                        count--;
                                    }
                                }
                                else if (c == '\n')                  // new line => end of command
                                {
                                    if (count > 0)               // analyse & execute command
                                    {
                                            // complete command with NUL character
                                            buf[count] = 0;
                        count++;

                                        // register command in log arrays
                                            strcpy(log_entries[ptw].buf, buf);
                                            log_entries[ptw].count = count;
                                            ptw = (ptw + 1) % LOG_DEPTH;
                                            ptr = ptw;

                        // echo character
                        putchar( c );

                                            // call parser to analyse and execute command
                                            parse( buf );
                                    }
                    else                         // no command registered
                    {
                        // release semaphore to get next command
                        sem_post( &semaphore );
                    }

                    // exit internal loop on characters
                    end_command = 1;
                }
                            else if (c == '\t')             // tabulation => do nothing
                                {
                            }
                            else if (c == (char)0x1B)       // ESC => start an escape sequence
                            {
                    state = ESCAPE;
                            }
                            else                                               // normal character
                                {
                                    if (count < sizeof(buf) - 1)
                                    {
                        // register character in command buffer
                                            buf[count] = c;
                                            count++;

                        // echo character
                        putchar( c );
                                        }
                                }
                        }
                        else if( state == ESCAPE )  
                        {
                                if (c == '[')           //  valid sequence => continue
                                {
                                        state = BRAKET;
                                }
                                else                               // invalid sequence => do nothing
                                {
                                        state = NORMAL;
                                }
                        }
                        else if( state == BRAKET )
                        {
                                if (c == 'D')   // valid  LEFT sequence => move buf pointer left
                                {
                                        if (count > 0)
                                        {
                                                printf("\b");
                                                count--;
                                        }

                                        // get next user char
                                        state = NORMAL;
                                }
                                else if (c == 'C')   // valid  RIGHT sequence => move buf pointer right
                                {
                                        if (count < sizeof(buf) - 1)
                                        {
                                                printf("%c", buf[count]);
                                                count++;
                                        }

                                        // get next user char
                                        state = NORMAL;
                                }
                                else if (c == 'A')   // valid  UP sequence => move log pointer backward
                                {
                                        // cancel current command
                                        for (i = 0; i < count; i++) printf("\b \b");
                                        count = 0;

                                        // copy log command into buf
                                        ptr = (ptr - 1) % LOG_DEPTH;
                                        strcpy(buf, log_entries[ptr].buf);
                                        count = log_entries[ptr].count - 1;

                                        // display log command
                                        printf("%s", buf);

                                        // get next user char
                                        state = NORMAL;
                                }
                                else if (c == 'B')   // valid  DOWN sequence => move log pointer forward
                                {
                                        // cancel current command
                                        for (i = 0 ; i < count; i++) printf("\b \b");
                                        count = 0;

                                        // copy log command into buf
                                        ptr = (ptr + 1) % LOG_DEPTH;
                                        strcpy(buf, log_entries[ptr].buf);
                                        count = log_entries[ptr].count;

                                        // display log command
                                        printf("%s", buf);

                                        // get next user char
                                        state = NORMAL;
                                }
                                else                               // other character => do nothing
                                {
                                        // get next user char
                                        state = NORMAL;
                                }
                        }
                }  // end internal while loop on characters
        }  // end external while loop on commands
}  // end interactive()

////////////////
int main( void )
{
    unsigned int cxy;             // owner cluster identifier for this KSH process
    unsigned int lid;             // core identifier for this KSH main thread
    int          status;          // child process termination status
    int          child_pid;       // child process identifier
    int          parent_pid;      // parent process identifier (i.e. this process)
    pthread_t    trdid;           // interactive thread identifier (unused)
    unsigned int is_owner;        // non-zero if KSH process is TXT owner

    // initialize log buffer
        memset( &log_entries , 0, sizeof(log_entries));
        ptw   = 0;
        ptr   = 0;

    // get KSH process pid and core
    parent_pid = getpid();
    get_core( &cxy , &lid );

#if DEBUG_MAIN
printf("\n[ksh] main started on core[%x,%d]\n", cxy , lid ); 
#endif
    
    // initializes the semaphore used to synchronize with interactive thread
    if ( sem_init( &semaphore , 0 , 1 ) )
    {
        printf("\n[KSH ERROR] cannot initialize semaphore\n" );
        exit( 1 ); 
    }

#if DEBUG_MAIN
printf("\n[ksh] main initialized semaphore\n" ); 
#endif
    
    // initialize interactive thread attributes
    attr.attributes = PT_ATTR_DETACH | PT_ATTR_CLUSTER_DEFINED;
    attr.cxy        = cxy;

    // lauch the interactive thread 
    pthread_create( &trdid,
                    &attr,
                    &interactive,   // entry function
                    NULL ); 
#if DEBUG_MAIN
printf("\n[ksh] main launched interactive thread => wait children termination\n" ); 
#endif

    // signal INIT process
    kill( 1 , SIGCONT );
    
    // enter infinite loop monitoring children processes termination 
    while( 1 )
    {
        // wait children termination
        child_pid = wait( &status );

#if DEBUG_MAIN
if( WIFEXITED  (status) ) printf("\n[ksh] child process %x exit\n"   , child_pid );
if( WIFSIGNALED(status) ) printf("\n[ksh] child process %x killed\n" , child_pid );
if( WIFSTOPPED (status) ) printf("\n[ksh] child process %x stopped\n", child_pid );
#endif

        // release semaphore if KSH process is TXT owner, to unblock interactive thread
        is_fg( parent_pid , &is_owner );
        if( is_owner ) sem_post( &semaphore );

    }
}  // end main()