src/gromacs/utility/sysinfo.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,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 /*! \internal \file
  36  * \brief
  37  * Implements functions from sysinfo.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "sysinfo.h"
  45
  46 #include "config.h"
  47
  48 #include <cstring>
  49 #include <ctime>
  50
  51 #include <array>
  52
  53 #include <sys/types.h>
  54 #ifdef HAVE_SYS_TIME_H
  55 #    include <sys/time.h>
  56 #endif
  57 #if GMX_NATIVE_WINDOWS
  58 #    include <Windows.h>
  59 #    include <process.h>
  60 #endif
  61 #if HAVE_PWD_H
  62 #    include <pwd.h>
  63 #endif
  64 #ifdef HAVE_UNISTD_H
  65 #    include <unistd.h>
  66 #endif
  67
  68 #include "gromacs/utility/basedefinitions.h"
  69 #include "gromacs/utility/gmxassert.h"
  70
  71 namespace
  72 {
  73 //! Static return value for cases when a string value is not available.
  74 const char c_unknown[] = "unknown";
  75 } // namespace
  76
  77 int gmx_gethostname(char* buf, size_t len)
  78 {
  79     GMX_RELEASE_ASSERT(len >= 8, "Input buffer is too short");
  80 #if GMX_NATIVE_WINDOWS
  81     DWORD dlen = len;
  82     if (GetComputerName(buf, &dlen))
  83     {
  84         return 0;
  85     }
  86 #elif defined(HAVE_UNISTD_H) && !defined(__native_client__)
  87     if (gethostname(buf, len - 1) == 0)
  88     {
  89         buf[len - 1] = '\0';
  90         return 0;
  91     }
  92 #endif
  93     strcpy(buf, c_unknown);
  94     return -1;
  95 }
  96
  97 int gmx_getpid()
  98 {
  99 #if GMX_NATIVE_WINDOWS
 100     return _getpid();
 101 #else
 102     return getpid();
 103 #endif
 104 }
 105
 106 int gmx_getuid()
 107 {
 108 #if defined(HAVE_UNISTD_H) && !defined(__MINGW32__)
 109     return getuid();
 110 #else
 111     return -1;
 112 #endif
 113 }
 114
 115 int gmx_getusername(char* buf, size_t len)
 116 {
 117     GMX_RELEASE_ASSERT(len >= 8, "Input buffer is too short");
 118     // TODO: nice_header() used getpwuid() instead; consider using getpwuid_r()
 119     // here.  If not, get rid of HAVE_PWD_H completely.
 120 #if GMX_NATIVE_WINDOWS
 121     DWORD dlen = len;
 122     if (GetUserName(buf, &dlen))
 123     {
 124         return 0;
 125     }
 126 #elif defined(HAVE_UNISTD_H) && !__has_feature(memory_sanitizer) // MSAN Issue 83
 127     if (!getlogin_r(buf, len))
 128     {
 129         buf[len - 1] = '\0';
 130         return 0;
 131     }
 132 #endif
 133     strcpy(buf, c_unknown);
 134     return -1;
 135 }
 136
 137 std::string gmx_ctime_r(const time_t* clock)
 138 {
 139 #ifdef _MSC_VER
 140     std::array<char, 1024> buf;
 141     ctime_s(buf.data(), buf.size(), clock);
 142     return std::string(buf.begin(), buf.end());
 143 #elif GMX_NATIVE_WINDOWS
 144     char* tmpbuf = ctime(clock);
 145     return tmpbuf;
 146 #elif (defined(__sun))
 147     /*Solaris*/
 148     std::array<char, 1024> buf;
 149     ctime_r(clock, buf.data());
 150     return std::string(buf.begin(), buf.end());
 151 #else
 152     std::array<char, 1024> buf;
 153     ctime_r(clock, buf.data());
 154     return std::string(buf.begin(), buf.end());
 155 #endif
 156 }
 157
 158 std::string gmx_format_current_time()
 159 {
 160     time_t clock = time(nullptr);
 161     return gmx_ctime_r(&clock);
 162 }
 163
 164 int gmx_set_nice(int level)
 165 {
 166 #if GMX_USE_NICE
 167     // TODO: This may not be reliable, but currently the return value is not
 168     // used.
 169     if (nice(level) != -1)
 170     {
 171         return 0;
 172     }
 173 #else
 174     GMX_UNUSED_VALUE(level);
 175 #endif
 176     return -1;
 177 }