Kernel - Slight reworks to timer code
[tpg/acess2.git] / Kernel / modules.c
index 389663a..98ca1a1 100644 (file)
@@ -7,39 +7,80 @@
 #include <modules.h>
 
 #define        USE_EDI 0
-#define        USE_UDI 1
+#define        USE_UDI 0
 
 // === PROTOTYPES ===
- int   Modules_LoadBuiltins();
- int   Module_LoadMem(void *Buffer, Uint Length, char *ArgString);
- int   Module_LoadFile(char *Path, char *ArgString);
+ int   Module_int_Initialise(tModule *Module, const char *ArgString);
+void   Modules_int_GetBuiltinArray(void);
+void   Modules_LoadBuiltins(void);
+void   Modules_SetBuiltinParams(const char *Name, char *ArgString);
+ int   Modules_InitialiseBuiltin(const char *Name);
+// int Module_RegisterLoader(tModuleLoader *Loader);
+// int Module_LoadMem(void *Buffer, Uint Length, char *ArgString);
+// int Module_LoadFile(char *Path, char *ArgString);
  int   Module_int_ResolveDeps(tModule *Info);
- int   Module_IsLoaded(char *Name);
+ int   Module_IsLoaded(const char *Name);
+// int Module_EnsureLoaded(const char *Name);
+
+// === EXPORTS ===
+EXPORT(Module_RegisterLoader);
 
 // === IMPORTS ===
 #if USE_UDI
 extern int     UDI_LoadDriver(void *Base);
 #endif
-extern void    StartupPrint(char *Str);
-extern tModule gKernelModules[];
-extern void    gKernelModulesEnd;
+extern void    StartupPrint(const char *Str);
+extern tModule gKernelModules;
+extern tModule gKernelModulesEnd;
 
 // === GLOBALS ===
  int   giNumBuiltinModules = 0;
- int   giModuleSpinlock = 0;
+tShortSpinlock glModuleSpinlock;
 tModule        *gLoadedModules = NULL;
 tModuleLoader  *gModule_Loaders = NULL;
 tModule        *gLoadingModules = NULL;
+tModule        **gapBuiltinModules = NULL;
+char   **gasBuiltinModuleArgs;
 
 // === CODE ===
-int Module_int_Initialise(tModule *Module)
+/**
+ * \brief Initialises a module
+ * \param Module       Pointer to the module header
+ * \param ArgString    Comma separated list of module arguments
+ * \return Zero on success, eModuleErrors or -1 on error
+ * \retval -1  Returned if a dependency fails, or a circular dependency
+ *              exists.
+ * \retval 0   Returned on success
+ * \retval >0  Error code form the module's initialisation function
+ */
+int Module_int_Initialise(tModule *Module, const char *ArgString)
 {
         int    i, j;
         int    ret;
-       char    **deps;
+       const char      **deps;
+       char    **args;
        tModule *mod;
        
        ENTER("pModule", Module);
+       LOG("Module->Magic = 0x%x", Module->Magic);
+       if(Module->Magic != MODULE_MAGIC) {
+               Log_Warning(
+                       "Module",
+                       "Module %p is no a valid Acess2 module (0x%08x != 0x%08x)",
+                       Module, Module->Magic, MODULE_MAGIC
+                       );
+               LEAVE('i', MODULE_ERR_BADMODULE);
+               return MODULE_ERR_BADMODULE;
+       }
+       LOG("Module->Name = %p \"%s\"", Module->Name, Module->Name);
+       
+       if(Module->Arch != MODULE_ARCH_ID) {
+               Log_Warning(
+                       "Module",
+                       "Module %p (%s) is for another architecture (%i)",
+                       Module, Module->Name, Module->Arch
+                       );
+       }
        
        deps = Module->Dependencies;
        
@@ -71,23 +112,28 @@ int Module_int_Initialise(tModule *Module)
                                break;
                }
                if( mod ) {
-                       Warning("[MOD  ] Circular dependency detected");
+                       Log_Warning("Module", "Circular dependency detected (%s and %s)",
+                               mod->Name, Module->Name);
                        LEAVE_RET('i', -1);
                }
                
                // So, if it's not loaded, we better load it then
                for( i = 0; i < giNumBuiltinModules; i ++ )
                {
-                       if( strcmp(deps[j], gKernelModules[i].Name) == 0 )
+                       if( strcmp(deps[j], gapBuiltinModules[i]->Name) == 0 )
                                break;
                }
                if( i == giNumBuiltinModules ) {
-                       Warning("[MOD  ] Dependency '%s' for module '%s' failed");
+                       Log_Warning("Module", "Dependency '%s' for module '%s' failed",
+                               deps[j], Module->Name);
                        return -1;
                }
                
                // Dependency is not loaded, so load it
