cape.cfdx.options.ulimit: System resource options

This module provides a class to access options relating to system resources. Specifically, this pertains to options usually set by ulimit from the command line.

The class provided in this module, cape.options.ulimit.ulimit, is loaded in the "RunControl" section of the JSON file and the cape.options.runControl.RunControl class.

class cape.cfdx.options.ulimit.ulimit

Class for resource limits

Call:

>>> opts = ulimit(**kw)

Inputs:

kw: dict

Dictionary of system resource options

Outputs:

opts: cape.options.ulimit.ulimit

System resource options interface

Versions:

• 2015-11-10 @ddalle: First version

get_c(i=0)

Get the core file size limit, ulimit -c

Call:

>>> c = opts.get_c(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

c: int

Value of the core file size limit

Versions:

• 2016-03-13 @ddalle: First version (blocks)

get_core_file_size(i=0)

Get the core file size limit, ulimit -c

Call:

>>> c = opts.get_c(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

c: int

Value of the core file size limit

Versions:

• 2016-03-13 @ddalle: First version (blocks)

get_d(i=0)

Get the data segment limit

Call:

>>> d = opts.get_d(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

d: int

Data segment limit (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_data_seg_limit(i=0)

Get the data segment limit

Call:

>>> d = opts.get_d(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

d: int

Data segment limit (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_e(i=0)

Get the scheduling priority

Call:

>>> e = opts.get_e(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

e: int

Scheduling priority

Versions:

• 2016-03-13 @ddalle: First version

get_f(i=0)

Get the file size limit, ulimit -f

Call:

>>> f = opts.get_f(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

f: int

Value of the file size limit (blocks)

Versions:

• 2016-03-13 @ddalle: First version

get_file_locks_limit(i=0)

Get the file lock limit

Call:

>>> x = opts.get_x(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

x: int

File lock limit

Versions:

• 2016-03-13 @ddalle: First version

get_file_size(i=0)

Get the file size limit, ulimit -f

Call:

>>> f = opts.get_f(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

f: int

Value of the file size limit (blocks)

Versions:

• 2016-03-13 @ddalle: First version

get_i(i=0)

Get the pending signal limit

Call:

>>> e = opts.get_i(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

e: int

Pending signal limit

Versions:

• 2016-03-13 @ddalle: First version

get_l(i=0)

Get the maximum locked memory

Call:

>>> l = opts.get_l(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

l: int

Maximum locked memory

Versions:

• 2016-03-13 @ddalle: First version

get_m(i=0)

Get the maximum memory size

Call:

>>> m = opts.get_m(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

m: int

Maximum locked memory (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_max_locked_memory(i=0)

Get the maximum locked memory

Call:

>>> l = opts.get_l(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

l: int

Maximum locked memory

Versions:

• 2016-03-13 @ddalle: First version

get_max_memory_size(i=0)

Get the maximum memory size

Call:

>>> m = opts.get_m(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

m: int

Maximum locked memory (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_max_processes(i=0)

Get the maximum number of user processes

Call:

>>> u = opts.get_u(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

u: int

Maximum number of user processes

Versions:

• 2016-03-13 @ddalle: First version

get_messague_queues(i=0)

Get the POSIX message queue limit

Call:

>>> q = opts.get_q(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

q: int

POSIX message queue limit (bytes)

Versions:

• 2016-03-13 @ddalle: First version

get_n(i=0)

Get the maximum number of open files

Call:

>>> n = opts.get_n(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

n: int

Open file number limit

Versions:

• 2016-03-13 @ddalle: First version

get_open_file_limit(i=0)

Get the maximum number of open files

Call:

>>> n = opts.get_n(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

n: int

Open file number limit

Versions:

• 2016-03-13 @ddalle: First version

get_p(i=0)

Get the pipe buffer limit

Call:

>>> p = opts.get_p(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

p: int

Pipe buffer size limit (512 bytes)

Versions:

• 2016-03-13 @ddalle: First version

get_pending_signal_limit(i=0)

Get the pending signal limit

Call:

>>> e = opts.get_i(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

e: int

Pending signal limit

Versions:

• 2016-03-13 @ddalle: First version

get_pipe_size(i=0)

Get the pipe buffer limit

Call:

>>> p = opts.get_p(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

p: int

Pipe buffer size limit (512 bytes)

Versions:

• 2016-03-13 @ddalle: First version

get_q(i=0)

Get the POSIX message queue limit

Call:

>>> q = opts.get_q(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

q: int

POSIX message queue limit (bytes)

Versions:

• 2016-03-13 @ddalle: First version

get_r(i=0)

Get the real-time priority

Call:

>>> r = opts.get_r(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

r: int

Real-time priority

Versions:

• 2016-03-13 @ddalle: First version

get_real_time_priority(i=0)

Get the real-time priority

Call:

>>> r = opts.get_r(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

r: int

Real-time priority

Versions:

• 2016-03-13 @ddalle: First version

get_s(i=0)

Get the stack size limit, ulimit -s

Call:

>>> s = opts.get_s(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

s: int

Value of the stack size limit (kbytes)

Versions:

• 2015-11-10 @ddalle: First version

get_scheduling_priority(i=0)

Get the scheduling priority

Call:

>>> e = opts.get_e(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

e: int

Scheduling priority

Versions:

• 2016-03-13 @ddalle: First version

get_stack_size(i=0)

Get the stack size limit, ulimit -s

Call:

>>> s = opts.get_s(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int or None

Phase number

Outputs:

s: int

Value of the stack size limit (kbytes)

Versions:

• 2015-11-10 @ddalle: First version

get_t(i=0)

Get the maximum CPU time

Call:

>>> n = opts.get_t(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

t: int

CPU time limit (seconds)

Versions:

• 2016-03-13 @ddalle: First version

get_time_limit(i=0)

Get the maximum CPU time

Call:

>>> n = opts.get_t(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

t: int

CPU time limit (seconds)

Versions:

• 2016-03-13 @ddalle: First version

get_u(i=0)

Get the maximum number of user processes

Call:

>>> u = opts.get_u(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

u: int

Maximum number of user processes

Versions:

• 2016-03-13 @ddalle: First version

get_ulimit(u, i=0)

Get a resource limit (ulimit) setting by its command-line flag

Call:

>>> l = opts.get_ulimit(u, i=0)

Inputs:

opts: cape.options.Options

Options interface

u: str

Name of the ulimit flag

i: int or None

Phase number

Outputs:

l: int

Value of the resource limit

Versions:

• 2015-11-10 @ddalle: First version

get_v(i=0)

Get the virtual memory limit

Call:

>>> v = opts.get_v(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

v: int

Virtual memory limit (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_virtual_memory_limit(i=0)

Get the virtual memory limit

Call:

>>> v = opts.get_v(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

v: int

Virtual memory limit (kbytes)

Versions:

• 2016-03-13 @ddalle: First version

get_x(i=0)

Get the file lock limit

Call:

>>> x = opts.get_x(i=None)

Inputs:

opts: cape.options.Options

Options interface

i: int | None

Phase number

Outputs:

x: int

File lock limit

Versions:

• 2016-03-13 @ddalle: First version

set_c(c, i=0)

Get the core file size limit, ulimit -c

Call:

>>> opts.set_c(c, i=None)

Inputs:

opts: cape.options.Options

Options interface

c: int

Value of the core file size limit (blocks)

i: int or None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_core_file_size(c, i=0)

Get the core file size limit, ulimit -c

Call:

>>> opts.set_c(c, i=None)

Inputs:

opts: cape.options.Options

Options interface

c: int

Value of the core file size limit (blocks)

i: int or None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_d(d, i=0)

Set the data segment limit

Call:

>>> opts.set_d(d, i=None)

Inputs:

opts: cape.options.Options

Options interface

d: int

Data segment limit (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_data_seg_limit(d, i=0)

Set the data segment limit

Call:

>>> opts.set_d(d, i=None)

Inputs:

opts: cape.options.Options

Options interface

d: int

Data segment limit (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_e(e, i=0)

Set the data segment limit

Call:

>>> opts.set_e(e, i=None)

Inputs:

opts: cape.options.Options

Options interface

e: int

Scheduling priority

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_f(f, i=0)

Get the file size limit, ulimit -f

Call:

>>> opts.set_f(f, i=None)

Inputs:

opts: cape.options.Options

Options interface

f: int

Value of the file size limit (blocks)

i: int or None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_file_locks_limit(x, i=0)

Set the file lock limit

Call:

>>> opts.set_x(x, i=None)

Inputs:

opts: cape.options.Options

Options interface

x: int

File lock limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_file_size(f, i=0)

Get the file size limit, ulimit -f

Call:

>>> opts.set_f(f, i=None)

Inputs:

opts: cape.options.Options

Options interface

f: int

Value of the file size limit (blocks)

i: int or None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_i(e, i=0)

Set the data segment limit

Call:

>>> opts.set_i(e, i=None)

Inputs:

opts: cape.options.Options

Options interface

e: int

Pending signal limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_l(l, i=0)

Set the maximum locked memory

Call:

>>> opts.set_l(l, i=None)

Inputs:

opts: cape.options.Options

Options interface

l: int

Maximum locked memory

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_m(l, i=0)

Set the maximum memory size

Call:

>>> opts.set_m(m, i=None)

Inputs:

opts: cape.options.Options

Options interface

m: int

Maximum locked memory (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_max_locked_memory(l, i=0)

Set the maximum locked memory

Call:

>>> opts.set_l(l, i=None)

Inputs:

opts: cape.options.Options

Options interface

l: int

Maximum locked memory

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_max_memory_size(l, i=0)

Set the maximum memory size

Call:

>>> opts.set_m(m, i=None)

Inputs:

opts: cape.options.Options

Options interface

m: int

Maximum locked memory (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_max_processes(u, i=0)

Set the maximum number of user processes

Call:

>>> opts.set_u(u, i=None)

Inputs:

opts: cape.options.Options

Options interface

u: int

Maximum number of user processes

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_messague_queues(q, i=0)

Set the maximum memory size

Call:

>>> opts.set_q(q, i=None)

Inputs:

opts: cape.options.Options

Options interface

q: int

POSIX message queue limit (bytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_n(n, i=0)

Set the maximum number of open files

Call:

>>> opts.set_n(n, i=None)

Inputs:

opts: cape.options.Options

Options interface

n: int

Open file number limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_open_file_limit(n, i=0)

Set the maximum number of open files

Call:

>>> opts.set_n(n, i=None)

Inputs:

opts: cape.options.Options

Options interface

n: int

Open file number limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_p(p, i=0)

Set the pipe buffer limit

Call:

>>> opts.set_p(p, i=None)

Inputs:

opts: cape.options.Options

Options interface

p: int

Pipe buffer size limit (512 bytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_pending_signal_limit(e, i=0)

Set the data segment limit

Call:

>>> opts.set_i(e, i=None)

Inputs:

opts: cape.options.Options

Options interface

e: int

Pending signal limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_pipe_size(p, i=0)

Set the pipe buffer limit

Call:

>>> opts.set_p(p, i=None)

Inputs:

opts: cape.options.Options

Options interface

p: int

Pipe buffer size limit (512 bytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_q(q, i=0)

Set the maximum memory size

Call:

>>> opts.set_q(q, i=None)

Inputs:

opts: cape.options.Options

Options interface

q: int

POSIX message queue limit (bytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_r(r, i=0)

Set the maximum memory size

Call:

>>> opts.set_r(r, i=None)

Inputs:

opts: cape.options.Options

Options interface

r: int

Real-time priority

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_real_time_priority(r, i=0)

Set the maximum memory size

Call:

>>> opts.set_r(r, i=None)

Inputs:

opts: cape.options.Options

Options interface

r: int

Real-time priority

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_s(s, i=0)

Get the stack size limit, ulimit -s

Call:

>>> opts.set_s(s, i=None)

Inputs:

opts: cape.options.Options

Options interface

s: int

Value of the stack size limit (kbytes)

i: int or None

Phase number

Versions:

• 2015-11-10 @ddalle: First version

set_scheduling_priority(e, i=0)

Set the data segment limit

Call:

>>> opts.set_e(e, i=None)

Inputs:

opts: cape.options.Options

Options interface

e: int

Scheduling priority

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_stack_size(s, i=0)

Get the stack size limit, ulimit -s

Call:

>>> opts.set_s(s, i=None)

Inputs:

opts: cape.options.Options

Options interface

s: int

Value of the stack size limit (kbytes)

i: int or None

Phase number

Versions:

• 2015-11-10 @ddalle: First version

set_t(t, i=0)

Set the maximum CPU time

Call:

>>> opts.set_t(t, i=None)

Inputs:

opts: cape.options.Options

Options interface

t: int

CPU time limit (seconds)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_time_limit(t, i=0)

Set the maximum CPU time

Call:

>>> opts.set_t(t, i=None)

Inputs:

opts: cape.options.Options

Options interface

t: int

CPU time limit (seconds)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_u(u, i=0)

Set the maximum number of user processes

Call:

>>> opts.set_u(u, i=None)

Inputs:

opts: cape.options.Options

Options interface

u: int

Maximum number of user processes

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_ulimit(u, l=None, i=None)

Set a resource limit (ulimit) setting by its command-line flag

Call:

>>> opts.set_ulimit(u, l=None, i=None)

Inputs:

opts: cape.options.Options

Options interface

u: str

Name of the ulimit flag

l: int

Value of the limit

i: int or None

Phase number

Versions:

• 2015-11-10 @ddalle: First version

set_v(v, i=0)

Set the virtual memory limit

Call:

>>> opts.set_r(r, i=None)

Inputs:

opts: cape.options.Options

Options interface

v: int

Virtual memory limit (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_virtual_memory_limit(v, i=0)

Set the virtual memory limit

Call:

>>> opts.set_r(r, i=None)

Inputs:

opts: cape.options.Options

Options interface

v: int

Virtual memory limit (kbytes)

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version

set_x(x, i=0)

Set the file lock limit

Call:

>>> opts.set_x(x, i=None)

Inputs:

opts: cape.options.Options

Options interface

x: int

File lock limit

i: int | None

Phase number

Versions:

• 2016-03-13 @ddalle: First version