src/gromacs/utility/sysinfo.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2017,2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares functions that wrap platform-specific calls for obtaining
  38  * information about the operating environment and the current
  39  * process.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \inlibraryapi
  43  * \ingroup module_utility
  44  */
  45 #ifndef GMX_UTILITY_SYSINFO_H
  46 #define GMX_UTILITY_SYSINFO_H
  47
  48 #include <stddef.h>
  49 #include <time.h>
  50
  51 #include <string>
  52
  53 /*! \addtogroup module_utility
  54  * \{
  55  */
  56
  57 /*! \brief
  58  * Gets the hostname as given by gethostname(), if available.
  59  *
  60  * \param[out] buf  Buffer to receive the hostname.
  61  * \param[in]  len  Length of buffer \p buf (must be >= 8).
  62  * \returns 0 on success, -1 on error.
  63  *
  64  * If the value is not available, "unknown" is returned.
  65  * \p name should have at least size \p len.
  66  *
  67  * Does not throw.
  68  */
  69 int gmx_gethostname(char* buf, size_t len);
  70
  71 /*! \brief
  72  * Returns the process ID of the current process.
  73  *
  74  * Does not throw.
  75  */
  76 int gmx_getpid();
  77 /*! \brief
  78  * Returns the current user ID, or -1 if not available.
  79  *
  80  * Does not throw.
  81  */
  82 int gmx_getuid();
  83 /*! \brief
  84  * Gets the current user name, if available.
  85  *
  86  * \param[out] buf  Buffer to receive the username.
  87  * \param[in]  len  Length of buffer \p buf (must be >= 8).
  88  * \returns 0 on success, -1 on error.
  89  *
  90  * Does not throw.
  91  */
  92 int gmx_getusername(char* buf, size_t len);
  93
  94 /*! \brief
  95  * Portable version of ctime_r.
  96  *
  97  * \throws std::bad_alloc when out of memory.
  98  */
  99 std::string gmx_ctime_r(const time_t* clock);
 100 /*! \brief
 101  * Gets the current time as a string.
 102  *
 103  * \throws std::bad_alloc when out of memory.
 104  */
 105 std::string gmx_format_current_time();
 106
 107 /*! \brief
 108  * Wrapper for nice().
 109  *
 110  * Does not throw.
 111  */
 112 int gmx_set_nice(int level);
 113
 114 /*! \} */
 115
 116 #endif