xnu-4903.270.47.tar.gz

[apple/xnu.git] / libkern / kxld / kxld_array.h

diff --git a/libkern/kxld/kxld_array.h b/libkern/kxld/kxld_array.h
index f73bc8607808793afec6c6636fec53e07a841d7c..ae01bdd1614672a2e95ff07d94de97182dfe9e5f 100644 (file)
--- a/libkern/kxld/kxld_array.h
+++ b/libkern/kxld/kxld_array.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2008 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 2008 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

- * 
+ *

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in


@@ -11,10 +11,10 @@
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.

- * 
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -22,7 +22,7 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
+ *

  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 #ifndef _KXLD_ARRAY_H_
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 #ifndef _KXLD_ARRAY_H_


@@ -32,7 +32,7 @@
 #include <sys/types.h>
 #if KERNEL
     #include <libkern/kxld_types.h>
 #include <sys/types.h>
 #if KERNEL
     #include <libkern/kxld_types.h>

-#else 
+#else

     #include "kxld_types.h"
 #endif
 
     #include "kxld_types.h"
 #endif
 


@@ -46,15 +46,15 @@
 * one large array in the init function.
 *
 * A technique commonly used in kxld is to make an array of objects that
 * one large array in the init function.
 *
 * A technique commonly used in kxld is to make an array of objects that

-* themselves contain kxld_arrays.  To minimize memory churn across links, only 
+* themselves contain kxld_arrays.  To minimize memory churn across links, only

 * the individual objects contained in an array should be cleared at the end of
 * the individual objects contained in an array should be cleared at the end of

-* each link, such that they are in a state ready for reinitialization with the 
-* memory they have already allocated.  The array that contains them should not 
-* be cleared.  After all links are complete, to ensure that all memory is 
-* properly freed, one should call kxld_array_get_slot to walk the entire 
-* allocated space of the array and clean up all potential instances contained 
-* therein.  Since this technique is somewhat fragile, there are certain 
-* requirements that must be met, and guarantees that the array implementation 
+* each link, such that they are in a state ready for reinitialization with the
+* memory they have already allocated.  The array that contains them should not
+* be cleared.  After all links are complete, to ensure that all memory is
+* properly freed, one should call kxld_array_get_slot to walk the entire
+* allocated space of the array and clean up all potential instances contained
+* therein.  Since this technique is somewhat fragile, there are certain
+* requirements that must be met, and guarantees that the array implementation

 * provides.
 *
 * Requirements:
 * provides.
 *
 * Requirements:


@@ -76,21 +76,21 @@
 STAILQ_HEAD(kxld_array_head, kxld_array_pool);
 
 struct kxld_array {
 STAILQ_HEAD(kxld_array_head, kxld_array_pool);
 
 struct kxld_array {

-    struct kxld_array_head pools;
-    size_t itemsize;            /* The size of the items that the array contains */
-    size_t pool_capacity;       /* The size of each pool's internal buffer */
-    u_int pool_maxitems;        /* The maximum number of items each pool can hold
-                                 * given the current size of each pool's buffer.
-                                 */
-    u_int nitems;               /* The current number of items this array contains */
-    u_int maxitems;             /* The maximum number of items this array can contain */
-    u_int npools;               /* The number of pools in the pool list */
+       struct kxld_array_head pools;
+       size_t itemsize;        /* The size of the items that the array contains */
+       size_t pool_capacity;   /* The size of each pool's internal buffer */
+       u_int pool_maxitems;    /* The maximum number of items each pool can hold
+                                * given the current size of each pool's buffer.
+                                */
+       u_int nitems;           /* The current number of items this array contains */
+       u_int maxitems;         /* The maximum number of items this array can contain */
+       u_int npools;           /* The number of pools in the pool list */

 };
 
 struct kxld_array_pool {
 };
 
 struct kxld_array_pool {

-    STAILQ_ENTRY(kxld_array_pool) entries;
-    u_char *buffer;             /* The internal memory buffer */
-    u_int nitems;               /* The number of items the array contains */
+       STAILQ_ENTRY(kxld_array_pool) entries;
+       u_char *buffer;         /* The internal memory buffer */
+       u_int nitems;           /* The number of items the array contains */

 };
 
 typedef struct kxld_array KXLDArray;
 };
 
 typedef struct kxld_array KXLDArray;


