Revised wording in pdb2gmx.c, hopefully clearer now.
[gromacs/rigid-bodies.git] / src / gmxlib / gmx_cyclecounter.c
bloba1f9b4755e6b91bd249fcacbaaab56ff2fdb1dba
1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
3 *
4 * This file is part of Gromacs Copyright (c) 1991-2006
5 * David van der Spoel, Erik Lindahl, Berk Hess, University of Groningen.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * To help us fund GROMACS development, we humbly ask that you cite
13 * the research papers on the package. Check out http://www.gromacs.org
15 * And Hey:
16 * Gnomes, ROck Monsters And Chili Sauce
18 #ifdef HAVE_CONFIG_H
19 #include <config.h>
20 #endif
22 #include <time.h>
23 #ifdef HAVE_SYS_TIME_H
24 #include <sys/time.h>
25 #endif
27 #ifdef _MSC_VER
28 #include <windows.h>
29 #endif
31 #include "gmx_cyclecounter.h"
37 /*! \brief Calculate number of seconds per cycle tick on host
39 * This routine runs a timer loop to calibrate the number of
40 * seconds per the units returned fro gmx_cycles_read().
42 * \param sampletime Minimum real sample time. It takes some trial-and-error
43 * to find the correct delay loop size, so the total runtime of
44 * this routine is about twice this time.
45 * \return Number of seconds per cycle unit. If it is not possible to
46 * calculate on this system (for whatever reason) the return value
47 * will be -1, so check that it is positive before using it.
49 double
50 gmx_cycles_calibrate(double sampletime)
52 #ifdef _MSC_VER
54 /* Windows does not have gettimeofday, but it provides a special
55 * routine that returns the cycle counter frequency.
57 LARGE_INTEGER i;
59 QueryPerformanceFrequency(&i);
61 return 1.0/((double) i.QuadPart);
62 /* end of MS Windows implementation */
64 #elif (defined HAVE_GETTIMEOFDAY)
66 /* generic implementation with gettimeofday() */
67 struct timeval t1,t2;
68 gmx_cycles_t c1,c2;
69 double timediff,cyclediff;
70 double d=0.1; /* Dummy variable so we don't optimize away delay loop */
71 int i;
73 if(!gmx_cycles_have_counter())
75 return -1;
78 #if (defined(__alpha__) || defined(__alpha))
79 /* Alpha cannot count to more than 4e9, but I don't expect
80 * that the architecture will go over 2GHz before it dies, so
81 * up to 2.0 seconds of sampling should be safe.
83 if(sampletime>2.0)
85 sampletime=2.0;
87 #endif
89 /* Start a timing loop. We want this to be largely independent
90 * of machine speed, so we need to start with a very small number
91 * of iterations and repeat it until we reach the requested time.
93 * We call gettimeofday an extra time at the start to avoid cache misses.
95 gettimeofday(&t1,NULL);
96 gettimeofday(&t1,NULL);
97 c1=gmx_cycles_read();
99 do
101 /* just a delay loop. To avoid optimizing it away, we calculate a number
102 * that will underflow to zero in most cases. By conditionally adding it
103 * to a result at the end it cannot be removed. n=10000 is arbitrary...
105 for(i=0;i<10000;i++)
106 d=d/(1.0+(double)i);
107 /* Read the time again */
108 gettimeofday(&t2,NULL);
109 c2=gmx_cycles_read();
110 timediff=(double)(t2.tv_sec-t1.tv_sec)+
111 (double)(t2.tv_usec-t1.tv_usec)*1e-6;
113 while( timediff < sampletime );
115 cyclediff=c2-c1;
117 /* Add a very small result so the delay loop cannot be optimized away */
118 if(d<1e-30)
120 timediff+=d;
123 /* Return seconds per cycle */
124 return timediff/cyclediff;
126 #else
127 /* No timing function available */
128 return -1;
129 #endif