-               ret = Module_int_Initialise( &gKernelModules[i] );
+               ret = Module_int_Initialise(
+                       gapBuiltinModules[i],
+                       gasBuiltinModuleArgs ? gasBuiltinModuleArgs[i] : NULL
+                       );
                if( ret )
                {
                        // The only "ok" error is NOTNEEDED
@@ -98,56 +144,166 @@ int Module_int_Initialise(tModule *Module)
        
        // All Dependencies OK? Initialise
        StartupPrint(Module->Name);
-       Log("[MOD  ] Initialising %p '%s' v%i.%i...",
+       Log_Log("Module", "Starting %p '%s' v%i.%i",
                Module, Module->Name,
                Module->Version >> 8, Module->Version & 0xFF
                );
        
-       ret = Module->Init(NULL);
+       if( ArgString )
+               args = str_split( ArgString, ',' );
+       else
+               args = NULL;
+       
+       ret = Module->Init(args);
+       
+       if(args)        free(args);
+       
+       // Remove from loading list
+       gLoadingModules = gLoadingModules->Next;
+       
        if( ret != MODULE_ERR_OK ) {
-               Log("[MOD  ] Loading Failed, all modules that depend on this will also fail");
                switch(ret)
                {
                case MODULE_ERR_MISC:
-                       Log("[MOD  ] Reason: Miscelanious");
+                       Log_Warning("Module", "Unable to load, reason: Miscelanious");
                        break;
                case MODULE_ERR_NOTNEEDED:
-                       Log("[MOD  ] Reason: Module not needed (probably hardware not found)");
+                       Log_Debug("Module", "Unable to load, reason: Module not needed");
                        break;
                case MODULE_ERR_MALLOC:
-                       Log("[MOD  ] Reason: Error in malloc/realloc/calloc, probably not good");
+                       Log_Warning("Module", "Unable to load, reason: Error in malloc/realloc/calloc, probably not good");
                        break;
                default:
-                       Log("[MOD  ] Reason - Unknown code %i", ret);
+                       Log_Warning("Module", "Unable to load reason - Unknown code %i", ret);
                        break;
                }
                LEAVE_RET('i', ret);
+               return ret;
        }
-       
-       // Remove from loading list
-       gLoadingModules = gLoadingModules->Next;
+       LOG("ret = %i", ret);
        
        // Add to loaded list
+       SHORTLOCK( &glModuleSpinlock );
        Module->Next = gLoadedModules;
        gLoadedModules = Module;
+       SHORTREL( &glModuleSpinlock );
        
        LEAVE_RET('i', 0);
 }
 
-int Modules_LoadBuiltins()
+/**
+ * \brief Scans the builtin modules and creates an array of them
+ */
+void Modules_int_GetBuiltinArray(void)
 {
         int    i;
+       tModule *module;
        
-       // Count modules
-       giNumBuiltinModules = (Uint)&gKernelModulesEnd - (Uint)&gKernelModules;
-       giNumBuiltinModules /= sizeof(tModule);
+       // Count
+       module = &gKernelModules;
+       i = 0;
+       while( (tVAddr)module < (tVAddr)&gKernelModulesEnd )
+       {
+               if(module->Magic == MODULE_MAGIC) {
+                       i ++;
+                       module ++;
+               }
+               else
+                       module = (void*)( (tVAddr)module + 4 );
+       }
+       
+       // Create
+       giNumBuiltinModules = i;
+       gasBuiltinModuleArgs = calloc( giNumBuiltinModules, sizeof(char*) );
+       gapBuiltinModules = malloc( giNumBuiltinModules * sizeof(tModule*) );
+       
+       
+       // Fill
+       module = &gKernelModules;
+       i = 0;
+       while( (tVAddr)module < (tVAddr)&gKernelModulesEnd )
+       {
+               if(module->Magic == MODULE_MAGIC) {
+                       gapBuiltinModules[i] = module;
+                       i ++;
+                       module ++;
+               }
+               else
+                       module = (void*)( (tVAddr)module + 4 );
+       }
+}
+
+/**
+ * \brief Initialises builtin modules
+ */
+void Modules_LoadBuiltins()
+{
+        int    i;
+       
+       if( !gapBuiltinModules )
+               Modules_int_GetBuiltinArray();
        
        for( i = 0; i < giNumBuiltinModules; i++ )
        {
-               Module_int_Initialise( &gKernelModules[i] );
+               Module_int_Initialise(
+                       gapBuiltinModules[i],
+                       (gasBuiltinModuleArgs ? gasBuiltinModuleArgs[i] : NULL)
+                       );
        }
        
-       return 0;
+       if( gasBuiltinModuleArgs != NULL )
+               free(gasBuiltinModuleArgs);
+}
+
+/**
+ * \brief Initialise a builtin module given it's name
+ * 
+ * E.g. Used by VTerm to load an alternate video driver at runtime
+ */
+int Modules_InitialiseBuiltin(const char *Name)
+{
+        int    i;
+       
+       // Check if it's loaded
+       if( Module_IsLoaded(Name) )
+               return 0;
+       
+       if( !gapBuiltinModules )
+               Modules_int_GetBuiltinArray();
+       
+       for( i = 0; i < giNumBuiltinModules; i++ )
+       {
+               if( strcmp(gapBuiltinModules[i]->Name, Name) == 0 ) {
+                       return Module_int_Initialise(gapBuiltinModules[i],
+                               (gasBuiltinModuleArgs ? gasBuiltinModuleArgs[i] : NULL)
+                               );
+               }
+       }
+       return -1;
+}
+
+/**
+ * \brief Sets the parameters for a builtin module
+ */
+void Modules_SetBuiltinParams(const char *Name, char *ArgString)
+{
+        int    i;
+       
+       if( gasBuiltinModuleArgs == NULL )
+       {
+               Modules_int_GetBuiltinArray();
+       }
+       
+       // I hate expensive scans
+       for( i = 0; i < giNumBuiltinModules; i++ )
+       {
+               if(strcmp( gapBuiltinModules[i]->Name, Name ) == 0) {
+                       gasBuiltinModuleArgs[i] = ArgString;
+                       return ;
+               }
+       }
+       
+       Log_Warning("Modules", "Unknown builtin kernel module '%s'", Name);
 }
 
 /**
@@ -168,7 +324,7 @@ int Module_RegisterLoader(tModuleLoader *Loader)
  * \fn int Module_LoadMem(void *Buffer, Uint Length, char *ArgString)
  * \brief Load a module from a memory location
  */
-int Module_LoadMem(void *Buffer, Uint Length, char *ArgString)
+int Module_LoadMem(void *Buffer, Uint Length, const char *ArgString)
 {
        char    path[VFS_MEMPATH_SIZE];
        
@@ -178,10 +334,10 @@ int Module_LoadMem(void *Buffer, Uint Length, char *ArgString)
 }
 
 /**
- * \fn int Module_LoadFile(char *Path, char *ArgString)
+ * \fn int Module_LoadFile(const char *Path, const char *ArgString)
  * \brief Load a module from a file
  */
-int Module_LoadFile(char *Path, char *ArgString)
+int Module_LoadFile(const char *Path, const char *ArgString)
 {
        void    *base;
        tModule *info;
@@ -191,7 +347,7 @@ int Module_LoadFile(char *Path, char *ArgString)
        
        // Error check
        if(base == NULL) {
-               Warning("Module_LoadFile: Unable to load '%s'", Path);
+               Log_Warning("Module", "Module_LoadFile - Unable to load '%s'", Path);
                return 0;
        }
        
@@ -217,53 +373,20 @@ int Module_LoadFile(char *Path, char *ArgString)
                // Unknown module type?, return error
                Binary_Unload(base);
                #if USE_EDI
-               Warning("Module_LoadFile: Module has neither a Module Info struct, nor an EDI entrypoint");
+               Log_Warning("Module", "Module '%s' has neither a Module Info struct, nor an EDI entrypoint", Path);
                #else
-               Warning("Module_LoadFile: Module does not have a Module Info struct");
+               Log_Warning("Module", "Module '%s' does not have a Module Info struct", Path);
                #endif
                return 0;
        }
        
-       // Check magic number
-       if(info->Magic != MODULE_MAGIC)
-       {
-               Warning("Module_LoadFile: Module's magic value is invalid (0x%x != 0x%x)", info->Magic, MODULE_MAGIC);
-               return 0;
-       }
-       
-       // Check Architecture
-       if(info->Arch != MODULE_ARCH_ID)
-       {
-               Warning("Module_LoadFile: Module is for a different architecture");
-               return 0;
-       }
-       
-       // Resolve Dependencies
-       if( !Module_int_ResolveDeps(info) ) {
-               Binary_Unload(base);
-               return 0;
-       }
-       
-       Log("Initialising %p '%s' v%i.%i...",
-                               info,
-                               info->Name,
-                               info->Version>>8, info->Version & 0xFF
-                               );
-       
-       // Call Initialiser
-       //if( info->Init( ArgString ) != 0 )
-       if( info->Init( NULL ) == 0 )
+       // Initialise (and register)
+       if( Module_int_Initialise( info, ArgString ) )
        {
                Binary_Unload(base);
                return 0;
        }
        
-       // Add to list
-       LOCK( &giModuleSpinlock );
-       info->Next = gLoadedModules;
-       gLoadedModules = info;
-       RELEASE( &giModuleSpinlock );
-       
        return 1;
 }
 