@@ -103,40 +103,40 @@ typedef struct kxld_array_pool KXLDArrayPool;
 
 /* Initializes the array's capacity to a minimum of nitems * itemsize */
 kern_return_t kxld_array_init(KXLDArray *array, size_t itemsize, u_int nitems)
 
 /* Initializes the array's capacity to a minimum of nitems * itemsize */
 kern_return_t kxld_array_init(KXLDArray *array, size_t itemsize, u_int nitems)

-    __attribute__((nonnull, visibility("hidden")));
+__attribute__((nonnull, visibility("hidden")));

 
 /* Performs a deep copy of the array */
 kern_return_t kxld_array_copy(KXLDArray *array, const KXLDArray *src)
 
 /* Performs a deep copy of the array */
 kern_return_t kxld_array_copy(KXLDArray *array, const KXLDArray *src)

-    __attribute__((nonnull, visibility("hidden")));
+__attribute__((nonnull, visibility("hidden")));

 
 /* Sets the number of items in the array to 0 */
 void kxld_array_reset(KXLDArray *array)
 
 /* Sets the number of items in the array to 0 */
 void kxld_array_reset(KXLDArray *array)

-    __attribute__((visibility("hidden")));
+__attribute__((visibility("hidden")));

 
 /* Zeroes out the array and sets nitems to 0 */
 void kxld_array_clear(KXLDArray *array)
 
 /* Zeroes out the array and sets nitems to 0 */
 void kxld_array_clear(KXLDArray *array)

-    __attribute__((visibility("hidden")));
+__attribute__((visibility("hidden")));

 
 /* Frees the array's internal buffer */
 void kxld_array_deinit(KXLDArray *array)
 
 /* Frees the array's internal buffer */
 void kxld_array_deinit(KXLDArray *array)

-    __attribute__((visibility("hidden")));
+__attribute__((visibility("hidden")));

 
 /*******************************************************************************
 
 /*******************************************************************************

-* Accessors 
+* Accessors

 *******************************************************************************/
 
 /* Returns the item at the specified index, or NULL if idx > nitems */
 void *kxld_array_get_item(const KXLDArray *array, u_int idx)
 *******************************************************************************/
 
 /* Returns the item at the specified index, or NULL if idx > nitems */
 void *kxld_array_get_item(const KXLDArray *array, u_int idx)

-    __attribute__((pure, nonnull, visibility("hidden")));
+__attribute__((pure, nonnull, visibility("hidden")));

 
 /* Returns the item at the specified index, or NULL if idx > maxitems */
 void *kxld_array_get_slot(const KXLDArray *array, u_int idx)
 
 /* Returns the item at the specified index, or NULL if idx > maxitems */
 void *kxld_array_get_slot(const KXLDArray *array, u_int idx)

-    __attribute__((pure, nonnull, visibility("hidden")));
+__attribute__((pure, nonnull, visibility("hidden")));

 
 /* Returns the index of a specified item in the array */
 
 /* Returns the index of a specified item in the array */

-kern_return_t kxld_array_get_index(const KXLDArray *array, const void *item, 
+kern_return_t kxld_array_get_index(const KXLDArray *array, const void *item,

     u_int *idx)
     u_int *idx)

-    __attribute__((nonnull, visibility("hidden")));
+__attribute__((nonnull, visibility("hidden")));

 
 /*******************************************************************************
 * Modifiers
 
 /*******************************************************************************
 * Modifiers


@@ -147,12 +147,12 @@ kern_return_t kxld_array_get_index(const KXLDArray *array, const void *item,
  * array.
  */
 kern_return_t kxld_array_resize(KXLDArray *array, u_int nitems)
  * array.
  */
 kern_return_t kxld_array_resize(KXLDArray *array, u_int nitems)

-    __attribute__((nonnull, visibility("hidden")));
+__attribute__((nonnull, visibility("hidden")));

 
 /* Removes an element from the array.  This is only supported for arrays with
  * a single pool.
  */
 kern_return_t kxld_array_remove(KXLDArray *array, u_int idx)
 
 /* Removes an element from the array.  This is only supported for arrays with
  * a single pool.
  */
 kern_return_t kxld_array_remove(KXLDArray *array, u_int idx)

-    __attribute__((nonnull, visibility("hidden")));
+__attribute__((nonnull, visibility("hidden")));

 
 #endif /* _KXLD_ARRAY_H_ */
 
 #endif /* _KXLD_ARRAY_H_ */