1
0

Application.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.IO;
  29. using System.Net;
  30. using System.Reflection;
  31. using log4net;
  32. using log4net.Config;
  33. using Nini.Config;
  34. using OpenSim.Framework;
  35. using OpenSim.Framework.Console;
  36. namespace OpenSim
  37. {
  38. /// <summary>
  39. /// Starting class for the OpenSimulator Region
  40. /// </summary>
  41. public class Application
  42. {
  43. /// <summary>
  44. /// Text Console Logger
  45. /// </summary>
  46. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  47. /// <summary>
  48. /// Path to the main ini Configuration file
  49. /// </summary>
  50. public static string iniFilePath = "";
  51. /// <summary>
  52. /// Save Crashes in the bin/crashes folder. Configurable with m_crashDir
  53. /// </summary>
  54. public static bool m_saveCrashDumps = false;
  55. /// <summary>
  56. /// Directory to save crash reports to. Relative to bin/
  57. /// </summary>
  58. public static string m_crashDir = "crashes";
  59. /// <summary>
  60. /// Instance of the OpenSim class. This could be OpenSim or OpenSimBackground depending on the configuration
  61. /// </summary>
  62. protected static OpenSimBase m_sim = null;
  63. //could move our main function into OpenSimMain and kill this class
  64. public static void Main(string[] args)
  65. {
  66. // First line, hook the appdomain to the crash reporter
  67. AppDomain.CurrentDomain.UnhandledException +=
  68. new UnhandledExceptionEventHandler(CurrentDomain_UnhandledException);
  69. ServicePointManager.DefaultConnectionLimit = 12;
  70. // Add the arguments supplied when running the application to the configuration
  71. ArgvConfigSource configSource = new ArgvConfigSource(args);
  72. // Configure Log4Net
  73. configSource.AddSwitch("Startup", "logconfig");
  74. string logConfigFile = configSource.Configs["Startup"].GetString("logconfig", String.Empty);
  75. if (logConfigFile != String.Empty)
  76. {
  77. XmlConfigurator.Configure(new System.IO.FileInfo(logConfigFile));
  78. m_log.InfoFormat("[OPENSIM MAIN]: configured log4net using \"{0}\" as configuration file",
  79. logConfigFile);
  80. }
  81. else
  82. {
  83. XmlConfigurator.Configure();
  84. m_log.Info("[OPENSIM MAIN]: configured log4net using default OpenSim.exe.config");
  85. }
  86. m_log.InfoFormat(
  87. "[OPENSIM MAIN]: System Locale is {0}", System.Threading.Thread.CurrentThread.CurrentCulture);
  88. string monoThreadsPerCpu = System.Environment.GetEnvironmentVariable("MONO_THREADS_PER_CPU");
  89. m_log.InfoFormat(
  90. "[OPENSIM MAIN]: Environment variable MONO_THREADS_PER_CPU is {0}", monoThreadsPerCpu ?? "unset");
  91. // Verify the Threadpool allocates or uses enough worker and IO completion threads
  92. // .NET 2.0, workerthreads default to 50 * numcores
  93. // .NET 3.0, workerthreads defaults to 250 * numcores
  94. // .NET 4.0, workerthreads are dynamic based on bitness and OS resources
  95. // Max IO Completion threads are 1000 on all 3 CLRs
  96. //
  97. // Mono 2.10.9 to at least Mono 3.1, workerthreads default to 100 * numcores, iocp threads to 4 * numcores
  98. int workerThreadsMin = 500;
  99. int workerThreadsMax = 1000; // may need further adjustment to match other CLR
  100. int iocpThreadsMin = 1000;
  101. int iocpThreadsMax = 2000; // may need further adjustment to match other CLR
  102. {
  103. int currentMinWorkerThreads, currentMinIocpThreads;
  104. System.Threading.ThreadPool.GetMinThreads(out currentMinWorkerThreads, out currentMinIocpThreads);
  105. m_log.InfoFormat(
  106. "[OPENSIM MAIN]: Runtime gave us {0} min worker threads and {1} min IOCP threads",
  107. currentMinWorkerThreads, currentMinIocpThreads);
  108. }
  109. int workerThreads, iocpThreads;
  110. System.Threading.ThreadPool.GetMaxThreads(out workerThreads, out iocpThreads);
  111. m_log.InfoFormat("[OPENSIM MAIN]: Runtime gave us {0} max worker threads and {1} max IOCP threads", workerThreads, iocpThreads);
  112. if (workerThreads < workerThreadsMin)
  113. {
  114. workerThreads = workerThreadsMin;
  115. m_log.InfoFormat("[OPENSIM MAIN]: Bumping up to max worker threads to {0}",workerThreads);
  116. }
  117. if (workerThreads > workerThreadsMax)
  118. {
  119. workerThreads = workerThreadsMax;
  120. m_log.InfoFormat("[OPENSIM MAIN]: Limiting max worker threads to {0}",workerThreads);
  121. }
  122. // Increase the number of IOCP threads available.
  123. // Mono defaults to a tragically low number (24 on 6-core / 8GB Fedora 17)
  124. if (iocpThreads < iocpThreadsMin)
  125. {
  126. iocpThreads = iocpThreadsMin;
  127. m_log.InfoFormat("[OPENSIM MAIN]: Bumping up max IOCP threads to {0}",iocpThreads);
  128. }
  129. // Make sure we don't overallocate IOCP threads and thrash system resources
  130. if ( iocpThreads > iocpThreadsMax )
  131. {
  132. iocpThreads = iocpThreadsMax;
  133. m_log.InfoFormat("[OPENSIM MAIN]: Limiting max IOCP completion threads to {0}",iocpThreads);
  134. }
  135. // set the resulting worker and IO completion thread counts back to ThreadPool
  136. if ( System.Threading.ThreadPool.SetMaxThreads(workerThreads, iocpThreads) )
  137. {
  138. m_log.InfoFormat(
  139. "[OPENSIM MAIN]: Threadpool set to {0} max worker threads and {1} max IOCP threads",
  140. workerThreads, iocpThreads);
  141. }
  142. else
  143. {
  144. m_log.Warn("[OPENSIM MAIN]: Threadpool reconfiguration failed, runtime defaults still in effect.");
  145. }
  146. // Check if the system is compatible with OpenSimulator.
  147. // Ensures that the minimum system requirements are met
  148. string supported = String.Empty;
  149. if (Util.IsEnvironmentSupported(ref supported))
  150. {
  151. m_log.Info("[OPENSIM MAIN]: Environment is supported by OpenSimulator.");
  152. }
  153. else
  154. {
  155. m_log.Warn("[OPENSIM MAIN]: Environment is not supported by OpenSimulator (" + supported + ")\n");
  156. }
  157. // Configure nIni aliases and localles
  158. Culture.SetCurrentCulture();
  159. // Validate that the user has the most basic configuration done
  160. // If not, offer to do the most basic configuration for them warning them along the way of the importance of
  161. // reading these files.
  162. /*
  163. m_log.Info("Checking for reguired configuration...\n");
  164. bool OpenSim_Ini = (File.Exists(Path.Combine(Util.configDir(), "OpenSim.ini")))
  165. || (File.Exists(Path.Combine(Util.configDir(), "opensim.ini")))
  166. || (File.Exists(Path.Combine(Util.configDir(), "openSim.ini")))
  167. || (File.Exists(Path.Combine(Util.configDir(), "Opensim.ini")));
  168. bool StanaloneCommon_ProperCased = File.Exists(Path.Combine(Path.Combine(Util.configDir(), "config-include"), "StandaloneCommon.ini"));
  169. bool StanaloneCommon_lowercased = File.Exists(Path.Combine(Path.Combine(Util.configDir(), "config-include"), "standalonecommon.ini"));
  170. bool GridCommon_ProperCased = File.Exists(Path.Combine(Path.Combine(Util.configDir(), "config-include"), "GridCommon.ini"));
  171. bool GridCommon_lowerCased = File.Exists(Path.Combine(Path.Combine(Util.configDir(), "config-include"), "gridcommon.ini"));
  172. if ((OpenSim_Ini)
  173. && (
  174. (StanaloneCommon_ProperCased
  175. || StanaloneCommon_lowercased
  176. || GridCommon_ProperCased
  177. || GridCommon_lowerCased
  178. )))
  179. {
  180. m_log.Info("Required Configuration Files Found\n");
  181. }
  182. else
  183. {
  184. MainConsole.Instance = new LocalConsole("Region");
  185. string resp = MainConsole.Instance.CmdPrompt(
  186. "\n\n*************Required Configuration files not found.*************\n\n OpenSimulator will not run without these files.\n\nRemember, these file names are Case Sensitive in Linux and Proper Cased.\n1. ./OpenSim.ini\nand\n2. ./config-include/StandaloneCommon.ini \nor\n3. ./config-include/GridCommon.ini\n\nAlso, you will want to examine these files in great detail because only the basic system will load by default. OpenSimulator can do a LOT more if you spend a little time going through these files.\n\n" + ": " + "Do you want to copy the most basic Defaults from standalone?",
  187. "yes");
  188. if (resp == "yes")
  189. {
  190. if (!(OpenSim_Ini))
  191. {
  192. try
  193. {
  194. File.Copy(Path.Combine(Util.configDir(), "OpenSim.ini.example"),
  195. Path.Combine(Util.configDir(), "OpenSim.ini"));
  196. } catch (UnauthorizedAccessException)
  197. {
  198. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, Make sure OpenSim has have the required permissions\n");
  199. } catch (ArgumentException)
  200. {
  201. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, The current directory is invalid.\n");
  202. } catch (System.IO.PathTooLongException)
  203. {
  204. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, the Path to these files is too long.\n");
  205. } catch (System.IO.DirectoryNotFoundException)
  206. {
  207. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, the current directory is reporting as not found.\n");
  208. } catch (System.IO.FileNotFoundException)
  209. {
  210. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, the example is not found, please make sure that the example files exist.\n");
  211. } catch (System.IO.IOException)
  212. {
  213. // Destination file exists already or a hard drive failure... .. so we can just drop this one
  214. //MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, the example is not found, please make sure that the example files exist.\n");
  215. } catch (System.NotSupportedException)
  216. {
  217. MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, The current directory is invalid.\n");
  218. }
  219. }
  220. if (!(StanaloneCommon_ProperCased || StanaloneCommon_lowercased))
  221. {
  222. try
  223. {
  224. File.Copy(Path.Combine(Path.Combine(Util.configDir(), "config-include"), "StandaloneCommon.ini.example"),
  225. Path.Combine(Path.Combine(Util.configDir(), "config-include"), "StandaloneCommon.ini"));
  226. }
  227. catch (UnauthorizedAccessException)
  228. {
  229. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, Make sure OpenSim has the required permissions\n");
  230. }
  231. catch (ArgumentException)
  232. {
  233. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, The current directory is invalid.\n");
  234. }
  235. catch (System.IO.PathTooLongException)
  236. {
  237. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, the Path to these files is too long.\n");
  238. }
  239. catch (System.IO.DirectoryNotFoundException)
  240. {
  241. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, the current directory is reporting as not found.\n");
  242. }
  243. catch (System.IO.FileNotFoundException)
  244. {
  245. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, the example is not found, please make sure that the example files exist.\n");
  246. }
  247. catch (System.IO.IOException)
  248. {
  249. // Destination file exists already or a hard drive failure... .. so we can just drop this one
  250. //MainConsole.Instance.Output("Unable to Copy OpenSim.ini.example to OpenSim.ini, the example is not found, please make sure that the example files exist.\n");
  251. }
  252. catch (System.NotSupportedException)
  253. {
  254. MainConsole.Instance.Output("Unable to Copy StandaloneCommon.ini.example to StandaloneCommon.ini, The current directory is invalid.\n");
  255. }
  256. }
  257. }
  258. MainConsole.Instance = null;
  259. }
  260. */
  261. configSource.Alias.AddAlias("On", true);
  262. configSource.Alias.AddAlias("Off", false);
  263. configSource.Alias.AddAlias("True", true);
  264. configSource.Alias.AddAlias("False", false);
  265. configSource.Alias.AddAlias("Yes", true);
  266. configSource.Alias.AddAlias("No", false);
  267. configSource.AddSwitch("Startup", "background");
  268. configSource.AddSwitch("Startup", "inifile");
  269. configSource.AddSwitch("Startup", "inimaster");
  270. configSource.AddSwitch("Startup", "inidirectory");
  271. configSource.AddSwitch("Startup", "physics");
  272. configSource.AddSwitch("Startup", "gui");
  273. configSource.AddSwitch("Startup", "console");
  274. configSource.AddSwitch("Startup", "save_crashes");
  275. configSource.AddSwitch("Startup", "crash_dir");
  276. configSource.AddConfig("StandAlone");
  277. configSource.AddConfig("Network");
  278. // Check if we're running in the background or not
  279. bool background = configSource.Configs["Startup"].GetBoolean("background", false);
  280. // Check if we're saving crashes
  281. m_saveCrashDumps = configSource.Configs["Startup"].GetBoolean("save_crashes", false);
  282. // load Crash directory config
  283. m_crashDir = configSource.Configs["Startup"].GetString("crash_dir", m_crashDir);
  284. if (background)
  285. {
  286. m_sim = new OpenSimBackground(configSource);
  287. m_sim.Startup();
  288. }
  289. else
  290. {
  291. m_sim = new OpenSim(configSource);
  292. m_sim.Startup();
  293. while (true)
  294. {
  295. try
  296. {
  297. // Block thread here for input
  298. MainConsole.Instance.Prompt();
  299. }
  300. catch (Exception e)
  301. {
  302. m_log.ErrorFormat("Command error: {0}", e);
  303. }
  304. }
  305. }
  306. }
  307. private static bool _IsHandlingException = false; // Make sure we don't go recursive on ourself
  308. /// <summary>
  309. /// Global exception handler -- all unhandlet exceptions end up here :)
  310. /// </summary>
  311. /// <param name="sender"></param>
  312. /// <param name="e"></param>
  313. private static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
  314. {
  315. if (_IsHandlingException)
  316. {
  317. return;
  318. }
  319. _IsHandlingException = true;
  320. // TODO: Add config option to allow users to turn off error reporting
  321. // TODO: Post error report (disabled for now)
  322. string msg = String.Empty;
  323. msg += "\r\n";
  324. msg += "APPLICATION EXCEPTION DETECTED: " + e.ToString() + "\r\n";
  325. msg += "\r\n";
  326. msg += "Exception: " + e.ExceptionObject.ToString() + "\r\n";
  327. Exception ex = (Exception) e.ExceptionObject;
  328. if (ex.InnerException != null)
  329. {
  330. msg += "InnerException: " + ex.InnerException.ToString() + "\r\n";
  331. }
  332. msg += "\r\n";
  333. msg += "Application is terminating: " + e.IsTerminating.ToString() + "\r\n";
  334. m_log.ErrorFormat("[APPLICATION]: {0}", msg);
  335. if (m_saveCrashDumps)
  336. {
  337. // Log exception to disk
  338. try
  339. {
  340. if (!Directory.Exists(m_crashDir))
  341. {
  342. Directory.CreateDirectory(m_crashDir);
  343. }
  344. string log = Util.GetUniqueFilename(ex.GetType() + ".txt");
  345. using (StreamWriter m_crashLog = new StreamWriter(Path.Combine(m_crashDir, log)))
  346. {
  347. m_crashLog.WriteLine(msg);
  348. }
  349. File.Copy("OpenSim.ini", Path.Combine(m_crashDir, log + "_OpenSim.ini"), true);
  350. }
  351. catch (Exception e2)
  352. {
  353. m_log.ErrorFormat("[CRASH LOGGER CRASHED]: {0}", e2);
  354. }
  355. }
  356. _IsHandlingException = false;
  357. }
  358. }
  359. }