X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Fmodules.c;h=98ca1a1eb43e40490214757dc73e28e4133d37c1;hb=a2495c6ea4f4cab16b5d339ae511428e92e89e73;hp=71d76d4cee14c7e6d611ad2c1255ebb7a6f1aa61;hpb=3c777e58e6baba6760f43b8fdde4daf62081048b;p=tpg%2Facess2.git

diff --git a/Kernel/modules.c b/Kernel/modules.c
index 71d76d4c..98ca1a1e 100644
--- a/Kernel/modules.c
+++ b/Kernel/modules.c
@@ -2,105 +2,320 @@
  * Acess2
  * - Module Loader
  */
-#include <common.h>
+#define DEBUG	0
+#include <acess.h>
 #include <modules.h>
 
+#define	USE_EDI	0
+#define	USE_UDI	0
+
 // === PROTOTYPES ===
- 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 ===
-extern void	StartupPrint(char *Str);
-extern tModule	gKernelModules[];
-extern void	gKernelModulesEnd;
+#if USE_UDI
+extern int	UDI_LoadDriver(void *Base);
+#endif
+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 Modules_LoadBuiltins()
+/**
+ * \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, k;
-	 int	numToInit = 0;
-	Uint8	*baIsLoaded;
-	char	**deps;
+	 int	i, j;
+	 int	ret;
+	const char	**deps;
+	char	**args;
+	tModule	*mod;
 	
-	giNumBuiltinModules = (Uint)&gKernelModulesEnd - (Uint)&gKernelModules;
-	giNumBuiltinModules /= sizeof(tModule);
+	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
+			);
+	}
 	
-	baIsLoaded = calloc( giNumBuiltinModules, sizeof(*baIsLoaded) );
+	deps = Module->Dependencies;
 	
-	// Pass 1 - Are the dependencies compiled in?
-	for( i = 0; i < giNumBuiltinModules; i++ )
+	// Check if the module has been loaded
+	for( mod = gLoadedModules; mod; mod = mod->Next )
 	{
-		deps = gKernelModules[i].Dependencies;
-		if(deps)
+		if(mod == Module)	LEAVE_RET('i', 0);
+	}
+	
+	// Add to the "loading" (prevents circular deps)
+	Module->Next = gLoadingModules;
+	gLoadingModules = Module;
+	
+	// Scan dependency list
+	for( j = 0; deps && deps[j]; j++ )
+	{
+		// Check if the module is already loaded
+		for( mod = gLoadedModules; mod; mod = mod->Next )
 		{
-			for( j = 0; deps[j]; j++ )
-			{
-				for( k = 0; k < giNumBuiltinModules; k++ ) {
-					if(strcmp(deps[j], gKernelModules[k].Name) == 0)
-						break;
-				}
-				if(k == giNumBuiltinModules) {
-					Warning("Unable to find dependency '%s' for '%s' in kernel",
-						deps[j], gKernelModules[i].Name);
-					
-					baIsLoaded[i] = -1;	// Don't Load
-					break;
-				}
-			}
+			if(strcmp(deps[j], mod->Name) == 0)
+				break;
+		}
+		if( mod )	continue;	// Dependency is loaded, check the rest
+		
+		// Ok, check if it's loading
+		for( mod = gLoadingModules->Next; mod; mod = mod->Next )
+		{
+			if(strcmp(deps[j], mod->Name) == 0)
+				break;
+		}
+		if( mod ) {
+			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], gapBuiltinModules[i]->Name) == 0 )
+				break;
+		}
+		if( i == giNumBuiltinModules ) {
+			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(
+			gapBuiltinModules[i],
+			gasBuiltinModuleArgs ? gasBuiltinModuleArgs[i] : NULL
+			);
+		if( ret )
+		{
+			// The only "ok" error is NOTNEEDED
+			if(ret != MODULE_ERR_NOTNEEDED)
+				LEAVE_RET('i', -1);
 		}
-		numToInit ++;
 	}
 	
-	// Pass 2 - Intialise
-	while(numToInit)
-	{
-		for( i = 0; i < giNumBuiltinModules; i++ )
+	// All Dependencies OK? Initialise
+	StartupPrint(Module->Name);
+	Log_Log("Module", "Starting %p '%s' v%i.%i",
+		Module, Module->Name,
+		Module->Version >> 8, Module->Version & 0xFF
+		);
+	
+	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 ) {
+		switch(ret)
 		{
-			if( baIsLoaded[i] )	continue;	// Ignore already loaded modules
-			
-			if( deps )
-			{
-				for( j = 0; deps[j]; j++ )
-				{
-					for( k = 0; k < giNumBuiltinModules; k++ ) {
-						if(strcmp(deps[j], gKernelModules[k].Name) == 0)
-							break;
-					}
-					// `k` is assumed to be less than `giNumBuiltinModules`
-					
-					// If a dependency failed, skip and mark as failed
-					if( baIsLoaded[k] == -1 ) {
-						baIsLoaded[i] = -1;
-						numToInit --;
-						break;
-					}
-					// If a dependency is not intialised, skip
-					if( !baIsLoaded[k] )	break;
-				}
-				// Check if we broke out
-				if( deps[j] )	continue;
-			}
-			
-			// All Dependencies OK? Initialise
-			StartupPrint(gKernelModules[i].Name);
-			Log("Initialising %p '%s' v%i.%i...",
-				&gKernelModules[i],
-				gKernelModules[i].Name,
-				gKernelModules[i].Version>>8, gKernelModules[i].Version & 0xFF
+		case MODULE_ERR_MISC:
+			Log_Warning("Module", "Unable to load, reason: Miscelanious");
+			break;
+		case MODULE_ERR_NOTNEEDED:
+			Log_Debug("Module", "Unable to load, reason: Module not needed");
+			break;
+		case MODULE_ERR_MALLOC:
+			Log_Warning("Module", "Unable to load, reason: Error in malloc/realloc/calloc, probably not good");
+			break;
+		default:
+			Log_Warning("Module", "Unable to load reason - Unknown code %i", ret);
+			break;
+		}
+		LEAVE_RET('i', ret);
+		return ret;
+	}
+	LOG("ret = %i", ret);
+	
+	// Add to loaded list
+	SHORTLOCK( &glModuleSpinlock );
+	Module->Next = gLoadedModules;
+	gLoadedModules = Module;
+	SHORTREL( &glModuleSpinlock );
+	
+	LEAVE_RET('i', 0);
+}
+
+/**
+ * \brief Scans the builtin modules and creates an array of them
+ */
+void Modules_int_GetBuiltinArray(void)
+{
+	 int	i;
+	tModule	*module;
+	
+	// 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(
+			gapBuiltinModules[i],
+			(gasBuiltinModuleArgs ? gasBuiltinModuleArgs[i] : NULL)
+			);
+	}
+	
+	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)
 				);
