original/man2/recvmmsg.2

   1 .\" Copyright (C) 2011 by Andi Kleen <andi@firstfloor.org>
   2 .\" and Copyright (c) 2011 by Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Syscall added in following commit
  27 .\"     commit a2e2725541fad72416326798c2d7fa4dafb7d337
  28 .\"     Author: Arnaldo Carvalho de Melo <acme@redhat.com>
  29 .\"     Date:   Mon Oct 12 23:40:10 2009 -0700
  30 .\"
  31 .TH RECVMMSG 2 2012-12-24 "Linux" "Linux Programmer's Manual"
  32 .SH NAME
  33 recvmmsg \- receive multiple messages on a socket
  34 .SH SYNOPSIS
  35 .nf
  36 .B "#define _GNU_SOURCE"
  37 .BI "#include <sys/socket.h>"
  38
  39 .BI "int recvmmsg(int " sockfd ", struct mmsghdr *" msgvec \
  40 ", unsigned int " vlen ","
  41 .br
  42 .BI "             unsigned int " flags ", struct timespec *" timeout ");"
  43 .fi
  44 .SH DESCRIPTION
  45 The
  46 .BR recvmmsg ()
  47 system call is an extension of
  48 .BR recvmsg (2)
  49 that allows the caller to receive multiple messages from a socket
  50 using a single system call.
  51 (This has performance benefits for some applications.)
  52 A further extension over
  53 .BR recvmsg (2)
  54 is support for a timeout on the receive operation.
  55
  56 The
  57 .I sockfd
  58 argument is the file descriptor of the socket to receive data from.
  59
  60 The
  61 .I msgvec
  62 argument is a pointer to an array of
  63 .I mmsghdr
  64 structures.
  65 The size of this array is specified in
  66 .IR vlen .
  67
  68 The
  69 .I mmsghdr
  70 structure is defined in
  71 .I <sys/socket.h>
  72 as:
  73
  74 .in +4n
  75 .nf
  76 struct mmsghdr {
  77     struct msghdr msg_hdr;  /* Message header */
  78     unsigned int  msg_len;  /* Number of received bytes for header */
  79 };
  80 .fi
  81 .in
  82 .PP
  83 The
  84 .I msg_hdr
  85 field is a
  86 .I msghdr
  87 structure, as described in
  88 .BR recvmsg (2).
  89 The
  90 .I msg_len
  91 field is the number of bytes returned for the message in the entry.
  92 This field has the same value as the return value of a single
  93 .BR recvmsg (2)
  94 on the header.
  95
  96 The
  97 .I flags
  98 argument contains flags ORed together.
  99 The flags are the same as documented for
 100 .BR recvmsg (2),
 101 with the following addition:
 102 .TP
 103 .BR MSG_WAITFORONE " (since Linux 2.6.34)"
 104 Turns on
 105 .B MSG_DONTWAIT
 106 after the first message has been received.
 107 .PP
 108 The
 109 .I timeout
 110 argument points to a
 111 .I struct timespec
 112 (see
 113 .BR clock_gettime (2))
 114 defining a timeout (seconds plus nanoseconds) for the receive operation.
 115 (This interval will be rounded up to the system clock granularity,
 116 and kernel scheduling delays mean that the blocking interval
 117 may overrun by a small amount.)
 118 If
 119 .I timeout
 120 is
 121 .I NULL
 122 then the operation blocks indefinitely.
 123
 124 A blocking
 125 .BR recvmmsg ()
 126 call blocks until
 127 .I vlen
 128 messages have been received
 129 or until the timeout expires.
 130 A nonblocking call reads as many messages as are available
 131 (up to the limit specified by
 132 .IR vlen )
 133 and returns immediately.
 134
 135 On return from
 136 .BR recvmmsg (),
 137 successive elements of
 138 .IR msgvec
 139 are updated to contain information about each received message:
 140 .I msg_len
 141 contains the size of the received message;
 142 the subfields of
 143 .I msg_hdr
 144 are updated as described in
 145 .BR recvmsg (2).
 146 The return value of the call indicates the number of elements of
 147 .I msgvec
 148 that have been updated.
 149 .SH RETURN VALUE
 150 On success,
 151 .BR recvmmsg ()
 152 returns the number of messages received in
 153 .IR msgvec ;
 154 on error, \-1 is returned, and
 155 .I errno
 156 is set to indicate the error.
 157 .SH ERRORS
 158 Errors are as for
 159 .BR recvmsg (2).
 160 In addition, the following error can occur:
 161 .TP
 162 .B EINVAL
 163 .I timeout
 164 is invalid.
 165 .SH VERSIONS
 166 The
 167 .BR recvmmsg ()
 168 system call was added in Linux 2.6.33.
 169 Support in glibc was added in version 2.12.
 170 .SH CONFORMING TO
 171 .BR recvmmsg ()
 172 is Linux-specific.
 173 .SH EXAMPLE
 174 .PP
 175 The following program uses
 176 .BR recvmmsg ()
 177 to receive multiple messages on a socket and stores
 178 them in multiple buffers.
 179 The call returns if all buffers are filled or if the
 180 timeout specified has expired.
 181
 182 The following snippet periodically generates UDP datagrams
 183 containing a random number:
 184 .in +4n
 185 .nf
 186
 187 .RB "$" " while true; do echo $RANDOM > /dev/udp/127.0.0.1/1234; "
 188 .B      "      sleep 0.25; done"
 189 .fi
 190 .in
 191
 192 These datagrams are read by the example application, which
 193 can give the following output:
 194 .in +4n
 195 .nf
 196
 197 .RB "$" " ./a.out"
 198 5 messages received
 199 1 11782
 200 2 11345
 201 3 304
 202 4 13514
 203 5 28421
 204 .fi
 205 .in
 206 .SS Program source
 207 \&
 208 .nf
 209 #define _GNU_SOURCE
 210 #include <netinet/ip.h>
 211 #include <stdio.h>
 212 #include <stdlib.h>
 213 #include <string.h>
 214 #include <sys/socket.h>
 215
 216 int
 217 main(void)
 218 {
 219 #define VLEN 10
 220 #define BUFSIZE 200
 221 #define TIMEOUT 1
 222     int sockfd, retval, i;
 223     struct sockaddr_in sa;
 224     struct mmsghdr msgs[VLEN];
 225     struct iovec iovecs[VLEN];
 226     char bufs[VLEN][BUFSIZE+1];
 227     struct timespec timeout;
 228
 229     sockfd = socket(AF_INET, SOCK_DGRAM, 0);
 230     if (sockfd == \-1) {
 231         perror("socket()");
 232         exit(EXIT_FAILURE);
 233     }
 234
 235     sa.sin_family = AF_INET;
 236     sa.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 237     sa.sin_port = htons(1234);
 238     if (bind(sockfd, (struct sockaddr *) &sa, sizeof(sa)) == \-1) {
 239         perror("bind()");
 240         exit(EXIT_FAILURE);
 241     }
 242
 243     memset(msgs, 0, sizeof(msgs));
 244     for (i = 0; i < VLEN; i++) {
 245         iovecs[i].iov_base         = bufs[i];
 246         iovecs[i].iov_len          = BUFSIZE;
 247         msgs[i].msg_hdr.msg_iov    = &iovecs[i];
 248         msgs[i].msg_hdr.msg_iovlen = 1;
 249     }
 250
 251     timeout.tv_sec = TIMEOUT;
 252     timeout.tv_nsec = 0;
 253
 254     retval = recvmmsg(sockfd, msgs, VLEN, 0, &timeout);
 255     if (retval == \-1) {
 256         perror("recvmmsg()");
 257         exit(EXIT_FAILURE);
 258     }
 259
 260     printf("%d messages received\\n", retval);
 261     for (i = 0; i < retval; i++) {
 262         bufs[i][msgs[i].msg_len] = 0;
 263         printf("%d %s", i+1, bufs[i]);
 264     }
 265     exit(EXIT_SUCCESS);
 266 }
 267 .fi
 268 .SH SEE ALSO
 269 .BR clock_gettime (2),
 270 .BR recvmsg (2),
 271 .BR sendmmsg (2),
 272 .BR sendmsg (2),
 273 .BR socket (2),
 274 .BR socket (7)