Add cmake_host_system_information command

Expose the internal system information API to the CMake language.  For
example, it is useful to see how much memory the system has available to
estimate an upper limit of tests that can run in parallel.

1 files changed, 126 insertions, 0 deletions

diff --git a/Source/cmCMakeHostSystemInformationCommand.cxx b/Source/cmCMakeHostSystemInformationCommand.cxx
new file mode 100644
index 0000000..62f2383
--- /dev/null
+++ b/Source/cmCMakeHostSystemInformationCommand.cxx
@@ -0,0 +1,126 @@
+/*============================================================================
+  CMake - Cross Platform Makefile Generator
+  Copyright 2013 Kitware, Inc., Insight Software Consortium
+
+  Distributed under the OSI-approved BSD License (the "License");
+  see accompanying file Copyright.txt for details.
+
+  This software is distributed WITHOUT ANY WARRANTY; without even the
+  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the License for more information.
+============================================================================*/
+#include "cmCMakeHostSystemInformationCommand.h"
+
+#include <cmsys/ios/sstream>
+
+// cmCMakeHostSystemInformation
+bool cmCMakeHostSystemInformationCommand
+::InitialPass(std::vector<std::string> const &args, cmExecutionStatus &)
+{
+  size_t current_index = 0;
+
+  if(args.size() < (current_index + 2) || args[current_index] != "RESULT")
+    {
+    this->SetError("missing RESULT specification.");
+    return false;
+    }
+
+  std::string variable = args[current_index + 1];
+  current_index += 2;
+
+  if(args.size() < (current_index + 2) || args[current_index] != "QUERY")
+    {
+    this->SetError("missing QUERY specification");
+    return false;
+    }
+
+  cmsys::SystemInformation info;
+  info.RunCPUCheck();
+  info.RunOSCheck();
+  info.RunMemoryCheck();
+
+  std::string result_list;
+  for(size_t i = current_index + 1; i < args.size(); ++i)
+    {
+    std::string key = args[i];
+    if(i != current_index + 1)
+      {
+      result_list += ";";
+      }
+    std::string value;
+    if(!this->GetValue(info, key, value)) return false;
+
+    result_list += value;
+    }
+
+  this->Makefile->AddDefinition(variable.c_str(), result_list.c_str());
+
+  return true;
+}
+
+bool cmCMakeHostSystemInformationCommand
+::GetValue(cmsys::SystemInformation &info,
+           std::string const& key, std::string &value)
+{
+  if(key == "NUMBER_OF_LOGICAL_CORES")
+    {
+    value = this->ValueToString(info.GetNumberOfLogicalCPU());
+    }
+  else if(key == "NUMBER_OF_PHYSICAL_CORES")
+    {
+    value = this->ValueToString(info.GetNumberOfPhysicalCPU());
+    }
+  else if(key == "HOSTNAME")
+    {
+    value = this->ValueToString(info.GetHostname());
+    }
+  else if(key == "FQDN")
+    {
+    value = this->ValueToString(info.GetFullyQualifiedDomainName());
+    }
+  else if(key == "TOTAL_VIRTUAL_MEMORY")
+    {
+    value = this->ValueToString(info.GetTotalVirtualMemory());
+    }
+  else if(key == "AVAILABLE_VIRTUAL_MEMORY")
+    {
+    value = this->ValueToString(info.GetAvailableVirtualMemory());
+    }
+  else if(key == "TOTAL_PHYSICAL_MEMORY")
+    {
+    value = this->ValueToString(info.GetTotalPhysicalMemory());
+    }
+  else if(key == "AVAILABLE_PHYSICAL_MEMORY")
+    {
+    value = this->ValueToString(info.GetAvailablePhysicalMemory());
+    }
+  else
+    {
+    std::string e = "does not recognize <key> " + key;
+    this->SetError(e.c_str());
+    return false;
+    }
+
+  return true;
+}
+
+std::string cmCMakeHostSystemInformationCommand
+::ValueToString(size_t value) const
+{
+  cmsys_ios::stringstream tmp;
+  tmp << value;
+  return tmp.str();
+}
+
+std::string cmCMakeHostSystemInformationCommand
+::ValueToString(const char *value) const
+{
+  std::string safe_string = value ? value : "";
+  return safe_string;
+}
+
+std::string cmCMakeHostSystemInformationCommand
+::ValueToString(std::string const& value) const
+{
+  return value;
+}