star-enclosures-3d

commit a0ecdeb6e5a6b0c7828443115e6fc6431c9f893f
parent b7cfffc80eb3a2bd761f052be68f4abce343f027
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Fri, 23 Feb 2018 14:11:01 +0100

Add a comment on allocator in the API header file.

Diffstat:
M
src/senc.h
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/senc.h b/src/senc.h
@@ -78,12 +78,14 @@ BEGIN_DECLS
 /*******************************************************************************
  * StarEnclosures device. It is an handle toward the StarEnc library.
  * It manages the lib resources.
+ * If provided, the allocator has to be suitable for parallel high frequency
+ * allocations. As a consequence, a rsys proxy allocator should be avoided.
  ******************************************************************************/
 SENC_API res_T
 senc_device_create
   (struct logger* logger, /* May be NULL <=> use default logger */
    struct mem_allocator* allocator, /* May be NULL <=> use default allocator */
-   const unsigned nthreads_hint, /* UNUSED */
+   const unsigned nthreads_hint,
    const int verbose,
    struct senc_device** device);