contrib/ofed/management/libibumad/man/umad_alloc.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_ALLOC 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_alloc \- allocate memory for umad buffers
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "void * umad_alloc(int " "num" ", size_t " "size");
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_alloc()
  14 allocates memory for an array of
  15 .I num\fR
  16 umad buffers of
  17 .I size
  18 bytes\fR.
  19 Note that
  20 .I size\fR
  21 should include the
  22 .B umad_size()
  23 plus the length (MAD_BLOCK_SIZE for normal MADs or the length returned from
  24 .B umad_recv()
  25 for RMPP MADs).
  26 .SH "RETURN VALUE"
  27 .B umad_alloc()
  28 returns NULL if out of memory.
  29 .SH "SEE ALSO"
  30 .BR umad_free (3)
  31 .SH "AUTHOR"
  32 .TP
  33 Hal Rosenstock <halr@voltaire.com>