-			gKernelModules[i].Init(NULL);
-			// Mark as loaded
-			baIsLoaded[i] = 1;
-			numToInit --;
 		}
 	}
+	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);
+}
+
+/**
+ * \brief Registers a tModuleLoader with the kernel
+ * \param Loader	Pointer to loader structure (must be persistent)
+ */
+int Module_RegisterLoader(tModuleLoader *Loader)
+{
+	if(!Loader)	return 1;
+	
+	Loader->Next = gModule_Loaders;
+	gModule_Loaders = Loader;
 	
 	return 0;
 }
@@ -109,20 +324,20 @@ int Modules_LoadBuiltins()
  * \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];
 	
-	VFS_GetMemPath(Buffer, Length, path);
+	VFS_GetMemPath(path, Buffer, Length);
 	
 	return Module_LoadFile( path, 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;
@@ -131,16 +346,26 @@ int Module_LoadFile(char *Path, char *ArgString)
 	base = Binary_LoadKernel(Path);
 	
 	// Error check
-	if(base == NULL)	return 0;
+	if(base == NULL) {
+		Log_Warning("Module", "Module_LoadFile - Unable to load '%s'", Path);
+		return 0;
+	}
 	
 	// Check for Acess Driver
 	if( Binary_FindSymbol(base, "DriverInfo", (Uint*)&info ) == 0 )
 	{
+		tModuleLoader	*tmp;
+		for( tmp = gModule_Loaders; tmp; tmp = tmp->Next)
+		{
+			if( tmp->Detector(base) == 0 )	continue;
+			
+			return tmp->Loader(base);
+		}
+		
 		#if USE_EDI
 		// Check for EDI Driver
-		if( Binary_FindSymbol(base, "driver_init", NULL ) == 0 )
+		if( Binary_FindSymbol(base, "driver_init", NULL ) != 0 )
 		{
-			Binary_Relocate(base);	// Relocate
 			return Module_InitEDI( base );	// And intialise
 		}
 		#endif
@@ -148,47 +373,20 @@ int Module_LoadFile(char *Path, char *ArgString)
 		// Unknown module type?, return error
 		Binary_Unload(base);
 		#if USE_EDI
-		Warning("Module_LoadMem: 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_LoadMem: 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_LoadMem: 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_LoadMem: Module is for a different architecture");
-		return 0;
-	}
-	
-	// Resolve Dependencies
-	if( !Module_int_ResolveDeps(info) ) {
-		Binary_Unload(base);
-		return 0;
-	}
-	
-	// 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;
 }
 
@@ -200,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;
 		}
 	}
@@ -215,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;
 	
@@ -233,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;
+}