Platform.hpp

/*--------------------------------------------------------------------*/
/*    Copyright 2003, 2008 Sandia Corporation.                              */
/*    Under the terms of Contract DE-AC04-94AL85000, there is a       */
/*    non-exclusive license for use of this work by or on behalf      */
/*    of the U.S. Government.  Export of this program may require     */
/*    a license from the United States Government.                    */
/*--------------------------------------------------------------------*/

#ifndef STK_UTIL_DIAG_Platform_h
#define STK_UTIL_DIAG_Platform_h

#include <iosfwd>
#include <stk_util/stk_config.h>
#if defined( STK_HAS_MPI )
#include <mpi.h>
#endif

#include <stk_util/util/FeatureTest.hpp>
#include <stk_util/diag/Env.hpp>
#include <stk_util/diag/String.hpp>
#include <stk_util/diag/Option.hpp>
#include <stk_util/environment/RegisterProduct.hpp>

namespace sierra {
namespace Env {


void startup_preparallel_platform();


std::string hostname();


std::string domainname();


std::string username();


std::string hardware();


std::string osname();


std::string osversion();


int pid();


int pgrp();


void get_heap_info(size_t &heap_size, size_t &largest_free);


inline size_t get_heap_usage() {
  size_t heap_size;
  size_t largest_free;
  get_heap_info(heap_size, largest_free);

  return heap_size;
}

size_t get_available_memory();


void get_memory_info(size_t &memory_usage, size_t &faults);


bool path_exists(const std::string &path);


bool path_access(const std::string &path, int mode);


bool path_read_access(const std::string &path);

bool path_write_access(const std::string &path);


bool read_lock(int fd);


bool write_lock(int fd);


bool append_lock(int fd);


bool release_lock(int fd);


} // namespace Env
} // namespace sierra

#endif // STK_UTIL_DIAG_Platform_h