Added the PID file process to all servers and added --pidfile

Only the user server was set up to create PID files for some reason. Now all servers create PID files, and the file they should create can be set via the --pidfile commandline flag, but will default to the pre-existing style file naming if that is not given. The various server startup processes were diverging badly, brought them back into lockstep so they can be maintained correctly.
IslandzVW · May 12, 2017 · fae1793 · fae1793
1 parent ce76b1e
commit fae1793
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 34 deletions.
diff --git a/InWorldz/Halcyon/Application.cs b/InWorldz/Halcyon/Application.cs
@@ -72,8 +72,12 @@ public static void Main(string[] args)
             ServicePointManager.DefaultConnectionLimit = 12;
 
             // Add the arguments supplied when running the application to the configuration
-            ArgvConfigSource configSource = new ArgvConfigSource(args);
+            var configSource = new ArgvConfigSource(args);
 
+            configSource.AddSwitch("Startup", "pidfile");
+            var pidFile = new PIDFileManager(configSource.Configs["Startup"].GetString("pidfile", string.Empty));
+
+            pidFile.SetStatus(PIDFileManager.Status.Starting);
             // Configure Log4Net
             configSource.AddSwitch("Startup", "logconfig");
             string logConfigFile = configSource.Configs["Startup"].GetString("logconfig", String.Empty);
@@ -136,6 +140,7 @@ public static void Main(string[] args)
             if (background)
             {
                 m_sim = new OpenSimBackground(configSource);
+                pidFile.SetStatus(PIDFileManager.Status.Running);
                 m_sim.Startup();
             }
             else
@@ -144,6 +149,7 @@ public static void Main(string[] args)
 
                 m_sim.Startup();
 
