produtil.rusage Namespace Reference

This module allows querying resource usage and limits, as well as setting resource limits. More...

Detailed Description

This module allows querying resource usage and limits, as well as setting resource limits.

It is a wrapper around the Python resource module.

Setting resource limits:

use logging, produtil.rusage
logger=logging.logger("rusage")
produtil.rusage.setrlimit(logger,data=1e9,nofile=500,aspace=2e9,stack=5e8)

Printing resource limits to a logger:

use logging, produtil.rusage
logger=logging.logger("rusage")
u.produtil.rusage.getrlimit(logger) # writes the limits to the logger
# Limits are also in the returned object "u"
# Send None instead of logger to avoid logging.

Classes
class	RLimit
	Gets the resource limits set on this process: core, cpu, fsize, data, stack, rss, nproc, nofile, memlock, aspace Each is set to a tuple containing the soft and hard limit. More...
class	RUsage
	Contains resource usage (rusage) information that can be used with a Python "with" construct to collect the resources utilized by a block of code, or group of subprocesses executing during that block. More...
class	RUsageReport
	Raised when caller makes an RUsage, and tries to generate its report, before calling its enter or exit routines. More...

Functions
def	setrlimit (logger=None, ignore=False, hard=False, kwargs)
	Sets resource limits. More...
def	getrlimit
	Gets the current resource limits. More...

Variables
tuple	rtypemap
	Maps the name used in this module for each resource class to the name used by the Python resource module. More...
tuple	rnamemap
	Maps the name used in this module for each resource class, to a short human-readable string explaining the resource's meaning. More...
tuple	rusage_keys
	A tuple containing all rusage keys. More...
tuple	rusage_meanings
	A mapping from rusage key to a human-readable explanation of the meaning. More...
	rusage = RUsage
	Alias for produtil.rusage.RUsage.

Function Documentation

def produtil.rusage.getrlimit

(

logger = None

)

Gets the current resource limits.

If logger is not None, sends the limits to the logger at level INFO.

Returns

a RLimit object with resource information

Definition at line 132 of file rusage.py.

Referenced by hwrf.init.HWRFInit.run_init_after_anl(), pom.init.fbtr.setrun(), pom.init.g3.setrun(), and pom.init.na.setrun().

def produtil.rusage.setrlimit	(		logger = None,
			ignore = False,
			hard = False,
			kwargs
	)

Sets resource limits.

Parameters

ignore	If ignore=True, ignores any errors from getrlimit or setrlimit.
hard	If hard=True, attempts to set hard limits, which generally requires administrator privileges.
logger	The logger argument sets the logger (default: produtil.setrlimit logging domain).
kwargs	The kwargs should be a list of resource limits. Accepted resource limits: core = core file size (RLIMIT_CORE) cpu = max. cpu usage (RLIMIT_CPU) fsize = max. file size (RLIMIT_FSIZE) data = max. heap size (RLIMIT_DATA) stack = max. stack size (RLIMIT_STACK) rss = max. resident set size (RLIMIT_RSS) nproc = max. processes (RLIMIT_NPROC) nofile = max. open files (RLIMIT_NOFILE or RLIMIT_OFILE) memlock= max locked memory (RLIMIT_MEMLOCK) aspace = max. address space (RLIMIT_AS) See "man setrlimit" for details.

Definition at line 60 of file rusage.py.

Referenced by pom.init.fbtr.setrun(), pom.init.g3.setrun(), and pom.init.na.setrun().

Variable Documentation

produtil.rusage.rnamemap

Initial value:

= dict(core='core file size',
              cpu='cpu usage',
              fsize='max. file size',
              data='max. heap size',
              stack='max. stack size',
              rss='max. resident set size',
              nproc='max. processes',
              nofile='max. open files',
              #ofile='max. open files (BSD)',
              memlock='max. locked memory',
              #vmem='max. virtual memory',
              aspace='max. address space')

Maps the name used in this module for each resource class, to a short human-readable string explaining the resource's meaning.

Definition at line 45 of file rusage.py.

produtil.rusage.rtypemap

Initial value:

= dict(core=resource.RLIMIT_CORE,
              cpu=resource.RLIMIT_CPU,
              fsize=resource.RLIMIT_FSIZE,
              data=resource.RLIMIT_DATA,
              stack=resource.RLIMIT_STACK,
              rss=resource.RLIMIT_RSS,
              nproc=resource.RLIMIT_NPROC,
              nofile=resource.RLIMIT_NOFILE,
              #ofile=resource.RLIMIT_OFILE,
              memlock=resource.RLIMIT_MEMLOCK,
              #vmem=resource.RLIMIT_VMEM,
              aspace=resource.RLIMIT_AS)

Maps the name used in this module for each resource class to the name used by the Python resource module.

Definition at line 27 of file rusage.py.

produtil.rusage.rusage_keys

Initial value:

= ('ru_utime','ru_stime','ru_maxrss','ru_ixrss','ru_idrss',
             'ru_isrss','ru_minflt','ru_majflt','ru_nswap','ru_inblock',
             'ru_oublock','ru_msgsnd','ru_msgrcv','ru_nsignals',
             'ru_nvcsw','ru_nivcsw')

A tuple containing all rusage keys.

Definition at line 144 of file rusage.py.

produtil.rusage.rusage_meanings

Initial value:

= dict(ru_utime='time in user mode',
                     ru_stime='time in system mode',
                     ru_maxrss='maximum resident set size',
                     ru_ixrss='shared memory size',
                     ru_idrss='unshared memory size',
                     ru_isrss='unshared stack size',
                     ru_minflt='page faults not requiring I/O',
                     ru_majflt='page faults requiring I/O',
                     ru_nswap='number of swap outs',
                     ru_inblock='block input operations',
                     ru_oublock='block output operations',
                     ru_msgsnd='messages sent',
                     ru_msgrcv='messages received',
                     ru_nsignals='signals received',
                     ru_nvcsw='voluntary context switches',
                     ru_nivcsw='involuntary context switches')

A mapping from rusage key to a human-readable explanation of the meaning.

Definition at line 152 of file rusage.py.