net/tipc/socket.h

   1 /* net/tipc/socket.h: Include file for TIPC socket code
   2  *
   3  * Copyright (c) 2014, Ericsson AB
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the names of the copyright holders nor the names of its
  15  *    contributors may be used to endorse or promote products derived from
  16  *    this software without specific prior written permission.
  17  *
  18  * Alternatively, this software may be distributed under the terms of the
  19  * GNU General Public License ("GPL") version 2 as published by the Free
  20  * Software Foundation.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef _TIPC_SOCK_H
  36 #define _TIPC_SOCK_H
  37
  38 #include "port.h"
  39 #include <net/sock.h>
  40
  41 #define TIPC_CONN_OK      0
  42 #define TIPC_CONN_PROBING 1
  43
  44 /**
  45  * struct tipc_sock - TIPC socket structure
  46  * @sk: socket - interacts with 'port' and with user via the socket API
  47  * @port: port - interacts with 'sk' and with the rest of the TIPC stack
  48  * @peer_name: the peer of the connection, if any
  49  * @conn_timeout: the time we can wait for an unresponded setup request
  50  * @dupl_rcvcnt: number of bytes counted twice, in both backlog and rcv queue
  51  * @link_cong: non-zero if owner must sleep because of link congestion
  52  * @sent_unacked: # messages sent by socket, and not yet acked by peer
  53  * @rcv_unacked: # messages read by user, but not yet acked back to peer
  54  */
  55
  56 struct tipc_sock {
  57         struct sock sk;
  58         struct tipc_port port;
  59         unsigned int conn_timeout;
  60         atomic_t dupl_rcvcnt;
  61         int link_cong;
  62         uint sent_unacked;
  63         uint rcv_unacked;
  64 };
  65
  66 static inline struct tipc_sock *tipc_sk(const struct sock *sk)
  67 {
  68         return container_of(sk, struct tipc_sock, sk);
  69 }
  70
  71 static inline struct tipc_sock *tipc_port_to_sock(const struct tipc_port *port)
  72 {
  73         return container_of(port, struct tipc_sock, port);
  74 }
  75
  76 static inline void tipc_sock_wakeup(struct tipc_sock *tsk)
  77 {
  78         tsk->sk.sk_write_space(&tsk->sk);
  79 }
  80
  81 static inline int tipc_sk_conn_cong(struct tipc_sock *tsk)
  82 {
  83         return tsk->sent_unacked >= TIPC_FLOWCTRL_WIN;
  84 }
  85
  86 int tipc_sk_rcv(struct sk_buff *buf);
  87
  88 void tipc_sk_mcast_rcv(struct sk_buff *buf);
  89
  90 #endif