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 <net/sock.h>
  39 #include "msg.h"
  40
  41 #define TIPC_CONN_OK      0
  42 #define TIPC_CONN_PROBING 1
  43 #define TIPC_CONNACK_INTV         256
  44 #define TIPC_FLOWCTRL_WIN        (TIPC_CONNACK_INTV * 2)
  45 #define TIPC_CONN_OVERLOAD_LIMIT ((TIPC_FLOWCTRL_WIN * 2 + 1) * \
  46                                   SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE))
  47
  48 /**
  49  * struct tipc_port - TIPC port structure
  50  * @lock: pointer to spinlock for controlling access to port
  51  * @connected: non-zero if port is currently connected to a peer port
  52  * @conn_type: TIPC type used when connection was established
  53  * @conn_instance: TIPC instance used when connection was established
  54  * @published: non-zero if port has one or more associated names
  55  * @max_pkt: maximum packet size "hint" used when building messages sent by port
  56  * @ref: unique reference to port in TIPC object registry
  57  * @phdr: preformatted message header used when sending messages
  58  * @port_list: adjacent ports in TIPC's global list of ports
  59  * @publications: list of publications for port
  60  * @pub_count: total # of publications port has made during its lifetime
  61  * @probing_state:
  62  * @probing_interval:
  63  * @timer_ref:
  64  */
  65 struct tipc_port {
  66         int connected;
  67         u32 conn_type;
  68         u32 conn_instance;
  69         int published;
  70         u32 max_pkt;
  71         u32 ref;
  72         struct tipc_msg phdr;
  73         struct list_head port_list;
  74         struct list_head publications;
  75         u32 pub_count;
  76         u32 probing_state;
  77         u32 probing_interval;
  78         struct timer_list timer;
  79 };
  80
  81 /**
  82  * struct tipc_sock - TIPC socket structure
  83  * @sk: socket - interacts with 'port' and with user via the socket API
  84  * @port: port - interacts with 'sk' and with the rest of the TIPC stack
  85  * @peer_name: the peer of the connection, if any
  86  * @conn_timeout: the time we can wait for an unresponded setup request
  87  * @dupl_rcvcnt: number of bytes counted twice, in both backlog and rcv queue
  88  * @link_cong: non-zero if owner must sleep because of link congestion
  89  * @sent_unacked: # messages sent by socket, and not yet acked by peer
  90  * @rcv_unacked: # messages read by user, but not yet acked back to peer
  91  */
  92
  93 struct tipc_sock {
  94         struct sock sk;
  95         struct tipc_port port;
  96         unsigned int conn_timeout;
  97         atomic_t dupl_rcvcnt;
  98         bool link_cong;
  99         uint sent_unacked;
 100         uint rcv_unacked;
 101 };
 102
 103 static inline struct tipc_sock *tipc_sk(const struct sock *sk)
 104 {
 105         return container_of(sk, struct tipc_sock, sk);
 106 }
 107
 108 static inline struct tipc_sock *tipc_port_to_sock(const struct tipc_port *port)
 109 {
 110         return container_of(port, struct tipc_sock, port);
 111 }
 112
 113 static inline int tipc_sk_conn_cong(struct tipc_sock *tsk)
 114 {
 115         return tsk->sent_unacked >= TIPC_FLOWCTRL_WIN;
 116 }
 117
 118 int tipc_sk_rcv(struct sk_buff *buf);
 119 struct sk_buff *tipc_sk_socks_show(void);
 120 void tipc_sk_mcast_rcv(struct sk_buff *buf);
 121 void tipc_sk_reinit(void);
 122
 123 #endif