xref: /petsc/src/sys/time/cputime.c (revision 3ba1676111f5c958fe6c2729b46ca4d523958bb3)

/*
  This is to allow one to measure CPU time usage of their job,
  NOT real time usage. Do not use this for reported timings, speedup etc.
*/

#include <petscsys.h>  /*I "petscsys.h" I*/
#include <petsctime.h> /*I "petsctime.h" I*/
#include <ctype.h>
#include <sys/stat.h>
#if defined(PETSC_HAVE_SYS_UTSNAME_H)
  #include <sys/utsname.h>
#endif
#if defined(PETSC_HAVE_TIME_H)
  #include <time.h>
#endif
#if defined(PETSC_HAVE_SYS_SYSTEMINFO_H)
  #include <sys/systeminfo.h>
#endif

#if defined(PETSC_HAVE_SYS_TIMES_H)

  #include <sys/times.h>
PetscErrorCode PetscGetCPUTime(PetscLogDouble *t)
{
  struct tms temp;

  PetscFunctionBegin;
  times(&temp);
  *t = ((double)temp.tms_utime) / ((double)CLOCKS_PER_SEC);
  PetscFunctionReturn(PETSC_SUCCESS);
}

#elif defined(PETSC_HAVE_CLOCK)

  #include <time.h>

PetscErrorCode PetscGetCPUTime(PetscLogDouble *t)
{
  PetscFunctionBegin;
  *t = ((double)clock()) / ((double)CLOCKS_PER_SEC);
  PetscFunctionReturn(PETSC_SUCCESS);
}

#else

  #include <sys/time.h>
  #include <sys/resource.h>

/*@
    PetscGetCPUTime - Returns the CPU time in seconds used by the process.

    Not Collective

    Output Parameter:
.   t - Time in seconds charged to the process.

    Example:
.vb
    #include <petscsys.h>
    ...
    PetscLogDouble t1, t2;

    PetscCall(PetscGetCPUTime(&t1));
    ... code to time ...
    PetscCall(PetscGetCPUTime(&t2));
    printf("Code took %f CPU seconds\n", t2-t1);
.ve

    Level: intermediate

    Note:
    One should use the -log_view option of
    PETSc for profiling. The CPU time is NOT a realistic number to
    use since it does not include the time for message passing etc.
    Also on many systems the accuracy is only on the order of microseconds.

.seealso: `PetscTime()`, `PetscLogView()`
@*/
PetscErrorCode PetscGetCPUTime(PetscLogDouble *t)
{
  static struct rusage temp;
  PetscLogDouble       foo, foo1;

  PetscFunctionBegin;
  getrusage(RUSAGE_SELF, &temp);
  foo  = temp.ru_utime.tv_sec;  /* seconds */
  foo1 = temp.ru_utime.tv_usec; /* uSecs */
  *t   = foo + foo1 * 1.0e-6;
  PetscFunctionReturn(PETSC_SUCCESS);
}

#endif