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 NULL, then the operation blocks indefinitely.
 121
 122 A blocking
 123 .BR recvmmsg ()
 124 call blocks until
 125 .I vlen
 126 messages have been received
 127 or until the timeout expires.
 128 A nonblocking call reads as many messages as are available
 129 (up to the limit specified by
 130 .IR vlen )
 131 and returns immediately.
 132
 133 On return from
 134 .BR recvmmsg (),
 135 successive elements of
 136 .IR msgvec
 137 are updated to contain information about each received message:
 138 .I msg_len
 139 contains the size of the received message;
 140 the subfields of
 141 .I msg_hdr
 142 are updated as described in
 143 .BR recvmsg (2).
 144 The return value of the call indicates the number of elements of
 145 .I msgvec
 146 that have been updated.
 147 .SH RETURN VALUE
 148 On success,
 149 .BR recvmmsg ()
 150 returns the number of messages received in
 151 .IR msgvec ;
 152 on error, \-1 is returned, and
 153 .I errno
 154 is set to indicate the error.
 155 .SH ERRORS
 156 Errors are as for
 157 .BR recvmsg (2).
 158 In addition, the following error can occur:
 159 .TP
 160 .B EINVAL
 161 .I timeout
 162 is invalid.
 163 .SH VERSIONS
 164 The
 165 .BR recvmmsg ()
 166 system call was added in Linux 2.6.33.
 167 Support in glibc was added in version 2.12.
 168 .SH CONFORMING TO
 169 .BR recvmmsg ()
 170 is Linux-specific.
 171 .SH EXAMPLE
 172 .PP
 173 The following program uses
 174 .BR recvmmsg ()
 175 to receive multiple messages on a socket and stores
 176 them in multiple buffers.
 177 The call returns if all buffers are filled or if the
 178 timeout specified has expired.
 179
 180 The following snippet periodically generates UDP datagrams
 181 containing a random number:
 182 .in +4n
 183 .nf
 184
 185 .RB "$" " while true; do echo $RANDOM > /dev/udp/127.0.0.1/1234; "
 186 .B      "      sleep 0.25; done"
 187 .fi
 188 .in
 189
 190 These datagrams are read by the example application, which
 191 can give the following output:
 192 .in +4n
 193 .nf
 194
 195 .RB "$" " ./a.out"
 196 5 messages received
 197 1 11782
 198 2 11345
 199 3 304
 200 4 13514
 201 5 28421
 202 .fi
 203 .in
 204 .SS Program source
 205 \&
 206 .nf
 207 #define _GNU_SOURCE
 208 #include <netinet/ip.h>
 209 #include <stdio.h>
 210 #include <stdlib.h>
 211 #include <string.h>
 212 #include <sys/socket.h>
 213
 214 int
 215 main(void)
 216 {
 217 #define VLEN 10
 218 #define BUFSIZE 200
 219 #define TIMEOUT 1
 220     int sockfd, retval, i;
 221     struct sockaddr_in sa;
 222     struct mmsghdr msgs[VLEN];
 223     struct iovec iovecs[VLEN];
 224     char bufs[VLEN][BUFSIZE+1];
 225     struct timespec timeout;
 226
 227     sockfd = socket(AF_INET, SOCK_DGRAM, 0);
 228     if (sockfd == \-1) {
 229         perror("socket()");
 230         exit(EXIT_FAILURE);
 231     }
 232
 233     sa.sin_family = AF_INET;
 234     sa.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 235     sa.sin_port = htons(1234);
 236     if (bind(sockfd, (struct sockaddr *) &sa, sizeof(sa)) == \-1) {
 237         perror("bind()");
 238         exit(EXIT_FAILURE);
 239     }
 240
 241     memset(msgs, 0, sizeof(msgs));
 242     for (i = 0; i < VLEN; i++) {
 243         iovecs[i].iov_base         = bufs[i];
 244         iovecs[i].iov_len          = BUFSIZE;
 245         msgs[i].msg_hdr.msg_iov    = &iovecs[i];
 246         msgs[i].msg_hdr.msg_iovlen = 1;
 247     }
 248
 249     timeout.tv_sec = TIMEOUT;
 250     timeout.tv_nsec = 0;
 251
 252     retval = recvmmsg(sockfd, msgs, VLEN, 0, &timeout);
 253     if (retval == \-1) {
 254         perror("recvmmsg()");
 255         exit(EXIT_FAILURE);
 256     }
 257
 258     printf("%d messages received\\n", retval);
 259     for (i = 0; i < retval; i++) {
 260         bufs[i][msgs[i].msg_len] = 0;
 261         printf("%d %s", i+1, bufs[i]);
 262     }
 263     exit(EXIT_SUCCESS);
 264 }
 265 .fi
 266 .SH SEE ALSO
 267 .BR clock_gettime (2),
 268 .BR recvmsg (2),
 269 .BR sendmmsg (2),
 270 .BR sendmsg (2),
 271 .BR socket (2),
 272 .BR socket (7)
 273 .SH COLOPHON
 274 This page is part of release 3.65 of the Linux
 275 .I man-pages
 276 project.
 277 A description of the project,
 278 and information about reporting bugs,
 279 can be found at
 280 \%http://www.kernel.org/doc/man\-pages/.