kernel: move InitModuleState etc. to StructInitInfo

This will eventually make it possible for kernel extensions to also define
their own module state, for use in HPC-GAP.

src/code.c

@@ -3369,11 +3369,11 @@ static StructInitInfo module = {
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
     .preSave = PreSave,
-    .postRestore = PostRestore
+    .postRestore = PostRestore,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoCode ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/cyclotom.c

@@ -2277,10 +2277,13 @@ static StructInitInfo module = {
     .name = "cyclotom",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(struct CycModuleState),
+    .moduleStateOffsetPtr = &CycStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoCyc ( void )
 {
-    CycStateOffset = RegisterModuleState(sizeof(struct CycModuleState), InitModuleState, 0);
     return &module;
 }

src/funcs.c

@@ -1193,10 +1193,13 @@ static StructInitInfo module = {
     .name = "funcs",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(struct FuncsModuleState),
+    .moduleStateOffsetPtr = &FuncsStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoFuncs ( void )
 {
-    FuncsStateOffset = RegisterModuleState(sizeof(struct FuncsModuleState), InitModuleState, 0);
     return &module;
 }

src/gvars.c

@@ -1778,11 +1778,11 @@ static StructInitInfo module = {
     .checkInit = CheckInit,
     .preSave = PreSave,
     .postSave = PostSave,
-    .postRestore = PostRestore
+    .postRestore = PostRestore,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoGVars ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/hpc/aobjects.c

@@ -2075,10 +2075,11 @@ static StructInitInfo module = {
     .name = "aobjects",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+    .initModuleState = InitAObjectsState,
+    .destroyModuleState = DestroyAObjectsState,
 };
 
 StructInitInfo * InitInfoAObjects ( void )
 {
-    RegisterModuleState(0, InitAObjectsState, DestroyAObjectsState);
     return &module;
 }

src/hpc/serialize.c

@@ -1201,12 +1201,13 @@ static StructInitInfo module = {
     .name = "serialize",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(SerializeModuleState),
+    .moduleStateOffsetPtr = &SerializeStateOffset,
 };
 
 StructInitInfo * InitInfoSerialize(void)
 {
-    SerializeStateOffset =
-        RegisterModuleState(sizeof(SerializeModuleState), 0, 0);
     return &module;
 }
 

src/io.c

@@ -2142,10 +2142,12 @@ static StructInitInfo module = {
     .name = "scanner",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(struct IOModuleState),
+    .moduleStateOffsetPtr = &IOStateOffset,
 };
 
 StructInitInfo * InitInfoIO ( void )
 {
-    IOStateOffset = RegisterModuleState(sizeof(struct IOModuleState), 0, 0);
     return &module;
 }

src/modules.c

@@ -869,6 +869,16 @@ void ModulesSetup(void)
             FPUTS_TO_STDERR(info->name);
             FPUTS_TO_STDERR(")\n");
         }
+
+        // register module state if necessary
+        if (info->moduleStateSize || info->initModuleState ||
+            info->destroyModuleState) {
+            UInt offset = RegisterModuleState(info->moduleStateSize,
+                                              info->initModuleState,
+                                              info->destroyModuleState);
+            if (info->moduleStateOffsetPtr)
+                *info->moduleStateOffsetPtr = offset;
+        }
     }
     NrBuiltinModules = NrModules;
 }

src/modules.h

@@ -40,7 +40,7 @@
 **
 */
 
-#define GAP_KERNEL_MAJOR_VERSION 2
+#define GAP_KERNEL_MAJOR_VERSION 3
 #define GAP_KERNEL_MINOR_VERSION 0
 #define GAP_KERNEL_API_VERSION                                               \
     ((GAP_KERNEL_MAJOR_VERSION)*1000 + (GAP_KERNEL_MINOR_VERSION))
@@ -114,6 +114,19 @@ struct init_info {
     /* function to call after restoring workspace                          */
     Int (*postRestore)(StructInitInfo *);
 
+    // number of bytes this module needs for its per-thread module state
+    UInt moduleStateSize;
+
+    // if this is not zero, then the module state offset is stored into
+    // the address this points at
+    Int * moduleStateOffsetPtr;
+
+    // initialize thread local module state
+    Int (*initModuleState)(void);
+
+    // destroy thread local module state
+    Int (*destroyModuleState)(void);
+
 };
 
 

src/objcftl.c

@@ -445,11 +445,14 @@ static StructInitInfo module = {
     .name = "objcftl",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
-    .postRestore = PostRestore
+    .postRestore = PostRestore,
+
+    .moduleStateSize = sizeof(struct CFTLModuleState),
+    .moduleStateOffsetPtr = &CFTLStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoPcc ( void )
 {
-    CFTLStateOffset = RegisterModuleState(sizeof(struct CFTLModuleState), InitModuleState, 0);
     return &module;
 }

src/objects.c

@@ -2315,10 +2315,12 @@ static StructInitInfo module = {
     .name = "objects",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(ObjectsModuleState),
+    .moduleStateOffsetPtr = &ObjectsStateOffset,
 };
 
 StructInitInfo * InitInfoObjects ( void )
 {
-    ObjectsStateOffset = RegisterModuleState(sizeof(ObjectsModuleState), 0, 0);
     return &module;
 }

src/objscoll.c

@@ -833,10 +833,10 @@ static StructInitInfo module = {
     .name = "objscoll",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoSingleCollector ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/opers.c

@@ -4264,11 +4264,11 @@ static StructInitInfo module = {
     .name = "opers",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
-    .postRestore = postRestore
+    .postRestore = postRestore,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoOpers ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/permutat.c

@@ -4574,10 +4574,13 @@ static StructInitInfo module = {
     .name = "permutat",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(PermutatModuleState),
+    .moduleStateOffsetPtr = &PermutatStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoPermutat ( void )
 {
-    PermutatStateOffset = RegisterModuleState(sizeof(PermutatModuleState), InitModuleState, 0);
     return &module;
 }

src/pperm.c

@@ -6728,11 +6728,13 @@ static StructInitInfo module = {
     .name = "pperm",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+
+    .moduleStateSize = sizeof(PPermModuleState),
+    .moduleStateOffsetPtr = &PPermStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoPPerm(void)
 {
-    PPermStateOffset =
-        RegisterModuleState(sizeof(PPermModuleState), InitModuleState, 0);
     return &module;
 }

src/read.c

@@ -2948,10 +2948,10 @@ static StructInitInfo module = {
     .type = MODULE_BUILTIN,
     .name = "read",
     .initKernel = InitKernel,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoRead ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/stats.c

@@ -1740,10 +1740,10 @@ static StructInitInfo module = {
     .name = "stats",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoStats ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }

src/trans.c

@@ -5688,10 +5688,12 @@ static StructInitInfo module = {
     .name = "trans",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
+    .moduleStateSize = sizeof(TransModuleState),
+    .moduleStateOffsetPtr = &TransStateOffset,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoTrans(void)
 {
-    TransStateOffset = RegisterModuleState(sizeof(TransModuleState), InitModuleState, 0);
     return &module;
 }

src/vars.c

@@ -2795,11 +2795,11 @@ static StructInitInfo module = {
     .name = "vars",
     .initKernel = InitKernel,
     .initLibrary = InitLibrary,
-    .postRestore = PostRestore
+    .postRestore = PostRestore,
+    .initModuleState = InitModuleState,
 };
 
 StructInitInfo * InitInfoVars ( void )
 {
-    RegisterModuleState(0, InitModuleState, 0);
     return &module;
 }