+                pidFile.SetStatus(PIDFileManager.Status.Running);
                 while (true)
                 {
                     try

diff --git a/OpenSim/Framework/PIDFileManager.cs b/OpenSim/Framework/PIDFileManager.cs
@@ -28,17 +28,14 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Diagnostics;
 using System.IO;
+using System.Text;
 
 namespace OpenSim.Framework
 {
     /// <summary>
-    /// Creates a file with this processes PID and status as processname.pid
+    /// Creates a file with this processes PID and status as the given pidfile or, if null, processname.pid
     /// </summary>
     public class PIDFileManager
     {
@@ -49,21 +46,29 @@ public enum Status
             Running
         }
 
-        public PIDFileManager()
+        public string PidFile { get; private set; }
+
+        public PIDFileManager(string pidFile)
         {
+            var thisProcess = Process.GetCurrentProcess();
+
+            PidFile = pidFile;
+            if (string.IsNullOrWhiteSpace(pidFile))
+            {
+                PidFile = $"{Path.GetFileName(thisProcess.MainModule.FileName)}.pid";
+            }
+
             this.SetStatus(Status.Init);
         }
 
         public void SetStatus(Status status)
         {
-            Process thisProcess = Process.GetCurrentProcess();
-            string pidfileName = Path.GetFileName(thisProcess.MainModule.FileName) + ".pid";
-            int pid = Process.GetCurrentProcess().Id;
+            var pid = Process.GetCurrentProcess().Id;
 
-            using (FileStream pidFile = File.OpenWrite(pidfileName))
+            using (FileStream pidFile = File.OpenWrite(PidFile))
             {
-                string pidInfo = ((int)status).ToString() + " " + pid.ToString();
-                byte[] utf8bytes = System.Text.Encoding.UTF8.GetBytes(pidInfo);
+                var pidInfo = $"{((int)status)} {pid}";
+                var utf8bytes = Encoding.UTF8.GetBytes(pidInfo);
 
                 pidFile.Write(utf8bytes, 0, utf8bytes.Length);
             }

diff --git a/OpenSim/Grid/GridServer/Program.cs b/OpenSim/Grid/GridServer/Program.cs
@@ -29,6 +29,7 @@
 using log4net.Config;
 using log4net;
 using Nini.Config;
+using OpenSim.Framework;
 
 namespace OpenSim.Grid.GridServer
 {
@@ -38,14 +39,11 @@ public static class Program
 
         public static void Main(string[] args)
         {
+            // Please note that if you are changing something in this function you should check to see if you need to change the other server's Main functions as well.
             ServicePointManager.DefaultConnectionLimit = 12;
 
-            m_log.Info("starting up");
-
-            XmlConfigurator.Configure();
-
             // Add the arguments supplied when running the application to the configuration
-            ArgvConfigSource configSource = new ArgvConfigSource(args);
+            var configSource = new ArgvConfigSource(args);
 
             configSource.Alias.AddAlias("On", true);
             configSource.Alias.AddAlias("Off", false);
@@ -55,22 +53,32 @@ public static void Main(string[] args)
             configSource.Alias.AddAlias("No", false);
 
             configSource.AddSwitch("Startup", "background");
+            configSource.AddSwitch("Startup", "pidfile");
+
+            m_log.Info("[SERVER]: Launching GridServer...");
+
+            var pidFile = new PIDFileManager(configSource.Configs["Startup"].GetString("pidfile", string.Empty));
+            XmlConfigurator.Configure();
 
             bool background = configSource.Configs["Startup"].GetBoolean("background", false);
 
+            GridServerBase app;
             if (background)
             {
                 m_log.Info("[GridServer MAIN]: set to background");
-                GridServerBackground app = new GridServerBackground();
-                app.Startup();
-                app.Work();
+                app = new GridServerBackground();
             }
-            else {
+            else
+            {
                 m_log.Info("[GridServer MAIN]: set to foreground");
-                GridServerBase app = new GridServerBase();
-                app.Startup();
-                app.Work();
+                app = new GridServerBase();
             }
+
+            pidFile.SetStatus(PIDFileManager.Status.Starting);
+            app.Startup();
+
+            pidFile.SetStatus(PIDFileManager.Status.Running);
+            app.Work();
         }
     }
 }
diff --git a/OpenSim/Grid/MessagingServer/Main.cs b/OpenSim/Grid/MessagingServer/Main.cs
@@ -69,24 +69,33 @@ public class OpenMessage_Main : BaseOpenSimServer, IGridServiceCore
 
         public static void Main(string[] args)
         {
+            // Please note that if you are changing something in this function you should check to see if you need to change the other server's Main functions as well.
             ServicePointManager.DefaultConnectionLimit = 12;
 
-            XmlConfigurator.Configure();
+            // Add the arguments supplied when running the application to the configuration
+            var configSource = new ArgvConfigSource(args);
 
-            ArgvConfigSource configSource = new ArgvConfigSource(args);
             configSource.Alias.AddAlias("On", true);
             configSource.Alias.AddAlias("Off", false);
             configSource.Alias.AddAlias("True", true);
             configSource.Alias.AddAlias("False", false);
             configSource.Alias.AddAlias("Yes", true);
             configSource.Alias.AddAlias("No", false);
+
             configSource.AddSwitch("Startup", "background");
+            configSource.AddSwitch("Startup", "pidfile");
 
             m_log.Info("[SERVER]: Launching MessagingServer...");
 
+            var pidFile = new PIDFileManager(configSource.Configs["Startup"].GetString("pidfile", string.Empty));
+            XmlConfigurator.Configure();
+
             OpenMessage_Main messageserver = new OpenMessage_Main();
 
+            pidFile.SetStatus(PIDFileManager.Status.Starting);
             messageserver.Startup();
+
+            pidFile.SetStatus(PIDFileManager.Status.Running);
             messageserver.Work(configSource.Configs["Startup"].GetBoolean("background", false));
         }
 
@@ -103,7 +112,8 @@ private void Work(bool background)
                 Terminating.WaitOne();
                 Terminating.Close();
             }
-            else {
+            else
+            {
                 m_console.Notice("Enter help for a list of commands\n");
 
                 while (true)

diff --git a/OpenSim/Grid/UserServer/Main.cs b/OpenSim/Grid/UserServer/Main.cs
@@ -87,23 +87,28 @@ public class OpenUser_Main : BaseOpenSimServer, IGridServiceCore
 
         public static void Main(string[] args)
         {
+            // Please note that if you are changing something in this function you should check to see if you need to change the other server's Main functions as well.
             ServicePointManager.DefaultConnectionLimit = 12;
 
-            var pidFile = new PIDFileManager();
-            XmlConfigurator.Configure();
+            // Add the arguments supplied when running the application to the configuration
+            var configSource = new ArgvConfigSource(args);
 
-            ArgvConfigSource configSource = new ArgvConfigSource(args);
             configSource.Alias.AddAlias("On", true);
             configSource.Alias.AddAlias("Off", false);
             configSource.Alias.AddAlias("True", true);
             configSource.Alias.AddAlias("False", false);
             configSource.Alias.AddAlias("Yes", true);
             configSource.Alias.AddAlias("No", false);
+
             configSource.AddSwitch("Startup", "background");
+            configSource.AddSwitch("Startup", "pidfile");
 
-            m_log.Info("Launching UserServer...");
+            m_log.Info("[SERVER]: Launching UserServer...");
 
-            OpenUser_Main userserver = new OpenUser_Main();
+            var pidFile = new PIDFileManager(configSource.Configs["Startup"].GetString("pidfile", string.Empty));
+            XmlConfigurator.Configure();
+
+            var userserver = new OpenUser_Main();
 
             pidFile.SetStatus(PIDFileManager.Status.Starting);
             userserver.Startup();
@@ -125,7 +130,8 @@ public void Work(bool background)
                 Terminating.WaitOne();
                 Terminating.Close();
             }
-            else {
+            else
+            {
                 m_console.Notice("Enter help for a list of commands\n");
 
                 while (true)