bind/lib/isc/include/isc/mutexblock.h

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#pragma once

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

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

void
isc_mutexblock_init(isc_mutex_t *block, unsigned int count);
/*%<
 * Initialize a block of locks.  If an error occurs all initialized locks
 * will be destroyed, if possible.
 *
 * Requires:
 *
 *\li	block != NULL
 *
 *\li	count > 0
 *
 */

void
isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count);
/*%<
 * Destroy a block of locks.
 *
 * Requires:
 *
 *\li	block != NULL
 *
 *\li	count > 0
 *
 *\li	Each lock in the block be initialized via isc_mutex_init() or
 * 	the whole block was initialized via isc_mutex_initblock().
 *
 */
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`/*`
update copyright notice 2006-12-22 01:59:44 +00:00			`* Copyright (C) Internet Systems Consortium, Inc. ("ISC")`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`*`
			`* SPDX-License-Identifier: MPL-2.0`
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files. 2021-06-03 08:37:05 +02:00			`*`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`* This Source Code Form is subject to the terms of the Mozilla Public`
			`* License, v. 2.0. If a copy of the MPL was not distributed with this`
			`* file, you can obtain one at https://mozilla.org/MPL/2.0/.`
Update license headers to not include years in copyright in all applicable files 2018-02-23 09:53:12 +01:00			`*`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`* See the COPYRIGHT file distributed with this work for additional`
			`* information regarding copyright ownership.`
			`*/`

Use #pragma once as header guards Unify the header guard style and replace the inconsistent include guards with #pragma once. The #pragma once is widely and very well supported in all compilers that BIND 9 supports, and #pragma once was already in use in several new or refactored headers. Using simpler method will also allow us to automate header guard checks as this is simpler to programatically check. For reference, here are the reasons for the change taken from Wikipedia[1]: > In the C and C++ programming languages, #pragma once is a non-standard > but widely supported preprocessor directive designed to cause the > current source file to be included only once in a single compilation. > > Thus, #pragma once serves the same purpose as include guards, but with > several advantages, including: less code, avoidance of name clashes, > and sometimes improvement in compilation speed. On the other hand, > #pragma once is not necessarily available in all compilers and its > implementation is tricky and might not always be reliable. 1. https://en.wikipedia.org/wiki/Pragma_once 2021-10-05 16:49:47 +02:00			`#pragma once`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00
2123. [func] Use Doxygen to generate internal documention. [RT #11398] 2006-12-22 01:46:19 +00:00			`/! \file isc/mutexblock.h /`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`#include <isc/mutex.h>`
<isc/mutex.h> does not need <isc/lang.h> or <isc/result.h>. 2000-04-26 01:29:27 +00:00			`#include <isc/types.h>`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00
- Make isc_mutex_destroy return void - Make isc_mutexblock_init/destroy return void - Minor cleanups 2018-11-19 10:31:09 +00:00			`void`
I just can't win today. Remove redundant 'block' from function names. 1999-09-24 23:47:21 +00:00			`isc_mutexblock_init(isc_mutex_t *block, unsigned int count);`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`/*%<`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`* Initialize a block of locks. If an error occurs all initialized locks`
			`* will be destroyed, if possible.`
			`*`
			`* Requires:`
			`*`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`*\li block != NULL`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`*`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`*\li count > 0`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`*`
			`*/`

- Make isc_mutex_destroy return void - Make isc_mutexblock_init/destroy return void - Minor cleanups 2018-11-19 10:31:09 +00:00			`void`
I just can't win today. Remove redundant 'block' from function names. 1999-09-24 23:47:21 +00:00			`isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count);`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`/*%<`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`* Destroy a block of locks.`
			`*`
			`* Requires:`
			`*`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`*\li block != NULL`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`*`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`*\li count > 0`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`*`
1851. [doc] Doxygen comment markup. [RT #11398] 2005-04-27 04:57:32 +00:00			`*\li Each lock in the block be initialized via isc_mutex_init() or`
add a function to initialize a block of mutexes, and to destroy them. 1999-09-24 23:26:23 +00:00			`* the whole block was initialized via isc_mutex_initblock().`
			`*`
			`*/`