net/core/datagram.c

   1 /*
   2  *      SUCS NET3:
   3  *
   4  *      Generic datagram handling routines. These are generic for all
   5  *      protocols. Possibly a generic IP version on top of these would
   6  *      make sense. Not tonight however 8-).
   7  *      This is used because UDP, RAW, PACKET, DDP, IPX, AX.25 and
   8  *      NetROM layer all have identical poll code and mostly
   9  *      identical recvmsg() code. So we share it here. The poll was
  10  *      shared before but buried in udp.c so I moved it.
  11  *
  12  *      Authors:        Alan Cox <alan@redhat.com>. (datagram_poll() from old
  13  *                                                   udp.c code)
  14  *
  15  *      Fixes:
  16  *              Alan Cox        :       NULL return from skb_peek_copy()
  17  *                                      understood
  18  *              Alan Cox        :       Rewrote skb_read_datagram to avoid the
  19  *                                      skb_peek_copy stuff.
  20  *              Alan Cox        :       Added support for SOCK_SEQPACKET.
  21  *                                      IPX can no longer use the SO_TYPE hack
  22  *                                      but AX.25 now works right, and SPX is
  23  *                                      feasible.
  24  *              Alan Cox        :       Fixed write poll of non IP protocol
  25  *                                      crash.
  26  *              Florian  La Roche:      Changed for my new skbuff handling.
  27  *              Darryl Miles    :       Fixed non-blocking SOCK_SEQPACKET.
  28  *              Linus Torvalds  :       BSD semantic fixes.
  29  *              Alan Cox        :       Datagram iovec handling
  30  *              Darryl Miles    :       Fixed non-blocking SOCK_STREAM.
  31  *              Alan Cox        :       POSIXisms
  32  *              Pete Wyckoff    :       Unconnected accept() fix.
  33  *
  34  */
  35
  36 #include <linux/module.h>
  37 #include <linux/types.h>
  38 #include <linux/kernel.h>
  39 #include <asm/uaccess.h>
  40 #include <asm/system.h>
  41 #include <linux/mm.h>
  42 #include <linux/interrupt.h>
  43 #include <linux/errno.h>
  44 #include <linux/sched.h>
  45 #include <linux/inet.h>
  46 #include <linux/tcp.h>
  47 #include <linux/netdevice.h>
  48 #include <linux/rtnetlink.h>
  49 #include <linux/poll.h>
  50 #include <linux/highmem.h>
  51
  52 #include <net/protocol.h>
  53 #include <linux/skbuff.h>
  54 #include <net/sock.h>
  55 #include <net/checksum.h>
  56
  57
  58 /*
  59  *      Is a socket 'connection oriented' ?
  60  */
  61 static inline int connection_based(struct sock *sk)
  62 {
  63         return sk->sk_type == SOCK_SEQPACKET || sk->sk_type == SOCK_STREAM;
  64 }
  65
  66 /*
  67  * Wait for a packet..
  68  */
  69 static int wait_for_packet(struct sock *sk, int *err, long *timeo_p)
  70 {
  71         int error;
  72         DEFINE_WAIT(wait);
  73
  74         prepare_to_wait_exclusive(sk->sk_sleep, &wait, TASK_INTERRUPTIBLE);
  75
  76         /* Socket errors? */
  77         error = sock_error(sk);
  78         if (error)
  79                 goto out_err;
  80
  81         if (!skb_queue_empty(&sk->sk_receive_queue))
  82                 goto out;
  83
  84         /* Socket shut down? */
  85         if (sk->sk_shutdown & RCV_SHUTDOWN)
  86                 goto out_noerr;
  87
  88         /* Sequenced packets can come disconnected.
  89          * If so we report the problem
  90          */
  91         error = -ENOTCONN;
  92         if (connection_based(sk) &&
  93             !(sk->sk_state == TCP_ESTABLISHED || sk->sk_state == TCP_LISTEN))
  94                 goto out_err;
  95
  96         /* handle signals */
  97         if (signal_pending(current))
  98                 goto interrupted;
  99
 100         error = 0;
 101         *timeo_p = schedule_timeout(*timeo_p);
 102 out:
 103         finish_wait(sk->sk_sleep, &wait);
 104         return error;
 105 interrupted:
 106         error = sock_intr_errno(*timeo_p);
 107 out_err:
 108         *err = error;
 109         goto out;
 110 out_noerr:
 111         *err = 0;
 112         error = 1;
 113         goto out;
 114 }
 115
 116 /**
 117  *      skb_recv_datagram - Receive a datagram skbuff
 118  *      @sk - socket
 119  *      @flags - MSG_ flags
 120  *      @noblock - blocking operation?
 121  *      @err - error code returned
 122  *
 123  *      Get a datagram skbuff, understands the peeking, nonblocking wakeups
 124  *      and possible races. This replaces identical code in packet, raw and
 125  *      udp, as well as the IPX AX.25 and Appletalk. It also finally fixes
 126  *      the long standing peek and read race for datagram sockets. If you
 127  *      alter this routine remember it must be re-entrant.
 128  *
 129  *      This function will lock the socket if a skb is returned, so the caller
 130  *      needs to unlock the socket in that case (usually by calling
 131  *      skb_free_datagram)
 132  *
 133  *      * It does not lock socket since today. This function is
 134  *      * free of race conditions. This measure should/can improve
 135  *      * significantly datagram socket latencies at high loads,
 136  *      * when data copying to user space takes lots of time.
 137  *      * (BTW I've just killed the last cli() in IP/IPv6/core/netlink/packet
 138  *      *  8) Great win.)
 139  *      *                                           --ANK (980729)
 140  *
 141  *      The order of the tests when we find no data waiting are specified
 142  *      quite explicitly by POSIX 1003.1g, don't change them without having
 143  *      the standard around please.
 144  */
 145 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
 146                                   int noblock, int *err)
 147 {
 148         struct sk_buff *skb;
 149         long timeo;
 150         /*
 151          * Caller is allowed not to check sk->sk_err before skb_recv_datagram()
 152          */
 153         int error = sock_error(sk);
 154
 155         if (error)
 156                 goto no_packet;
 157
 158         timeo = sock_rcvtimeo(sk, noblock);
 159
 160         do {
 161                 /* Again only user level code calls this function, so nothing
 162                  * interrupt level will suddenly eat the receive_queue.
 163                  *
 164                  * Look at current nfs client by the way...
 165                  * However, this function was corrent in any case. 8)
 166                  */
 167                 if (flags & MSG_PEEK) {
 168                         unsigned long cpu_flags;
 169
 170                         spin_lock_irqsave(&sk->sk_receive_queue.lock,
 171                                           cpu_flags);
 172                         skb = skb_peek(&sk->sk_receive_queue);
 173                         if (skb)
 174                                 atomic_inc(&skb->users);
 175                         spin_unlock_irqrestore(&sk->sk_receive_queue.lock,
 176                                                cpu_flags);
 177                 } else
 178                         skb = skb_dequeue(&sk->sk_receive_queue);
 179
 180                 if (skb)
 181                         return skb;
 182
 183                 /* User doesn't want to wait */
 184                 error = -EAGAIN;
 185                 if (!timeo)
 186                         goto no_packet;
 187
 188         } while (!wait_for_packet(sk, err, &timeo));
 189
 190         return NULL;
 191
 192 no_packet:
 193         *err = error;
 194         return NULL;
 195 }
 196
 197 void skb_free_datagram(struct sock *sk, struct sk_buff *skb)
 198 {
 199         kfree_skb(skb);
 200 }
 201
 202 /*
 203  *      Copy a datagram to a linear buffer.
 204  */
 205 int skb_copy_datagram(const struct sk_buff *skb, int offset, char __user *to, int size)
 206 {
 207         struct iovec iov = {
 208                 .iov_base = to,
 209                 .iov_len =size,
 210         };
 211
 212         return skb_copy_datagram_iovec(skb, offset, &iov, size);
 213 }
 214
 215 /**
 216  *      skb_copy_datagram_iovec - Copy a datagram to an iovec.
 217  *      @skb - buffer to copy
 218  *      @offset - offset in the buffer to start copying from
 219  *      @iovec - io vector to copy to
 220  *      @len - amount of data to copy from buffer to iovec
 221  *
 222  *      Note: the iovec is modified during the copy.
 223  */
 224 int skb_copy_datagram_iovec(const struct sk_buff *skb, int offset,
 225                             struct iovec *to, int len)
 226 {
 227         int start = skb_headlen(skb);
 228         int i, copy = start - offset;
 229
 230         /* Copy header. */
 231         if (copy > 0) {
 232                 if (copy > len)
 233                         copy = len;
 234                 if (memcpy_toiovec(to, skb->data + offset, copy))
 235                         goto fault;
 236                 if ((len -= copy) == 0)
 237                         return 0;
 238                 offset += copy;
 239         }
 240
 241         /* Copy paged appendix. Hmm... why does this look so complicated? */
 242         for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
 243                 int end;
 244
 245                 BUG_TRAP(start <= offset + len);
 246
 247                 end = start + skb_shinfo(skb)->frags[i].size;
 248                 if ((copy = end - offset) > 0) {
 249                         int err;
 250                         u8  *vaddr;
 251                         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
 252                         struct page *page = frag->page;
 253
 254                         if (copy > len)
 255                                 copy = len;
 256                         vaddr = kmap(page);
 257                         err = memcpy_toiovec(to, vaddr + frag->page_offset +
 258                                              offset - start, copy);
 259                         kunmap(page);
 260                         if (err)
 261                                 goto fault;
 262                         if (!(len -= copy))
 263                                 return 0;
 264                         offset += copy;
 265                 }
 266                 start = end;
 267         }
 268
 269         if (skb_shinfo(skb)->frag_list) {
 270                 struct sk_buff *list = skb_shinfo(skb)->frag_list;
 271
 272                 for (; list; list = list->next) {
 273                         int end;
 274
 275                         BUG_TRAP(start <= offset + len);
 276
 277                         end = start + list->len;
 278                         if ((copy = end - offset) > 0) {
 279                                 if (copy > len)
 280                                         copy = len;
 281                                 if (skb_copy_datagram_iovec(list,
 282                                                             offset - start,
 283                                                             to, copy))
 284                                         goto fault;
 285                                 if ((len -= copy) == 0)
 286                                         return 0;
 287                                 offset += copy;
 288                         }
 289                         start = end;
 290                 }
 291         }
 292         if (!len)
 293                 return 0;
 294
 295 fault:
 296         return -EFAULT;
 297 }
 298
 299 int skb_copy_and_csum_datagram(const struct sk_buff *skb, int offset,
 300                                u8 __user *to, int len, unsigned int *csump)
 301 {
 302         int start = skb_headlen(skb);
 303         int pos = 0;
 304         int i, copy = start - offset;
 305
 306         /* Copy header. */
 307         if (copy > 0) {
 308                 int err = 0;
 309                 if (copy > len)
 310                         copy = len;
 311                 *csump = csum_and_copy_to_user(skb->data + offset, to, copy,
 312                                                *csump, &err);
 313                 if (err)
 314                         goto fault;
 315                 if ((len -= copy) == 0)
 316                         return 0;
 317                 offset += copy;
 318                 to += copy;
 319                 pos = copy;
 320         }
 321
 322         for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
 323                 int end;
 324
 325                 BUG_TRAP(start <= offset + len);
 326
 327                 end = start + skb_shinfo(skb)->frags[i].size;
 328                 if ((copy = end - offset) > 0) {
 329                         unsigned int csum2;
 330                         int err = 0;
 331                         u8  *vaddr;
 332                         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
 333                         struct page *page = frag->page;
 334
 335                         if (copy > len)
 336                                 copy = len;
 337                         vaddr = kmap(page);
 338                         csum2 = csum_and_copy_to_user(vaddr +
 339                                                         frag->page_offset +
 340                                                         offset - start,
 341                                                       to, copy, 0, &err);
 342                         kunmap(page);
 343                         if (err)
 344                                 goto fault;
 345                         *csump = csum_block_add(*csump, csum2, pos);
 346                         if (!(len -= copy))
 347                                 return 0;
 348                         offset += copy;
 349                         to += copy;
 350                         pos += copy;
 351                 }
 352                 start = end;
 353         }
 354
 355         if (skb_shinfo(skb)->frag_list) {
 356                 struct sk_buff *list = skb_shinfo(skb)->frag_list;
 357
 358                 for (; list; list=list->next) {
 359                         int end;
 360
 361                         BUG_TRAP(start <= offset + len);
 362
 363                         end = start + list->len;
 364                         if ((copy = end - offset) > 0) {
 365                                 unsigned int csum2 = 0;
 366                                 if (copy > len)
 367                                         copy = len;
 368                                 if (skb_copy_and_csum_datagram(list,
 369                                                                offset - start,
 370                                                                to, copy,
 371                                                                &csum2))
 372                                         goto fault;
 373                                 *csump = csum_block_add(*csump, csum2, pos);
 374                                 if ((len -= copy) == 0)
 375                                         return 0;
 376                                 offset += copy;
 377                                 to += copy;
 378                                 pos += copy;
 379                         }
 380                         start = end;
 381                 }
 382         }
 383         if (!len)
 384                 return 0;
 385
 386 fault:
 387         return -EFAULT;
 388 }
 389
 390 /**
 391  *      skb_copy_and_csum_datagram_iovec - Copy and checkum skb to user iovec.
 392  *      @skb - skbuff
 393  *      @hlen - hardware length
 394  *      @iovec - io vector
 395  *
 396  *      Caller _must_ check that skb will fit to this iovec.
 397  *
 398  *      Returns: 0       - success.
 399  *               -EINVAL - checksum failure.
 400  *               -EFAULT - fault during copy. Beware, in this case iovec
 401  *                         can be modified!
 402  */
 403 int skb_copy_and_csum_datagram_iovec(const struct sk_buff *skb,
 404                                      int hlen, struct iovec *iov)
 405 {
 406         unsigned int csum;
 407         int chunk = skb->len - hlen;
 408
 409         /* Skip filled elements.
 410          * Pretty silly, look at memcpy_toiovec, though 8)
 411          */
 412         while (!iov->iov_len)
 413                 iov++;
 414
 415         if (iov->iov_len < chunk) {
 416                 if ((unsigned short)csum_fold(skb_checksum(skb, 0, chunk + hlen,
 417                                                            skb->csum)))
 418                         goto csum_error;
 419                 if (skb_copy_datagram_iovec(skb, hlen, iov, chunk))
 420                         goto fault;
 421         } else {
 422                 csum = csum_partial(skb->data, hlen, skb->csum);
 423                 if (skb_copy_and_csum_datagram(skb, hlen, iov->iov_base,
 424                                                chunk, &csum))
 425                         goto fault;
 426                 if ((unsigned short)csum_fold(csum))
 427                         goto csum_error;
 428                 iov->iov_len -= chunk;
 429                 iov->iov_base += chunk;
 430         }
 431         return 0;
 432 csum_error:
 433         return -EINVAL;
 434 fault:
 435         return -EFAULT;
 436 }
 437
 438 /**
 439  *      datagram_poll - generic datagram poll
 440  *      @file - file struct
 441  *      @sock - socket
 442  *      @wait - poll table
 443  *
 444  *      Datagram poll: Again totally generic. This also handles
 445  *      sequenced packet sockets providing the socket receive queue
 446  *      is only ever holding data ready to receive.
 447  *
 448  *      Note: when you _don't_ use this routine for this protocol,
 449  *      and you use a different write policy from sock_writeable()
 450  *      then please supply your own write_space callback.
 451  */
 452 unsigned int datagram_poll(struct file *file, struct socket *sock,
 453                            poll_table *wait)
 454 {
 455         struct sock *sk = sock->sk;
 456         unsigned int mask;
 457
 458         poll_wait(file, sk->sk_sleep, wait);
 459         mask = 0;
 460
 461         /* exceptional events? */
 462         if (sk->sk_err || !skb_queue_empty(&sk->sk_error_queue))
 463                 mask |= POLLERR;
 464         if (sk->sk_shutdown == SHUTDOWN_MASK)
 465                 mask |= POLLHUP;
 466
 467         /* readable? */
 468         if (!skb_queue_empty(&sk->sk_receive_queue) ||
 469             (sk->sk_shutdown & RCV_SHUTDOWN))
 470                 mask |= POLLIN | POLLRDNORM;
 471
 472         /* Connection-based need to check for termination and startup */
 473         if (connection_based(sk)) {
 474                 if (sk->sk_state == TCP_CLOSE)
 475                         mask |= POLLHUP;
 476                 /* connection hasn't started yet? */
 477                 if (sk->sk_state == TCP_SYN_SENT)
 478                         return mask;
 479         }
 480
 481         /* writable? */
 482         if (sock_writeable(sk))
 483                 mask |= POLLOUT | POLLWRNORM | POLLWRBAND;
 484         else
 485                 set_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags);
 486
 487         return mask;
 488 }
 489
 490 EXPORT_SYMBOL(datagram_poll);
 491 EXPORT_SYMBOL(skb_copy_and_csum_datagram_iovec);
 492 EXPORT_SYMBOL(skb_copy_datagram);
 493 EXPORT_SYMBOL(skb_copy_datagram_iovec);
 494 EXPORT_SYMBOL(skb_free_datagram);
 495 EXPORT_SYMBOL(skb_recv_datagram);