src/gromacs/gmxlib/main.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifdef HAVE_CONFIG_H
  38 #include <config.h>
  39 #endif
  40
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <limits.h>
  45 #include <time.h>
  46
  47 #ifdef HAVE_SYS_TIME_H
  48 #include <sys/time.h>
  49 #endif
  50
  51 #include "smalloc.h"
  52 #include "gmx_fatal.h"
  53 #include "network.h"
  54 #include "main.h"
  55 #include "macros.h"
  56 #include "gromacs/fileio/futil.h"
  57 #include "gromacs/fileio/filenm.h"
  58 #include "gromacs/fileio/gmxfio.h"
  59 #include "string2.h"
  60 #include "copyrite.h"
  61
  62 #include "gromacs/utility/exceptions.h"
  63 #include "gromacs/utility/gmxmpi.h"
  64 #include "gromacs/utility/programinfo.h"
  65
  66 /* The source code in this file should be thread-safe.
  67          Please keep it that way. */
  68
  69
  70 #ifdef HAVE_UNISTD_H
  71 #include <unistd.h>
  72 #endif
  73
  74 #ifdef GMX_NATIVE_WINDOWS
  75 #include <process.h>
  76 #endif
  77
  78 #define BUFSIZE 1024
  79
  80
  81 static void par_fn(char *base, int ftp, const t_commrec *cr,
  82                    gmx_bool bAppendSimId, gmx_bool bAppendNodeId,
  83                    char buf[], int bufsize)
  84 {
  85     if ((size_t)bufsize < (strlen(base)+10))
  86     {
  87         gmx_mem("Character buffer too small!");
  88     }
  89
  90     /* Copy to buf, and strip extension */
  91     strcpy(buf, base);
  92     buf[strlen(base) - strlen(ftp2ext(fn2ftp(base))) - 1] = '\0';
  93
  94     if (bAppendSimId)
  95     {
  96         sprintf(buf+strlen(buf), "%d", cr->ms->sim);
  97     }
  98     if (bAppendNodeId)
  99     {
 100         strcat(buf, "_node");
 101         sprintf(buf+strlen(buf), "%d", cr->nodeid);
 102     }
 103     strcat(buf, ".");
 104
 105     /* Add extension again */
 106     strcat(buf, (ftp == efTPX) ? "tpr" : (ftp == efEDR) ? "edr" : ftp2ext(ftp));
 107     if (debug)
 108     {
 109         fprintf(debug, "node %d par_fn '%s'\n", cr->nodeid, buf);
 110         if (fn2ftp(buf) == efLOG)
 111         {
 112             fprintf(debug, "log\n");
 113         }
 114     }
 115 }
 116
 117 void check_multi_int(FILE *log, const gmx_multisim_t *ms, int val,
 118                      const char *name,
 119                      gmx_bool bQuiet)
 120 {
 121     int     *ibuf, p;
 122     gmx_bool bCompatible;
 123
 124     if (NULL != log && !bQuiet)
 125     {
 126         fprintf(log, "Multi-checking %s ... ", name);
 127     }
 128
 129     if (ms == NULL)
 130     {
 131         gmx_fatal(FARGS,
 132                   "check_multi_int called with a NULL communication pointer");
 133     }
 134
 135     snew(ibuf, ms->nsim);
 136     ibuf[ms->sim] = val;
 137     gmx_sumi_sim(ms->nsim, ibuf, ms);
 138
 139     bCompatible = TRUE;
 140     for (p = 1; p < ms->nsim; p++)
 141     {
 142         bCompatible = bCompatible && (ibuf[p-1] == ibuf[p]);
 143     }
 144
 145     if (bCompatible)
 146     {
 147         if (NULL != log && !bQuiet)
 148         {
 149             fprintf(log, "OK\n");
 150         }
 151     }
 152     else
 153     {
 154         if (NULL != log)
 155         {
 156             fprintf(log, "\n%s is not equal for all subsystems\n", name);
 157             for (p = 0; p < ms->nsim; p++)
 158             {
 159                 fprintf(log, "  subsystem %d: %d\n", p, ibuf[p]);
 160             }
 161         }
 162         gmx_fatal(FARGS, "The %d subsystems are not compatible\n", ms->nsim);
 163     }
 164
 165     sfree(ibuf);
 166 }
 167
 168 void check_multi_int64(FILE *log, const gmx_multisim_t *ms,
 169                        gmx_int64_t val, const char *name,
 170                        gmx_bool bQuiet)
 171 {
 172     gmx_int64_t      *ibuf;
 173     int               p;
 174     gmx_bool          bCompatible;
 175
 176     if (NULL != log && !bQuiet)
 177     {
 178         fprintf(log, "Multi-checking %s ... ", name);
 179     }
 180
 181     if (ms == NULL)
 182     {
 183         gmx_fatal(FARGS,
 184                   "check_multi_int called with a NULL communication pointer");
 185     }
 186
 187     snew(ibuf, ms->nsim);
 188     ibuf[ms->sim] = val;
 189     gmx_sumli_sim(ms->nsim, ibuf, ms);
 190
 191     bCompatible = TRUE;
 192     for (p = 1; p < ms->nsim; p++)
 193     {
 194         bCompatible = bCompatible && (ibuf[p-1] == ibuf[p]);
 195     }
 196
 197     if (bCompatible)
 198     {
 199         if (NULL != log && !bQuiet)
 200         {
 201             fprintf(log, "OK\n");
 202         }
 203     }
 204     else
 205     {
 206         if (NULL != log)
 207         {
 208             fprintf(log, "\n%s is not equal for all subsystems\n", name);
 209             for (p = 0; p < ms->nsim; p++)
 210             {
 211                 char strbuf[255];
 212                 /* first make the format string */
 213                 snprintf(strbuf, 255, "  subsystem %%d: %s\n",
 214                          "%" GMX_PRId64);
 215                 fprintf(log, strbuf, p, ibuf[p]);
 216             }
 217         }
 218         gmx_fatal(FARGS, "The %d subsystems are not compatible\n", ms->nsim);
 219     }
 220
 221     sfree(ibuf);
 222 }
 223
 224
 225 char *gmx_gethostname(char *name, size_t len)
 226 {
 227     if (len < 8)
 228     {
 229         gmx_incons("gmx_gethostname called with len<8");
 230     }
 231 #ifdef HAVE_UNISTD_H
 232     if (gethostname(name, len-1) != 0)
 233     {
 234         strncpy(name, "unknown", 8);
 235     }
 236 #else
 237     strncpy(name, "unknown", 8);
 238 #endif
 239
 240     return name;
 241 }
 242
 243
 244 void gmx_log_open(const char *lognm, const t_commrec *cr, gmx_bool bMasterOnly,
 245                   gmx_bool bAppendFiles, FILE** fplog)
 246 {
 247     int    len, pid;
 248     char   buf[256], host[256];
 249     time_t t;
 250     char   timebuf[STRLEN];
 251     FILE  *fp = *fplog;
 252     char  *tmpnm;
 253
 254     debug_gmx();
 255
 256     /* Communicate the filename for logfile */
 257     if (cr->nnodes > 1 && !bMasterOnly
 258 #ifdef GMX_THREAD_MPI
 259         /* With thread MPI the non-master log files are opened later
 260          * when the files names are already known on all nodes.
 261          */
 262         && FALSE
 263 #endif
 264         )
 265     {
 266         if (MASTER(cr))
 267         {
 268             len = strlen(lognm) + 1;
 269         }
 270         gmx_bcast(sizeof(len), &len, cr);
 271         if (!MASTER(cr))
 272         {
 273             snew(tmpnm, len+8);
 274         }
 275         else
 276         {
 277             tmpnm = gmx_strdup(lognm);
 278         }
 279         gmx_bcast(len*sizeof(*tmpnm), tmpnm, cr);
 280     }
 281     else
 282     {
 283         tmpnm = gmx_strdup(lognm);
 284     }
 285
 286     debug_gmx();
 287
 288     if (!bMasterOnly && !MASTER(cr))
 289     {
 290         /* Since log always ends with '.log' let's use this info */
 291         par_fn(tmpnm, efLOG, cr, FALSE, !bMasterOnly, buf, 255);
 292         fp = gmx_fio_fopen(buf, bAppendFiles ? "a+" : "w+" );
 293     }
 294     else if (!bAppendFiles)
 295     {
 296         fp = gmx_fio_fopen(tmpnm, bAppendFiles ? "a+" : "w+" );
 297     }
 298
 299     sfree(tmpnm);
 300
 301     gmx_fatal_set_log_file(fp);
 302
 303     /* Get some machine parameters */
 304     gmx_gethostname(host, 256);
 305
 306     time(&t);
 307
 308 #ifndef NO_GETPID
 309 #   ifdef GMX_NATIVE_WINDOWS
 310     pid = _getpid();
 311 #   else
 312     pid = getpid();
 313 #   endif
 314 #else
 315     pid = 0;
 316 #endif
 317
 318     if (bAppendFiles)
 319     {
 320         fprintf(fp,
 321                 "\n"
 322                 "\n"
 323                 "-----------------------------------------------------------\n"
 324                 "Restarting from checkpoint, appending to previous log file.\n"
 325                 "\n"
 326                 );
 327     }
 328
 329     gmx_ctime_r(&t, timebuf, STRLEN);
 330
 331     fprintf(fp,
 332             "Log file opened on %s"
 333             "Host: %s  pid: %d  nodeid: %d  nnodes:  %d\n",
 334             timebuf, host, pid, cr->nodeid, cr->nnodes);
 335     try
 336     {
 337         gmx::BinaryInformationSettings settings;
 338         settings.extendedInfo(true);
 339         settings.copyright(!bAppendFiles);
 340         gmx::printBinaryInformation(fp, gmx::ProgramInfo::getInstance(), settings);
 341     }
 342     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 343     fprintf(fp, "\n\n");
 344
 345     fflush(fp);
 346     debug_gmx();
 347
 348     *fplog = fp;
 349 }
 350
 351 void gmx_log_close(FILE *fp)
 352 {
 353     if (fp)
 354     {
 355         gmx_fatal_set_log_file(NULL);
 356         gmx_fio_fclose(fp);
 357     }
 358 }
 359
 360 void init_multisystem(t_commrec *cr, int nsim, char **multidirs,
 361                       int nfile, const t_filenm fnm[], gmx_bool bParFn)
 362 {
 363     gmx_multisim_t *ms;
 364     int             nnodes, nnodpersim, sim, i, ftp;
 365     char            buf[256];
 366 #ifdef GMX_MPI
 367     MPI_Group       mpi_group_world;
 368     int            *rank;
 369 #endif
 370
 371 #ifndef GMX_MPI
 372     if (nsim > 1)
 373     {
 374         gmx_fatal(FARGS, "This binary is compiled without MPI support, can not do multiple simulations.");
 375     }
 376 #endif
 377
 378     nnodes  = cr->nnodes;
 379     if (nnodes % nsim != 0)
 380     {
 381         gmx_fatal(FARGS, "The number of nodes (%d) is not a multiple of the number of simulations (%d)", nnodes, nsim);
 382     }
 383
 384     nnodpersim = nnodes/nsim;
 385     sim        = cr->nodeid/nnodpersim;
 386
 387     if (debug)
 388     {
 389         fprintf(debug, "We have %d simulations, %d nodes per simulation, local simulation is %d\n", nsim, nnodpersim, sim);
 390     }
 391
 392     snew(ms, 1);
 393     cr->ms   = ms;
 394     ms->nsim = nsim;
 395     ms->sim  = sim;
 396 #ifdef GMX_MPI
 397     /* Create a communicator for the master nodes */
 398     snew(rank, ms->nsim);
 399     for (i = 0; i < ms->nsim; i++)
 400     {
 401         rank[i] = i*nnodpersim;
 402     }
 403     MPI_Comm_group(MPI_COMM_WORLD, &mpi_group_world);
 404     MPI_Group_incl(mpi_group_world, nsim, rank, &ms->mpi_group_masters);
 405     sfree(rank);
 406     MPI_Comm_create(MPI_COMM_WORLD, ms->mpi_group_masters,
 407                     &ms->mpi_comm_masters);
 408
 409 #if !defined(MPI_IN_PLACE_EXISTS)
 410     /* initialize the MPI_IN_PLACE replacement buffers */
 411     snew(ms->mpb, 1);
 412     ms->mpb->ibuf        = NULL;
 413     ms->mpb->libuf       = NULL;
 414     ms->mpb->fbuf        = NULL;
 415     ms->mpb->dbuf        = NULL;
 416     ms->mpb->ibuf_alloc  = 0;
 417     ms->mpb->libuf_alloc = 0;
 418     ms->mpb->fbuf_alloc  = 0;
 419     ms->mpb->dbuf_alloc  = 0;
 420 #endif
 421
 422 #endif
 423
 424     /* Reduce the intra-simulation communication */
 425     cr->sim_nodeid = cr->nodeid % nnodpersim;
 426     cr->nnodes     = nnodpersim;
 427 #ifdef GMX_MPI
 428     MPI_Comm_split(MPI_COMM_WORLD, sim, cr->sim_nodeid, &cr->mpi_comm_mysim);
 429     cr->mpi_comm_mygroup = cr->mpi_comm_mysim;
 430     cr->nodeid           = cr->sim_nodeid;
 431 #endif
 432
 433     if (debug)
 434     {
 435         fprintf(debug, "This is simulation %d", cr->ms->sim);
 436         if (PAR(cr))
 437         {
 438             fprintf(debug, ", local number of nodes %d, local nodeid %d",
 439                     cr->nnodes, cr->sim_nodeid);
 440         }
 441         fprintf(debug, "\n\n");
 442     }
 443
 444     if (multidirs)
 445     {
 446         if (debug)
 447         {
 448             fprintf(debug, "Changing to directory %s\n", multidirs[cr->ms->sim]);
 449         }
 450         gmx_chdir(multidirs[cr->ms->sim]);
 451     }
 452     else if (bParFn)
 453     {
 454         /* Patch output and tpx, cpt and rerun input file names */
 455         for (i = 0; (i < nfile); i++)
 456         {
 457             /* Because of possible multiple extensions per type we must look
 458              * at the actual file name
 459              */
 460             if (is_output(&fnm[i]) ||
 461                 fnm[i].ftp == efTPX || fnm[i].ftp == efCPT ||
 462                 strcmp(fnm[i].opt, "-rerun") == 0)
 463             {
 464                 ftp = fn2ftp(fnm[i].fns[0]);
 465                 par_fn(fnm[i].fns[0], ftp, cr, TRUE, FALSE, buf, 255);
 466                 sfree(fnm[i].fns[0]);
 467                 fnm[i].fns[0] = gmx_strdup(buf);
 468             }
 469         }
 470     }
 471 }