XEngine: make calls to gc.collect on region startup scripts loading a configurable option, since it is very slow operation

2 files changed, 24 insertions, 8 deletions

diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 4b83751..dce32bf 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -925,6 +925,13 @@
     ;; by scripts have changed.
     ; DeleteScriptsOnStartup = true
 
+    ;# {CompactMemOnLoad} {} {compacts memory on each script load at startup?} {true false} false
+    ;; forces calls to memory garbage collector before loading each script DLL during region startup.
+    ;; Peek memory usage is reduced and region starts with a more compacted memory allocation.
+    ;; But this costs a lot of time, so region load will take a lot longer.
+    ;; it is more usefull if there are no previously compiled scripts DLLs (as with DeleteScriptsOnStartup = true)
+    ;CompactMemOnLoad = false
+    
     ;# {DefaultCompileLanguage} {Enabled:true} {Default script language?} {lsl vb cs} lsl
     ;; Default language for scripts
     ; DefaultCompileLanguage = "lsl"
diff --git a/bin/OpenSimDefaults.ini b/bin/OpenSimDefaults.ini
index e846e73..cb320a2 100644
--- a/bin/OpenSimDefaults.ini
+++ b/bin/OpenSimDefaults.ini
@@ -1696,14 +1696,23 @@
     ; this may only be a problem if regions stay alive for a long time with lots of scripts added or edited.
     ; at this time some mono versions seem to have problems with the true option
     ; so default is now false until a fix is found
-    AppDomainLoading = false
-
-    ; Controls whether previously compiled scripts DLLs are deleted on sim restart. If you set this to false
-    ; then startup will be considerably faster since scripts won't need to be recompiled. However, then it becomes your responsibility to delete the 
-    ; compiled scripts if you're recompiling OpenSim from source code and internal interfaces used
-    ; by scripts have changed.
-    ; DeleteScriptsOnStartup = false
-
+    ; AppDomainLoading = false
+
+    ; Controls whether previously compiled scripts DLLs are deleted on sim restart.
+    ; If you set this to false then startup will be considerably faster since scripts won't need to be recompiled.
+    ; It should be true on first run after updating opensim binary version
+    ; after first run you can change to false.
+    ; You can also set it to false and delete the script DLLs by hand
+    ; This does not delete cached scripts state.
+    ; DeleteScriptsOnStartup = true
+
+    ; CompactMemOnLoad forces calls to memory garbage collector before loading each script binary
+    ; forces calls to memory garbage collector before loading each script DLL during region startup.
+    ; Peek memory usage is reduced and region starts with a more compacted memory allocation.
+    ; But this costs a lot of time, so region load will take a lot longer.
+    ; it is more usefull if there are no previously compiled scripts DLLs (or DeleteScriptsOnStartup = true)
+    ; CompactMemOnLoad = false
+    
     ; Controls whether scripts are stopped by aborting their threads externally (abort) 
     ; or by co-operative checks inserted by OpenSimulator into compiled script (co-op).
     ; co-op will be more stable as aborting threads can cause instability.