Changeset 570:b66e5f9178f9

Timestamp:

06/02/08 01:30:18 (7 months ago)

Author:

David Anderson <dave@…>

Branch:

default

Message:

Tighten up the memory allocator documentation.

Update copyright notices in consequence.

Location:

nxos/base

Files:

• memalloc.c (modified) (2 diffs)
• memalloc.h (modified) (3 diffs)

nxos/base/memalloc.c

@@ -1 @@
-/* Copyright (C) 2007 the NxOS developers
+/* Copyright (c) 2007,2008 the NxOS developers
  *
  * See AUTHORS for a full list of the developers.
@@ -23 +23 @@
 #include "base/_tlsf.c.inc"
 
+inline void nx_memalloc_init_full(void *mem_pool, U32 mem_pool_size) {
+  size_t size = init_memory_pool(mem_pool_size, mem_pool);
+  NX_ASSERT_MSG(size > 0, "Failed to init\nmemory allocator");
+}
+
 void nx_memalloc_init(void) {
   nx_memalloc_init_full(NX_USERSPACE_START, NX_USERSPACE_SIZE);
-}
-
-void nx_memalloc_init_full(void *mem_pool, U32 mem_pool_size) {
-  size_t size = init_memory_pool(mem_pool_size, mem_pool);
-  NX_ASSERT_MSG(size > 0, "Failed to init\nmemory allocator");
 }
 

nxos/base/memalloc.h

@@ -3 +3 @@
  */
 
-/* Copyright (C) 2007 the NxOS developers
+/* Copyright (c) 2007,2008 the NxOS developers
  *
  * See AUTHORS for a full list of the developers.
@@ -34 +34 @@
  * other functions of the allocator assume that the allocator is
  * initialized.
+ *
+ * @warning The memory allocator is @b not safe for concurrent
+ * access. You must provide your own locking around it if you are
+ * going to use it from concurrent contexts. Also be aware that this
+ * means you cannot use the allocator from within interrupt handlers
+ * (accessing already allocated memory is fine).
  */
 /*@{*/
@@ -40 +46 @@
 /*@{*/
 
-/* Initialize the allocator's memory pool.
+/** Initialize the allocator's memory pool.
  *
- * After this call, the memory defined in memmap.h as userspace
- * (NX_USERSPACE_START through NX_USERSPACE_END) should no longer be
- * used directly, since it is under the control of the memory allocator.
+ * After this call, the memory defined in memmap.h as userspace (@a
+ * NX_USERSPACE_START through @a NX_USERSPACE_END) should no longer be
+ * used directly, since it is under the control of the memory
+ * allocator.
  *
  * @sa nx_memalloc_init_full()