Kernel/system.c

   1 /*
   2  * Acess 2
   3  * Architecture Independent System Init
   4  * system.c
   5  */
   6 #define DEBUG   0
   7 #include <acess.h>
   8
   9 #define N_VARIABLES     16
  10 #define N_MAX_ARGS      BITS
  11
  12 // === TYPES ===
  13 typedef struct
  14 {
  15          int    TrueLine;
  16          int    nParts;
  17         char    **Parts;
  18 }       tConfigLine;
  19 typedef struct
  20 {
  21          int    nLines;
  22         tConfigLine     Lines[];
  23 }       tConfigFile;
  24 typedef struct
  25 {
  26         const char      *Name;          // Name
  27          int    MinArgs;        // Minimum number of arguments
  28          int    MaxArgs;        // Maximum number of arguments
  29         Uint    IntArgs;        // Bitmap of arguments that should be treated as integers
  30         void    *Func;          // Function pointer
  31         Uint    OptDefaults[N_MAX_ARGS];        // Default values for optional arguments
  32 }       tConfigCommand;
  33
  34 // === IMPORTS ===
  35 extern void     Arch_LoadBootModules(void);
  36 extern int      Modules_LoadBuiltins(void);
  37 extern void     Modules_SetBuiltinParams(char *Name, char *ArgString);
  38 extern void     Debug_SetKTerminal(const char *File);
  39
  40 // === PROTOTYPES ===
  41 void    System_Init(char *Commandline);
  42 void    System_ParseCommandLine(char *ArgString);
  43 void    System_ExecuteCommandLine(void);
  44 void    System_ParseVFS(char *Arg);
  45 void    System_ParseModuleArgs(char *Arg);
  46 void    System_ParseSetting(char *Arg);
  47 void    System_ExecuteScript(void);
  48 tConfigFile     *System_Int_ParseFile(char *File);
  49
  50 // === CONSTANTS ===
  51 const tConfigCommand    caConfigCommands[] = {
  52         {"module",  1,2, 00, Module_LoadFile, {(Uint)"",0}},    // Load a module from a file
  53         {"spawn",   1,1, 00, Proc_Spawn, {0}},          // Spawn a process
  54         // --- VFS ---
  55         {"mount",   3,4, 00, VFS_Mount, {(Uint)"",0}},          // Mount a device
  56         {"symlink", 2,2, 00, VFS_Symlink, {0}}, // Create a Symbolic Link
  57         {"mkdir",   1,1, 00, VFS_MkDir, {0}},           // Create a Directory
  58         {"open",    1,2, 00, VFS_Open,  {VFS_OPENFLAG_READ,0}}, // Open a file
  59         {"close",   1,1, 01, VFS_Close, {0}},   // Close an open file
  60         {"ioctl",   3,3, 03, VFS_IOCtl, {0}},   // Call an IOCtl
  61
  62         {"", 0,0, 0, NULL, {0}}
  63 };
  64 #define NUM_CONFIG_COMMANDS     (sizeof(caConfigCommands)/sizeof(caConfigCommands[0]))
  65
  66 // === GLOBALS ===
  67 const char      *gsConfigScript = "/Acess/Conf/BootConf.cfg";
  68 char    *argv[32];
  69  int    argc;
  70
  71 // === CODE ===
  72 void System_Init(char *CommandLine)
  73 {
  74         // Parse Kernel's Command Line
  75         System_ParseCommandLine(CommandLine);
  76
  77         // Initialise modules
  78         Log_Log("Config", "Initialising builtin modules...");
  79         Modules_LoadBuiltins();
  80         Arch_LoadBootModules();
  81
  82         System_ExecuteCommandLine();
  83
  84         // - Execute the Config Script
  85         Log_Log("Config", "Executing config script...");
  86         System_ExecuteScript();
  87
  88         // Set the debug to be echoed to the terminal
  89         Log_Log("Config", "Kernel now echoes to VT7 (Ctrl-Alt-F8)");
  90         Debug_SetKTerminal("/Devices/VTerm/7");
  91 }
  92
  93 /**
  94  * \fn void System_ParseCommandLine(char *ArgString)
  95  * \brief Parses the kernel's command line and sets the environment
  96  */
  97 void System_ParseCommandLine(char *ArgString)
  98 {
  99          int    i;
 100         char    *str;
 101
 102         Log_Log("Config", "Kernel Invocation (%p) \"%s\"", ArgString, ArgString);
 103         Log_Log("Config", "Kernel Invocation '0x%x 0x%x'", ArgString[0], ArgString[1]);
 104
 105         // --- Get Arguments ---
 106         str = ArgString;
 107         for( argc = 0; argc < 32; argc++ )
 108         {
 109                 // Eat Whitespace
 110                 while(*str == ' ')      str++;
 111                 // Check for the end of the string
 112                 if(*str == '\0') {      argc--; break;}
 113                 argv[argc] = str;
 114                 if(*str == '"') {
 115                         while(*str && !(*str == '"' && str[-1] != '\\'))
 116                                 str ++;
 117                 }
 118                 else {
 119                         while(*str && *str != ' ')
 120                                 str++;
 121                 }
 122                 if(*str == '\0')        break;  // Check for EOS
 123                 *str = '\0';    // Cap off argument string
 124                 str ++; // and increment the string pointer
 125         }
 126         if(argc < 32)
 127                 argc ++;        // Count last argument
 128
 129         // --- Parse Arguments (Pass 1) ---
 130         for( i = 0; i < argc; i++ )
 131         {
 132                 switch(argv[i][0])
 133                 {
 134                 // --- VFS ---
 135                 // Ignored on this pass
 136                 case '/':
 137                         break;
 138
 139                 // --- Module Paramaters ---
 140                 // -VTerm:Width=640,Height=480,Scrollback=2
 141                 case '-':
 142                         System_ParseModuleArgs( argv[i] );
 143                         break;
 144                 // --- Config Options ---
 145                 // SCRIPT=/Acess/Conf/BootConf.cfg
 146                 default:
 147                         System_ParseSetting( argv[i] );
 148                         break;
 149                 }
 150         }
 151 }
 152
 153 void System_ExecuteCommandLine(void)
 154 {
 155          int    i;
 156         for( i = 0; i < argc; i++ )
 157         {
 158                 Log("argv[%i] = '%s'", i, argv[i]);
 159                 switch(argv[i][0])
 160                 {
 161                 // --- VFS ---
 162                 // Mount    /System=ext2:/Devices/ATA/A1
 163                 // Symlink  /Acess=/System/Acess2
 164                 case '/':
 165                         System_ParseVFS( argv[i] );
 166                         break;
 167                 }
 168         }
 169 }
 170
 171 /**
 172  * \fn void System_ParseVFS(char *Arg)
 173  */
 174 void System_ParseVFS(char *Arg)
 175 {
 176         char    *value;
 177          int    fd;
 178
 179         value = Arg;
 180         // Search for the '=' token
 181         while( *value && *value != '=' )
 182                 value++;
 183
 184         // Check if the equals was found
 185         if( *value == '\0' ) {
 186                 Log_Warning("Config", "Expected '=' in the string '%s'", Arg);
 187                 return ;
 188         }
 189
 190         // Edit string
 191         *value = '\0';  value ++;
 192
 193         // Check assignment type
 194         // - Symbolic Link <link>=<destination>
 195         if(value[0] == '/')
 196         {
 197                 Log_Log("Config", "Symbolic link '%s' pointing to '%s'", Arg, value);
 198                 VFS_Symlink(Arg, value);
 199         }
 200         // - Mount <mountpoint>=<fs>:<device>
 201         else
 202         {
 203                 char    *dev = value;
 204                 // Find colon
 205                 while(*dev && *dev != ':')      dev++;
 206                 if(*dev) {
 207                         *dev = '\0';
 208                         dev++;  // Eat ':'
 209                 }
 210                 // Create Mountpoint
 211                 if( (fd = VFS_Open(Arg, 0)) == -1 ) {
 212                         Log_Log("Config", "Creating directory '%s'", Arg, value);
 213                         VFS_MkDir( Arg );
 214                 } else {
 215                         VFS_Close(fd);
 216                 }
 217                 // Mount
 218                 Log_Log("Config", "Mounting '%s' to '%s' ('%s')", dev, Arg, value);
 219                 VFS_Mount(dev, Arg, value, "");
 220         }
 221 }
 222
 223 /**
 224  * \brief Parse a module argument string
 225  * \param Arg   Argument string
 226  */
 227 void System_ParseModuleArgs(char *Arg)
 228 {
 229         char    *name, *args;
 230          int    i;
 231
 232         // Remove '-'
 233         name = Arg + 1;
 234
 235         // Find the start of the args
 236         i = strpos(name, ':');
 237         if( i == -1 ) {
 238                 Log_Warning("Config", "Module spec with no arguments");
 239                 #if 1
 240                 return ;
 241                 #else
 242                 i = strlen(name);
 243                 args = name + i;
 244                 #endif
 245         }
 246         else {
 247                 name[i] = '\0';
 248                 args = name + i + 1;
 249         }
 250
 251         Log_Log("Config", "Setting boot parameters for '%s' to '%s'", name, args);
 252         Modules_SetBuiltinParams(name, args);
 253 }
 254
 255 /**
 256  * \fn void System_ParseSetting(char *Arg)
 257  */
 258 void System_ParseSetting(char *Arg)
 259 {
 260         char    *value;
 261         value = Arg;
 262
 263         // Search for the '=' token
 264         while( *value && *value != '=' )
 265                 value++;
 266
 267         // Check for boolean/flag (no '=')
 268         if(*value == '\0')
 269         {
 270                 //if(strcmp(Arg, "") == 0) {
 271                 //} else {
 272                         Log_Warning("Config", "Kernel flag '%s' is not recognised", Arg);
 273                 //}
 274         }
 275         else
 276         {
 277                 *value = '\0';  // Remove '='
 278                 value ++;       // and eat it's position
 279
 280                 if(strcmp(Arg, "SCRIPT") == 0) {
 281                         Log_Log("Config", "Config Script: '%s'", value);
 282                         if(strlen(value) == 0)
 283                                 gsConfigScript = NULL;
 284                         else
 285                                 gsConfigScript = value;
 286                 } else {
 287                         Log_Warning("Config", "Kernel config setting '%s' is not recognised", Arg);
 288                 }
 289
 290         }
 291 }
 292
 293 /**
 294  * \fn void System_ExecuteScript()
 295  * \brief Reads and parses the boot configuration script
 296  */
 297 void System_ExecuteScript(void)
 298 {
 299          int    fp;
 300          int    fLen = 0;
 301          int    i, j, k;
 302          int    val;
 303          int    result = 0;
 304          int    variables[N_VARIABLES];
 305          int    bReplaced[N_MAX_ARGS];
 306         char    *fData;
 307         char    *jmpTarget;
 308         tConfigFile     *file;
 309         tConfigLine     *line;
 310
 311         // Open Script
 312         fp = VFS_Open(gsConfigScript, VFS_OPENFLAG_READ);
 313         if(fp == -1) {
 314                 Log_Warning("Config", "Passed script '%s' does not exist", gsConfigScript);
 315                 return;
 316         }
 317
 318         // Get length
 319         VFS_Seek(fp, 0, SEEK_END);
 320         fLen = VFS_Tell(fp);
 321         VFS_Seek(fp, 0, SEEK_SET);
 322         // Read into memory buffer
 323         fData = malloc(fLen+1);
 324         VFS_Read(fp, fLen, fData);
 325         fData[fLen] = '\0';
 326         VFS_Close(fp);
 327
 328
 329         // Parse File
 330         file = System_Int_ParseFile(fData);
 331
 332         // Parse each line
 333         for( i = 0; i < file->nLines; i++ )
 334         {
 335                 line = &file->Lines[i];
 336                 if( line->nParts == 0 ) continue;       // Skip blank
 337
 338                 if(line->Parts[0][0] == ':')    continue;       // Ignore labels
 339
 340                 // Prescan and eliminate variables
 341                 for( j = 1; j < line->nParts; j++ )
 342                 {
 343                         Log_Debug("Config", "Arg #%i is '%s'", j, line->Parts[j]);
 344                         bReplaced[j] = 0;
 345                         if( line->Parts[j][0] != '$' )  continue;
 346                         if( line->Parts[j][1] == '?' ) {
 347                                 val = result;
 348                         }
 349                         else {
 350                                 val = atoi( &line->Parts[j][1] );
 351                                 if( val < 0 || val > N_VARIABLES )      continue;
 352                                 val = variables[ val ];
 353                         }
 354                         Log_Debug("Config", "Replaced arg %i ('%s') with 0x%x", j, line->Parts[j], val);
 355                         line->Parts[j] = malloc( BITS/8+2+1 );
 356                         sprintf(line->Parts[j], "0x%x", val);
 357                         bReplaced[j] = 1;
 358                 }
 359
 360                 // Find the command name
 361                 for( j = 0; j < NUM_CONFIG_COMMANDS; j++ )
 362                 {
 363                         Uint    args[N_MAX_ARGS];
 364
 365                         if(strcmp(line->Parts[0], caConfigCommands[j].Name) != 0)       continue;
 366
 367                         Log_Debug("Config", "Command '%s', %i args passed", line->Parts[0], line->nParts-1);
 368
 369                         // Check against minimum argument count
 370                         if( line->nParts - 1 < caConfigCommands[j].MinArgs ) {
 371                                 Log_Warning("Config",
 372                                         "Configuration command '%s' requires at least %i arguments, %i given",
 373                                         caConfigCommands[j].Name, caConfigCommands[j].MinArgs, line->nParts-1
 374                                         );
 375                                 break;
 376                         }
 377
 378                         // Check for extra arguments
 379                         if( line->nParts - 1 > caConfigCommands[j].MaxArgs ) {
 380                                 Log_Warning("Config",
 381                                         "Configuration command '%s' takes at most %i arguments, %i given",
 382                                         caConfigCommands[j].Name, caConfigCommands[j].MaxArgs, line->nParts-1
 383                                         );
 384                                 break;
 385                         }
 386
 387                         // Fill in defaults
 388                         for( k = caConfigCommands[j].MaxArgs-1; k > line->nParts - 1; k-- ) {
 389                                 args[k] = caConfigCommands[j].OptDefaults[k];
 390                         }
 391
 392                         // Convert arguments to integers
 393                         for( k = line->nParts-1; k--; )
 394                         {
 395                                 if( caConfigCommands[j].IntArgs & (1 << k) ) {
 396                                         args[k] = atoi(line->Parts[k+1]);
 397                                 }
 398                                 else {
 399                                         args[k] = (Uint)line->Parts[k+1];
 400                                 }
 401                                 Log_Debug("Config", "args[%i] = 0x%x", k, args[k]);
 402                         }
 403                         result = CallWithArgArray(caConfigCommands[j].Func, caConfigCommands[j].MaxArgs, args);
 404                         Log_Debug("Config", "result = %i", result);
 405                         break;
 406                 }
 407                 if( j < NUM_CONFIG_COMMANDS )   continue;
 408
 409                 // --- State and Variables ---
 410                 if(strcmp(line->Parts[0], "set") == 0)
 411                 {
 412                          int    to, value;
 413                         if( line->nParts-1 != 2 ) {
 414                                 Log_Warning("Config", "Configuration command 'set' requires 2 arguments, %i given",
 415                                         line->nParts-1);
 416                                 continue;
 417                         }
 418
 419                         to = atoi(line->Parts[1]);
 420                         value = atoi(line->Parts[2]);
 421
 422                         variables[to] = value;
 423                         result = value;
 424                 }
 425                 // if <val1> <op> <val2> <dest>
 426                 else if(strcmp(line->Parts[0], "if") == 0)
 427                 {
 428                         if( line->nParts-1 != 4 ) {
 429                                 Log_Warning("Config", "Configuration command 'if' requires 4 arguments, %i given",
 430                                         line->nParts-1);
 431                         }
 432
 433                         result = atoi(line->Parts[1]);
 434                         val = atoi(line->Parts[3]);
 435
 436                         jmpTarget = line->Parts[4];
 437
 438                         Log_Log("Config", "IF 0x%x %s 0x%x THEN GOTO %s",
 439                                 result, line->Parts[2], val, jmpTarget);
 440
 441                         if( strcmp(line->Parts[2], "<" ) == 0 ) {
 442                                 if( result < val )      goto jumpToLabel;
 443                         }
 444                         else if( strcmp(line->Parts[2], "<=") == 0 ) {
 445                                 if( result <= val )     goto jumpToLabel;
 446                         }
 447                         else if( strcmp(line->Parts[2], ">" ) == 0 ) {
 448                                 if (result > val )      goto jumpToLabel;
 449                         }
 450                         else if( strcmp(line->Parts[2], ">=") == 0 ) {
 451                                 if( result >= val )     goto jumpToLabel;
 452                         }
 453                         else if( strcmp(line->Parts[2],  "=") == 0 ) {
 454                                 if( result == val )     goto jumpToLabel;
 455                         }
 456                         else if( strcmp(line->Parts[2], "!=") == 0 ) {
 457                                 if( result != val )     goto jumpToLabel;
 458                         }
 459                         else {
 460                                 Log_Warning("Config", "Unknown comparision '%s' in `if`", line->Parts[2]);
 461                         }
 462
 463                 }
 464                 else if(strcmp(line->Parts[0], "goto") == 0) {
 465                         if( line->nParts-1 != 1 ) {
 466                                 Log_Warning("Config", "Configuration command 'goto' requires 1 arguments, %i given",
 467                                         line->nParts-1);
 468                         }
 469                         jmpTarget = line->Parts[1];
 470
 471                 jumpToLabel:
 472                         for( j = 0; j < file->nLines; j ++ )
 473                         {
 474                                 if(file->Lines[j].nParts == 0)
 475                                         continue;
 476                                 if(file->Lines[j].Parts[0][0] != ':')
 477                                         continue;
 478                                 if( strcmp(file->Lines[j].Parts[0]+1, jmpTarget) == 0)
 479                                         break;
 480                         }
 481                         if( j == file->nLines )
 482                                 Log_Warning("Config", "Unable to find label '%s'", jmpTarget);
 483                         else
 484                                 i = j;
 485                 }
 486                 else {
 487                         Log_Warning("Config", "Unknown configuration command '%s' on line %i",
 488                                 line->Parts[0],
 489                                 line->TrueLine
 490                                 );
 491                 }
 492         }
 493
 494         // Clean up after ourselves
 495         for( i = 0; i < file->nLines; i++ ) {
 496                 if( file->Lines[i].nParts == 0 )        continue;       // Skip blank
 497                 for( j = 0; j < file->Lines[i].nParts; j++ ) {
 498                         if(IsHeap(file->Lines[i].Parts[j]))
 499                                 free(file->Lines[i].Parts[j]);
 500                 }
 501                 free( file->Lines[i].Parts );
 502         }
 503
 504         // Free data
 505         free( file );
 506         free( fData );
 507 }
 508
 509 /**
 510  * \brief Parses a config file
 511  * \param FileData      Read/Write buffer containing the config file data
 512  *                  (will be modified)
 513  * \return ::tConfigFile structure that represents the original contents
 514  *         of \a FileData
 515  */
 516 tConfigFile     *System_Int_ParseFile(char *FileData)
 517 {
 518         char    *ptr;
 519         char    *start;
 520          int    nLines = 1;
 521          int    i, j;
 522         tConfigFile     *ret;
 523
 524         ENTER("pFileData", FileData);
 525
 526         // Prescan and count the number of lines
 527         for(ptr = FileData; *ptr; ptr++)
 528         {
 529                 if(*ptr != '\n')        continue;
 530
 531                 if(ptr == FileData) {
 532                         nLines ++;
 533                         continue;
 534                 }
 535
 536                 // Escaped EOL
 537                 if(ptr[-1] == '\\')     continue;
 538
 539                 nLines ++;
 540         }
 541
 542         LOG("nLines = %i", nLines);
 543
 544         // Ok so we have `nLines` lines, now to allocate our return
 545         ret = malloc( sizeof(tConfigFile) + sizeof(tConfigLine)*nLines );
 546         ret->nLines = nLines;
 547
 548         // Read the file for real
 549         for(
 550                 ptr = FileData, i = 0;
 551                 *ptr;
 552                 i++
 553                 )
 554         {
 555                 start = ptr;
 556
 557                 ret->Lines[i].nParts = 0;
 558                 ret->Lines[i].Parts = NULL;
 559
 560                 // Count parts
 561                 for(;;)
 562                 {
 563                         // Read leading whitespace
 564                         while( *ptr == '\t' || *ptr == ' ' )    ptr++;
 565
 566                         // End of line/file
 567                         if( *ptr == '\0' || *ptr == '\n' ) {
 568                                 if(*ptr == '\n')        ptr ++;
 569                                 break;
 570                         }
 571                         // Comment
 572                         if( *ptr == '#' || *ptr == ';' ) {
 573                                 while( *ptr && *ptr != '\n' )   ptr ++;
 574                                 if(*ptr == '\n')        ptr ++;
 575                                 break;
 576                         }
 577
 578                         ret->Lines[i].nParts ++;
 579                         // Quoted
 580                         if( *ptr == '"' ) {
 581                                 ptr ++;
 582                                 while( *ptr && !(*ptr == '"' && ptr[-1] == '\\') && *ptr != '\n' )
 583                                         ptr++;
 584                                 continue;
 585                         }
 586                         // Unquoted
 587                         while( *ptr && !(*ptr == '\t' || *ptr == ' ') && *ptr != '\n' )
 588                                 ptr++;
 589                 }
 590
 591                 LOG("ret->Lines[%i].nParts = %i", i, ret->Lines[i].nParts);
 592
 593                 if( ret->Lines[i].nParts == 0 ) {
 594                         ret->Lines[i].Parts = NULL;
 595                         continue;
 596                 }
 597
 598                 // Allocate part list
 599                 ret->Lines[i].Parts = malloc( sizeof(char*) * ret->Lines[i].nParts );
 600
 601                 // Fill list
 602                 for( ptr = start, j = 0; ; j++ )
 603                 {
 604                         // Read leading whitespace
 605                         while( *ptr == '\t' || *ptr == ' ' )    ptr++;
 606
 607                         // End of line/file
 608                         if( *ptr == '\0' || *ptr == '\n' ) {
 609                                 if(*ptr == '\n')        ptr ++;
 610                                 break;
 611                         }
 612                         // Comment
 613                         if( *ptr == '#' || *ptr == ';' ) {
 614                                 while( *ptr && *ptr != '\n' )   ptr ++;
 615                                 if(*ptr == '\n')        ptr ++;
 616                                 break;
 617                         }
 618
 619                         ret->Lines[i].Parts[j] = ptr;
 620
 621                         // Quoted
 622                         if( *ptr == '"' ) {
 623                                 ptr ++;
 624                                 ret->Lines[i].Parts[j] = ptr;
 625                                 while( *ptr && !(*ptr == '"' && ptr[-1] == '\\') && *ptr != '\n' )
 626                                         ptr++;
 627                         }
 628                         // Unquoted
 629                         else {
 630                                 while( *ptr != '\t' && *ptr != ' ' && *ptr != '\n' )
 631                                         ptr++;
 632                         }
 633
 634                         // Break if we have reached NULL
 635                         if( *ptr == '\0' ) {
 636                                 LOG("ret->Lines[%i].Parts[%i] = '%s'", i, j, ret->Lines[i].Parts[j]);
 637                                 break;
 638                         }
 639                         if( *ptr == '\n' ) {
 640                                 *ptr = '\0';
 641                                 LOG("ret->Lines[%i].Parts[%i] = '%s'", i, j, ret->Lines[i].Parts[j]);
 642                                 ptr ++;
 643                                 break;
 644                         }
 645                         *ptr = '\0';    // Cap off string
 646                         LOG("ret->Lines[%i].Parts[%i] = '%s'", i, j, ret->Lines[i].Parts[j]);
 647                         ptr ++; // And increment for the next round
 648                 }
 649         }
 650
 651         if( i < ret->nLines ) {
 652                 ret->Lines[i].nParts = 0;
 653                 ret->Lines[i].Parts = NULL;
 654                 Log_Log("System", "Cleaning up final empty line");
 655         }
 656
 657         LEAVE('p', ret);
 658         return ret;
 659 }