LBANN  0.103.0
LivermoreBigArtificialNeuralNetworkToolkit
system_info.hpp
Go to the documentation of this file.
1 // Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
3 // Produced at the Lawrence Livermore National Laboratory.
4 // Written by the LBANN Research Team (B. Van Essen, et al.) listed in
5 // the CONTRIBUTORS file. <lbann-dev@llnl.gov>
6 //
7 // LLNL-CODE-697807.
8 // All rights reserved.
9 //
10 // This file is part of LBANN: Livermore Big Artificial Neural Network
11 // Toolkit. For details, see http://software.llnl.gov/LBANN or
12 // https://github.com/LLNL/LBANN.
13 //
14 // Licensed under the Apache License, Version 2.0 (the "Licensee"); you
15 // may not use this file except in compliance with the License. You may
16 // obtain a copy of the License at:
17 //
18 // http://www.apache.org/licenses/LICENSE-2.0
19 //
20 // Unless required by applicable law or agreed to in writing, software
21 // distributed under the License is distributed on an "AS IS" BASIS,
22 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
23 // implied. See the License for the specific language governing
24 // permissions and limitations under the license.
26 
27 #ifndef LBANN_UTILS_SYSTEM_INFO_HPP_INCLUDED
28 #define LBANN_UTILS_SYSTEM_INFO_HPP_INCLUDED
29 
30 #include <string>
31 
32 namespace lbann {
33 namespace utils {
34 
43 {
44 public:
46  virtual ~SystemInfo() noexcept = default;
47 
54  virtual std::string pid() const;
55 
57  virtual std::string host_name() const;
58 
66  virtual int mpi_rank() const;
67 
76  virtual int mpi_size() const;
77 
82  virtual std::string env_variable_value(std::string const& var_name) const;
83 };
84 
85 } // namespace utils
86 } // namespace lbann
87 #endif // LBANN_UTILS_SYSTEM_INFO_HPP_INCLUDED
virtual std::string pid() const
Get the current process ID.
virtual int mpi_size() const
Get the size of the MPI universe in which this process is participating.
virtual std::string host_name() const
Get the host name for this process.
Query basic system information.
Definition: system_info.hpp:42
virtual ~SystemInfo() noexcept=default
Virtual destructor.
virtual int mpi_rank() const
Get the MPI rank of this process.
virtual std::string env_variable_value(std::string const &var_name) const
Get the value of the given variable from the environment.