kernel_manager.h

Go to the documentation of this file.

/*
 *  kernel_manager.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef KERNEL_MANAGER_H
#define KERNEL_MANAGER_H
 
// Includes from libnestutil
#include "config.h"
 
// Includes from nestkernel:
#include "connection_manager.h"
#include "event_delivery_manager.h"
#include "io_manager.h"
#include "logging_manager.h"
#include "model_manager.h"
#include "modelrange_manager.h"
#include "module_manager.h"
#include "mpi_manager.h"
#include "music_manager.h"
#include "node_manager.h"
#include "random_manager.h"
#include "simulation_manager.h"
#include "sp_manager.h"
#include "vp_manager.h"
 
#include "compose.hpp"
#include <fstream>
 
#ifdef ENABLE_FULL_LOGGING
#define FULL_LOGGING_ONLY( code ) code
#else
#define FULL_LOGGING_ONLY( code )
#endif
 
namespace nest
{
 
class KernelManager
{
private:
  KernelManager();
  ~KernelManager();
 
  unsigned long fingerprint_;
 
  static KernelManager* kernel_manager_instance_;
 
  KernelManager( KernelManager const& );   // do not implement
  void operator=( KernelManager const& );  // do not implement
 
  Dictionary get_build_info_();
 
public:
  static void create_kernel_manager();
  static KernelManager& get_kernel_manager();
 
  void initialize();
 
  void finalize();
 
  void reset();
 
  void change_number_of_threads( size_t new_num_threads );
 
  void set_status( const Dictionary& );
  void get_status( Dictionary& );
 
  void prepare();
  void cleanup();
 
  bool is_initialized() const;
 
  unsigned long get_fingerprint() const;
 
  void write_to_dump( const std::string& msg );
 
  LoggingManager logging_manager;
  MPIManager mpi_manager;
  VPManager vp_manager;
  ModuleManager module_manager;
  RandomManager random_manager;
  SimulationManager simulation_manager;
  ModelRangeManager modelrange_manager;
  ConnectionManager connection_manager;
  SPManager sp_manager;
  EventDeliveryManager event_delivery_manager;
  IOManager io_manager;
  ModelManager model_manager;
  MUSICManager music_manager;
  NodeManager node_manager;
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::Threaded >&
  get_omp_synchronization_construction_stopwatch()
  {
    return sw_omp_synchronization_construction_;
  }
 
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::Threaded >&
  get_omp_synchronization_simulation_stopwatch()
  {
    return sw_omp_synchronization_simulation_;
  }
 
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::MasterOnly >&
  get_mpi_synchronization_stopwatch()
  {
    return sw_mpi_synchronization_;
  }
 
private:
  size_t get_memsize_linux_() const;   
  size_t get_memsize_darwin_() const;  
 
  std::vector< ManagerInterface* > managers;
 
  bool initialized_;    
  std::ofstream dump_;  
 
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::Threaded > sw_omp_synchronization_construction_;
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::Threaded > sw_omp_synchronization_simulation_;
  Stopwatch< StopwatchGranularity::Detailed, StopwatchParallelism::MasterOnly > sw_mpi_synchronization_;
};
 
KernelManager& kernel();
 
inline RngPtr
get_rank_synced_rng()
{
  return kernel().random_manager.get_rank_synced_rng();
}
 
inline RngPtr
get_vp_synced_rng( size_t tid )
{
  return kernel().random_manager.get_vp_synced_rng( tid );
}
 
inline RngPtr
get_vp_specific_rng( size_t tid )
{
  return kernel().random_manager.get_vp_specific_rng( tid );
}
 
inline KernelManager&
KernelManager::get_kernel_manager()
{
  assert( kernel_manager_instance_ );
  return *kernel_manager_instance_;
}
 
inline KernelManager&
kernel()
{
  return KernelManager::get_kernel_manager();
}
 
inline bool
KernelManager::is_initialized() const
{
  return initialized_;
}
 
inline unsigned long
KernelManager::get_fingerprint() const
{
  return fingerprint_;
}
 
}  // namespace nest
 
#endif /* KERNEL_MANAGER_H */