#define PETSC_DESIRE_FEATURE_TEST_MACROS /* for getpagesize() with c89 */ #include /*I "petscsys.h" I*/ #if defined(PETSC_HAVE_PWD_H) #include #endif #include #include #if defined(PETSC_HAVE_UNISTD_H) #include #endif #if defined(PETSC_HAVE_SYS_UTSNAME_H) #include #endif #include #include #if defined(PETSC_HAVE_SYS_SYSTEMINFO_H) #include #endif #if defined(PETSC_HAVE_SYS_RESOURCE_H) #include #endif #if defined(PETSC_HAVE_SYS_PROCFS_H) /* #include Required if using gcc on solaris 2.6 */ #include #endif #if defined(PETSC_HAVE_FCNTL_H) #include #endif /*@ PetscMemoryGetCurrentUsage - Returns the current resident set size (memory used) for the program. Not Collective Output Parameter: . mem - memory usage in bytes Options Database Key: + -memory_view - Print memory usage at end of run . -log_view_memory - Display memory information for each logged event - -malloc_view - Print usage of `PetscMalloc()` in `PetscFinalize()` Level: intermediate Notes: The memory usage reported here includes all Fortran arrays (that may be used in application-defined sections of code). This routine thus provides a more complete picture of memory usage than `PetscMallocGetCurrentUsage()` for codes that employ Fortran with hardwired arrays. This value generally never decreases during a run even if the application has freed much of its memory that it allocated .seealso: `PetscMallocGetMaximumUsage()`, `PetscMemoryGetMaximumUsage()`, `PetscMallocGetCurrentUsage()`, `PetscMemorySetGetMaximumUsage()`, `PetscMemoryView()` @*/ PetscErrorCode PetscMemoryGetCurrentUsage(PetscLogDouble *mem) { #if defined(PETSC_USE_PROCFS_FOR_SIZE) FILE *file; int fd; char proc[PETSC_MAX_PATH_LEN]; prpsinfo_t prusage; #elif defined(PETSC_USE_SBREAK_FOR_SIZE) long *ii = sbreak(0); int fd = ii - (long *)0; #elif defined(PETSC_USE_PROC_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE) FILE *file; char proc[PETSC_MAX_PATH_LEN]; int mm, rss, err; #elif defined(PETSC_HAVE_GETRUSAGE) static struct rusage temp; #endif PetscFunctionBegin; #if defined(PETSC_USE_PROCFS_FOR_SIZE) PetscCall(PetscSNPrintf(proc, PETSC_STATIC_ARRAY_LENGTH(proc), "/proc/%d", getpid())); PetscCheck((fd = open(proc, O_RDONLY)) != -1, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to access system file %s to get memory usage data", file); PetscCheck(ioctl(fd, PIOCPSINFO, &prusage) != -1, PETSC_COMM_SELF, PETSC_ERR_FILE_READ, "Unable to access system file %s to get memory usage data", file); *mem = (PetscLogDouble)prusage.pr_byrssize; close(fd); #elif defined(PETSC_USE_SBREAK_FOR_SIZE) *mem = (PetscLogDouble)(8 * fd - 4294967296); /* 2^32 - upper bits */ #elif defined(PETSC_USE_PROC_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE) PetscCall(PetscSNPrintf(proc, PETSC_STATIC_ARRAY_LENGTH(proc), "/proc/%d/statm", getpid())); PetscCheck(file = fopen(proc, "r"), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to access system file %s to get memory usage data", proc); PetscCheck(fscanf(file, "%d %d", &mm, &rss) == 2, PETSC_COMM_SELF, PETSC_ERR_SYS, "Failed to read two integers (mm and rss) from %s", proc); *mem = ((PetscLogDouble)rss) * ((PetscLogDouble)getpagesize()); err = fclose(file); PetscCheck(!err, PETSC_COMM_SELF, PETSC_ERR_SYS, "fclose() failed on file"); #elif defined(PETSC_HAVE_GETRUSAGE) getrusage(RUSAGE_SELF, &temp); #if defined(PETSC_USE_KBYTES_FOR_SIZE) *mem = 1024.0 * ((PetscLogDouble)temp.ru_maxrss); #elif defined(PETSC_USE_PAGES_FOR_SIZE) && defined(PETSC_HAVE_GETPAGESIZE) *mem = ((PetscLogDouble)getpagesize()) * ((PetscLogDouble)temp.ru_maxrss); #else *mem = temp.ru_maxrss; #endif #else *mem = 0.0; #endif PetscFunctionReturn(PETSC_SUCCESS); } PETSC_INTERN PetscBool PetscMemoryCollectMaximumUsage; PETSC_INTERN PetscLogDouble PetscMemoryMaximumUsage; PetscBool PetscMemoryCollectMaximumUsage = PETSC_FALSE; PetscLogDouble PetscMemoryMaximumUsage = 0; /*@ PetscMemoryGetMaximumUsage - Returns the maximum resident set size (memory used) for the program since it started (the high water mark). Not Collective Output Parameter: . mem - memory usage in bytes Options Database Key: + -memory_view - Print memory usage at end of run . -log_view_memory - Print memory information per event - -malloc_view - Print usage of `PetscMalloc()` in `PetscFinalize()` Level: intermediate Note: The memory usage reported here includes all Fortran arrays (that may be used in application-defined sections of code). This routine thus provides a more complete picture of memory usage than `PetscMallocGetCurrentUsage()` for codes that employ Fortran with hardwired arrays. .seealso: `PetscMallocGetMaximumUsage()`, `PetscMemoryGetCurrentUsage()`, `PetscMallocGetCurrentUsage()`, `PetscMemorySetGetMaximumUsage()` @*/ PetscErrorCode PetscMemoryGetMaximumUsage(PetscLogDouble *mem) { PetscFunctionBegin; PetscCheck(PetscMemoryCollectMaximumUsage, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "To use this function you must first call PetscMemorySetGetMaximumUsage()"); *mem = PetscMemoryMaximumUsage; PetscFunctionReturn(PETSC_SUCCESS); } /*@ PetscMemorySetGetMaximumUsage - Tells PETSc to monitor the maximum memory usage so that `PetscMemoryGetMaximumUsage()` will work. Not Collective Options Database Key: + -memory_view - Print memory usage at end of run . -log_view_memory - Print memory information per event - -malloc_view - Print usage of `PetscMalloc()` in `PetscFinalize()` Level: intermediate .seealso: `PetscMallocGetMaximumUsage()`, `PetscMemoryGetCurrentUsage()`, `PetscMallocGetCurrentUsage()`, `PetscMemoryGetMaximumUsage()` @*/ PetscErrorCode PetscMemorySetGetMaximumUsage(void) { PetscFunctionBegin; PetscMemoryCollectMaximumUsage = PETSC_TRUE; PetscFunctionReturn(PETSC_SUCCESS); }