Actual source code: mem.c
petsc-3.13.6 2020-09-29
Report Typos and Errors

      1: #define PETSC_DESIRE_FEATURE_TEST_MACROS /* for getpagesize() with c89 */
      2:  #include <petscsys.h>
      3: #if defined(PETSC_HAVE_PWD_H)
      4: #include <pwd.h>
      5: #endif
      6: #include <ctype.h>
      7: #include <sys/stat.h>
      8: #if defined(PETSC_HAVE_UNISTD_H)
      9: #include <unistd.h>
     10: #endif
     11: #if defined(PETSC_HAVE_SYS_UTSNAME_H)
     12: #include <sys/utsname.h>
     13: #endif
     14: #include <fcntl.h>
     15: #include <time.h>
     16: #if defined(PETSC_HAVE_SYS_SYSTEMINFO_H)
     17: #include <sys/systeminfo.h>
     18: #endif

     20: #if defined(PETSC_HAVE_SYS_RESOURCE_H)
     21: #include <sys/resource.h>
     22: #endif
     23: #if defined(PETSC_HAVE_SYS_PROCFS_H)
     24: /* #include <sys/int_types.h> Required if using gcc on solaris 2.6 */
     25: #include <sys/procfs.h>
     26: #endif
     27: #if defined(PETSC_HAVE_FCNTL_H)
     28: #include <fcntl.h>
     29: #endif

     31: /*@
     32:    PetscMemoryGetCurrentUsage - Returns the current resident set size (memory used)
     33:    for the program.

     35:    Not Collective

     37:    Output Parameter:
     38: .   mem - memory usage in bytes

     40:    Options Database Key:
     41: +  -memory_view - Print memory usage at end of run
     42: -  -malloc_log - Activate logging of memory usage

     44:    Level: intermediate

     46:    Notes:
     47:    The memory usage reported here includes all Fortran arrays
     48:    (that may be used in Section 1.5 Writing Application Codes with PETSc-defined sections of code).
     49:    This routine thus provides a more complete picture of memory
     50:    usage than PetscMallocGetCurrentUsage() for codes that employ Fortran with
     51:    hardwired arrays.

     53: .seealso: PetscMallocGetMaximumUsage(), PetscMemoryGetMaximumUsage(), PetscMallocGetCurrentUsage(), PetscMemorySetGetMaximumUsage(), PetscMemoryView()

     56: @*/
     57: PetscErrorCode  PetscMemoryGetCurrentUsage(PetscLogDouble *mem)
     58: {
     59: #if defined(PETSC_USE_PROCFS_FOR_SIZE)
     60:   FILE       *file;
     61:   int        fd;
     62:   char       proc[PETSC_MAX_PATH_LEN];
     63:   prpsinfo_t prusage;
     64: #elif defined(PETSC_USE_SBREAK_FOR_SIZE)
     65:   long       *ii = sbreak(0);
     66:   int        fd  = ii - (long*)0;
     67: #elif defined(PETSC_USE_PROC_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE)
     68:   FILE       *file;
     69:   char       proc[PETSC_MAX_PATH_LEN];
     70:   int        mm,rss,err;
     71: #elif defined(PETSC_HAVE_GETRUSAGE)
     72:   static struct rusage temp;
     73: #endif

     76: #if defined(PETSC_USE_PROCFS_FOR_SIZE)

     78:   sprintf(proc,"/proc/%d",(int)getpid());
     79:   if ((fd = open(proc,O_RDONLY)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to access system file %s to get memory usage data",file);
     80:   if (ioctl(fd,PIOCPSINFO,&prusage) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Unable to access system file %s to get memory usage data",file);
     81:   *mem = (PetscLogDouble)prusage.pr_byrssize;
     82:   close(fd);

     84: #elif defined(PETSC_USE_SBREAK_FOR_SIZE)

     86:   *mem = (PetscLogDouble)(8*fd - 4294967296); /* 2^32 - upper bits */

     88: #elif defined(PETSC_USE_PROC_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE)
     89:   sprintf(proc,"/proc/%d/statm",(int)getpid());
     90:   if (!(file = fopen(proc,"r"))) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to access system file %s to get memory usage data",proc);
     91:   if (fscanf(file,"%d %d",&mm,&rss) != 2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"Failed to read two integers (mm and rss) from %s",proc);
     92:   *mem = ((PetscLogDouble)rss) * ((PetscLogDouble)getpagesize());
     93:   err  = fclose(file);
     94:   if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");

     96: #elif defined(PETSC_HAVE_GETRUSAGE)
     97:   getrusage(RUSAGE_SELF,&temp);
     98: #if defined(PETSC_USE_KBYTES_FOR_SIZE)
     99:   *mem = 1024.0 * ((PetscLogDouble)temp.ru_maxrss);
    100: #elif defined(PETSC_USE_PAGES_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE)
    101:   *mem = ((PetscLogDouble)getpagesize())*((PetscLogDouble)temp.ru_maxrss);
    102: #else
    103:   *mem = temp.ru_maxrss;
    104: #endif

    106: #else
    107:   *mem = 0.0;
    108: #endif
    109:   return(0);
    110: }

    112: PETSC_INTERN PetscBool      PetscMemoryCollectMaximumUsage;
    113: PETSC_INTERN PetscLogDouble PetscMemoryMaximumUsage;

    115: PetscBool      PetscMemoryCollectMaximumUsage = PETSC_FALSE;
    116: PetscLogDouble PetscMemoryMaximumUsage        = 0;

    118: /*@
    119:    PetscMemoryGetMaximumUsage - Returns the maximum resident set size (memory used)
    120:    for the program.

    122:    Not Collective

    124:    Output Parameter:
    125: .   mem - memory usage in bytes

    127:    Options Database Key:
    128: +  -memory_view - Print memory usage at end of run
    129: -  -malloc_log - Activate logging of memory usage

    131:    Level: intermediate

    133:    Notes:
    134:    The memory usage reported here includes all Fortran arrays
    135:    (that may be used in Section 1.5 Writing Application Codes with PETSc-defined sections of code).
    136:    This routine thus provides a more complete picture of memory
    137:    usage than PetscMallocGetCurrentUsage() for codes that employ Fortran with
    138:    hardwired arrays.

    140: .seealso: PetscMallocGetMaximumUsage(), PetscMemoryGetCurrentUsage(), PetscMallocGetCurrentUsage(),
    141:           PetscMemorySetGetMaximumUsage()

    144: @*/
    145: PetscErrorCode  PetscMemoryGetMaximumUsage(PetscLogDouble *mem)
    146: {
    148:   if (!PetscMemoryCollectMaximumUsage) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"To use this function you must first call PetscMemorySetGetMaximumUsage()");
    149:   *mem = PetscMemoryMaximumUsage;
    150:   return(0);
    151: }

    153: /*@
    154:    PetscMemorySetGetMaximumUsage - Tells PETSc to monitor the maximum memory usage so that
    155:        PetscMemoryGetMaximumUsage() will work.

    157:    Not Collective

    159:    Options Database Key:
    160: +  -memory_view - Print memory usage at end of run
    161: -  -malloc_log - Activate logging of memory usage

    163:    Level: intermediate

    165: .seealso: PetscMallocGetMaximumUsage(), PetscMemoryGetCurrentUsage(), PetscMallocGetCurrentUsage(),
    166:           PetscMemoryGetMaximumUsage()

    169: @*/
    170: PetscErrorCode  PetscMemorySetGetMaximumUsage(void)
    171: {
    173:   PetscMemoryCollectMaximumUsage = PETSC_TRUE;
    174:   return(0);
    175: }