resource.h File Reference

#include <isc/lang.h>
#include <isc/types.h>

Go to the source code of this file.

Defines
#define	ISC_RESOURCE_H   1
#define	ISC_RESOURCE_UNLIMITED   ((isc_resourcevalue_t)ISC_UINT64_MAX)
Functions
ISC_LANG_BEGINDECLS isc_result_t	isc_resource_setlimit (isc_resource_t resource, isc_resourcevalue_t value)
	Set the maximum limit for a system resource.
isc_result_t	isc_resource_getlimit (isc_resource_t resource, isc_resourcevalue_t *value)
	Get the maximum limit for a system resource.
isc_result_t	isc_resource_getcurlimit (isc_resource_t resource, isc_resourcevalue_t *value)
	Same as isc_resource_getlimit(), but returns the current (soft) limit.

---

Detailed Description

Definition in file resource.h.

---

Define Documentation

#define ISC_RESOURCE_H   1

Definition at line 21 of file resource.h.

#define ISC_RESOURCE_UNLIMITED   ((isc_resourcevalue_t)ISC_UINT64_MAX)

Definition at line 28 of file resource.h.

Referenced by isc_resource_setlimit(), ns_os_adjustnofile(), and set_limit().

---

Function Documentation

ISC_LANG_BEGINDECLS isc_result_t isc_resource_setlimit	(	isc_resource_t	resource,
		isc_resourcevalue_t	value
	)

Set the maximum limit for a system resource.

Notes:

• If 'value' exceeds the maximum possible on the operating system, it is silently limited to that maximum -- or to "infinity", if the operating system has that concept. ISC_RESOURCE_UNLIMITED can be used to explicitly ask for the maximum.

Requires:

• 'resource' is a valid member of the isc_resource_t enumeration.

Returns:

• ISC_R_SUCCESS Success.
• ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.
• ISC_R_NOPERM The calling process did not have adequate permission to change the resource limit.

Definition at line 105 of file resource.c.

References isc__errno2result, ISC_PLATFORM_RLIMITTYPE, ISC_R_SUCCESS, isc_resource_openfiles, ISC_RESOURCE_UNLIMITED, ISC_TF, and resource2rlim().

Referenced by ns_os_adjustnofile(), and set_limit().

isc_result_t isc_resource_getlimit	(	isc_resource_t	resource,
		isc_resourcevalue_t *	value
	)

Get the maximum limit for a system resource.

Notes:

• 'value' is set to the maximum limit.

• ISC_RESOURCE_UNLIMITED is the maximum value of isc_resourcevalue_t.

• On many (all?) Unix systems, RLIM_INFINITY is a valid value that is significantly less than ISC_RESOURCE_UNLIMITED, but which in practice behaves the same.

• The current ISC libdns configuration file parser assigns a value of ISC_UINT32_MAX for a size_spec of "unlimited" and ISC_UNIT32_MAX - 1 for "default", the latter of which is supposed to represent "the limit that was in force when the server started". Since these are valid values in the middle of the range of isc_resourcevalue_t, there is the possibility for confusion over what exactly those particular values are supposed to represent in a particular context -- discrete integral values or generalized concepts.

Requires:

• 'resource' is a valid member of the isc_resource_t enumeration.

Returns:

• ISC_R_SUCCESS Success.
• ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.

Definition at line 200 of file resource.c.

References INSIST, ISC_R_SUCCESS, and resource2rlim().

Referenced by setup().

isc_result_t isc_resource_getcurlimit	(	isc_resource_t	resource,
		isc_resourcevalue_t *	value
	)

Same as isc_resource_getlimit(), but returns the current (soft) limit.

Returns:

• ISC_R_SUCCESS Success.
• ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.

Definition at line 217 of file resource.c.

References INSIST, ISC_R_SUCCESS, and resource2rlim().

Referenced by isc__socketmgr_waitevents(), load_configuration(), and setup_watcher().

---