@@ -275,14 +398,14 @@ int Module_LoadFile(char *Path, char *ArgString)
  */
 int Module_int_ResolveDeps(tModule *Info)
 {
-       char    **names = Info->Dependencies;
+       const char      **names = Info->Dependencies;
        
        // Walk dependencies array
        for( ; *names; names++ )
        {
                // Check if the module is loaded
                if( !Module_IsLoaded(*names) ) {
-                       Warning("Module `%s' requires `%s', which is not loaded\n", Info->Name, *names);
+                       Log_Warning("Module", "Module `%s' requires `%s', which is not loaded\n", Info->Name, *names);
                        return 0;
                }
        }
@@ -290,11 +413,11 @@ int Module_int_ResolveDeps(tModule *Info)
 }
 
 /**
- * \fn int Module_IsLoaded(char *Name)
+ * \fn int Module_IsLoaded(const char *Name)
  * \brief Checks if a module is loaded
  * \param Name Name of module to find
  */
-int Module_IsLoaded(char *Name)
+int Module_IsLoaded(const char *Name)
 {
        tModule *mod = gLoadedModules;
        
@@ -308,3 +431,19 @@ int Module_IsLoaded(char *Name)
        // not found - return false
        return 0;
 }
+
+/**
+ * \brief Load a module if needed
+ */
+int Module_EnsureLoaded(const char *Name)
+{
+       if( Module_IsLoaded(Name) )
+               return 0;
+
+       if( Modules_InitialiseBuiltin(Name) == 0 )
+               return 0;
+
+       // TODO: Load from a file?
+
+       return -1;
+}

UCC git Repository :: git.ucc.asn.au