Documentation: Describe CmiAlloc's limited purpose
authorPhil Miller <mille121@illinois.edu>
Fri, 6 Nov 2009 01:36:50 +0000 (01:36 +0000)
committerPhil Miller <mille121@illinois.edu>
Fri, 6 Nov 2009 01:36:50 +0000 (01:36 +0000)
src/conv-core/converse.h

index ca3a566b73dafe23e84ea77f6f13294b1f64de70..df4c609923697531bcc6ba9fbe87b53830059599 100644 (file)
@@ -625,6 +625,15 @@ struct infiCmiChunkMetaDataStruct *registerMultiSendMesg(char *msg,int msgSize);
 
 extern void* malloc_nomigrate(size_t size);
 
+/**
+   Allocate `size` bytes of memory usable as a message buffer.
+
+   Such memory may be in limited supply and expensive to obtain on
+   machine layers that use registered or pinned memory when
+   interacting with the communication hardware. Uses besides buffers
+   in which to construct messages should prefer the malloc()/free()
+   provided by libmemory-*.
+*/
 void    *CmiAlloc(int size);
 void     CmiReference(void *blk);
 int      CmiSize(void *blk);