/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef ISC_RESOURCE_H

[12] Fix | Delete

#define ISC_RESOURCE_H 1

[13] Fix | Delete

[14] Fix | Delete

/*! \file isc/resource.h */

[15] Fix | Delete

[16] Fix | Delete

#include <isc/lang.h>

[17] Fix | Delete

#include <isc/types.h>

[18] Fix | Delete

[19] Fix | Delete

#define ISC_RESOURCE_UNLIMITED ((isc_resourcevalue_t)UINT64_MAX)

[20] Fix | Delete

[21] Fix | Delete

ISC_LANG_BEGINDECLS

[22] Fix | Delete

[23] Fix | Delete

isc_result_t

[24] Fix | Delete

isc_resource_setlimit(isc_resource_t resource, isc_resourcevalue_t value);

[25] Fix | Delete

/*%<

[26] Fix | Delete

* Set the maximum limit for a system resource.

[27] Fix | Delete

*

[28] Fix | Delete

* Notes:

[29] Fix | Delete

*\li If 'value' exceeds the maximum possible on the operating system,

[30] Fix | Delete

* it is silently limited to that maximum -- or to "infinity", if

[31] Fix | Delete

* the operating system has that concept. #ISC_RESOURCE_UNLIMITED

[32] Fix | Delete

* can be used to explicitly ask for the maximum.

[33] Fix | Delete

*

[34] Fix | Delete

* Requires:

[35] Fix | Delete

*\li 'resource' is a valid member of the isc_resource_t enumeration.

[36] Fix | Delete

*

[37] Fix | Delete

* Returns:

[38] Fix | Delete

*\li #ISC_R_SUCCESS Success.

[39] Fix | Delete

*\li #ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.

[40] Fix | Delete

*\li #ISC_R_NOPERM The calling process did not have adequate permission

[41] Fix | Delete

* to change the resource limit.

[42] Fix | Delete

*/

[43] Fix | Delete

[44] Fix | Delete

isc_result_t

[45] Fix | Delete

isc_resource_getlimit(isc_resource_t resource, isc_resourcevalue_t *value);

[46] Fix | Delete

/*%<

[47] Fix | Delete

* Get the maximum limit for a system resource.

[48] Fix | Delete

*

[49] Fix | Delete

* Notes:

[50] Fix | Delete

*\li 'value' is set to the maximum limit.

[51] Fix | Delete

*

[52] Fix | Delete

*\li #ISC_RESOURCE_UNLIMITED is the maximum value of isc_resourcevalue_t.

[53] Fix | Delete

*

[54] Fix | Delete

*\li On many (all?) Unix systems, RLIM_INFINITY is a valid value that is

[55] Fix | Delete

* significantly less than #ISC_RESOURCE_UNLIMITED, but which in practice

[56] Fix | Delete

* behaves the same.

[57] Fix | Delete

*

[58] Fix | Delete

*\li The current ISC libdns configuration file parser assigns a value

[59] Fix | Delete

* of UINT32_MAX for a size_spec of "unlimited" and ISC_UNIT32_MAX - 1

[60] Fix | Delete

* for "default", the latter of which is supposed to represent "the

[61] Fix | Delete

* limit that was in force when the server started". Since these are

[62] Fix | Delete

* valid values in the middle of the range of isc_resourcevalue_t,

[63] Fix | Delete

* there is the possibility for confusion over what exactly those

[64] Fix | Delete

* particular values are supposed to represent in a particular context --

[65] Fix | Delete

* discrete integral values or generalized concepts.

[66] Fix | Delete

*

[67] Fix | Delete

* Requires:

[68] Fix | Delete

*\li 'resource' is a valid member of the isc_resource_t enumeration.

[69] Fix | Delete

*

[70] Fix | Delete

* Returns:

[71] Fix | Delete

*\li #ISC_R_SUCCESS Success.

[72] Fix | Delete

*\li #ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.

[73] Fix | Delete

*/

[74] Fix | Delete

[75] Fix | Delete

isc_result_t

[76] Fix | Delete

isc_resource_getcurlimit(isc_resource_t resource, isc_resourcevalue_t *value);

[77] Fix | Delete

/*%<

[78] Fix | Delete

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

[79] Fix | Delete

*

[80] Fix | Delete

* Returns:

[81] Fix | Delete

*\li #ISC_R_SUCCESS Success.

[82] Fix | Delete

*\li #ISC_R_NOTIMPLEMENTED 'resource' is not a type known by the OS.

[83] Fix | Delete

*/

[84] Fix | Delete

[85] Fix | Delete

ISC_LANG_ENDDECLS

[86] Fix | Delete

[87] Fix | Delete

#endif /* ISC_RESOURCE_H */

[88] Fix | Delete

[89] Fix | Delete

[90] Fix | Delete