net/tipc/link.h

   1 /*
   2  * net/tipc/link.h: Include file for TIPC link code
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2004-2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef _TIPC_LINK_H
  39 #define _TIPC_LINK_H
  40
  41 #include "dbg.h"
  42 #include "msg.h"
  43 #include "bearer.h"
  44 #include "node.h"
  45
  46 #define PUSH_FAILED   1
  47 #define PUSH_FINISHED 2
  48
  49 /*
  50  * Link states
  51  */
  52
  53 #define WORKING_WORKING 560810u
  54 #define WORKING_UNKNOWN 560811u
  55 #define RESET_UNKNOWN   560812u
  56 #define RESET_RESET     560813u
  57
  58 /*
  59  * Starting value for maximum packet size negotiation on unicast links
  60  * (unless bearer MTU is less)
  61  */
  62
  63 #define MAX_PKT_DEFAULT 1500
  64
  65 /**
  66  * struct link - TIPC link data structure
  67  * @addr: network address of link's peer node
  68  * @name: link name character string
  69  * @media_addr: media address to use when sending messages over link
  70  * @timer: link timer
  71  * @owner: pointer to peer node
  72  * @link_list: adjacent links in bearer's list of links
  73  * @started: indicates if link has been started
  74  * @checkpoint: reference point for triggering link continuity checking
  75  * @peer_session: link session # being used by peer end of link
  76  * @peer_bearer_id: bearer id used by link's peer endpoint
  77  * @b_ptr: pointer to bearer used by link
  78  * @tolerance: minimum link continuity loss needed to reset link [in ms]
  79  * @continuity_interval: link continuity testing interval [in ms]
  80  * @abort_limit: # of unacknowledged continuity probes needed to reset link
  81  * @state: current state of link FSM
  82  * @blocked: indicates if link has been administratively blocked
  83  * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state
  84  * @proto_msg: template for control messages generated by link
  85  * @pmsg: convenience pointer to "proto_msg" field
  86  * @priority: current link priority
  87  * @queue_limit: outbound message queue congestion thresholds (indexed by user)
  88  * @exp_msg_count: # of tunnelled messages expected during link changeover
  89  * @reset_checkpoint: seq # of last acknowledged message at time of link reset
  90  * @max_pkt: current maximum packet size for this link
  91  * @max_pkt_target: desired maximum packet size for this link
  92  * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
  93  * @out_queue_size: # of messages in outbound message queue
  94  * @first_out: ptr to first outbound message in queue
  95  * @last_out: ptr to last outbound message in queue
  96  * @next_out_no: next sequence number to use for outbound messages
  97  * @last_retransmitted: sequence number of most recently retransmitted message
  98  * @stale_count: # of identical retransmit requests made by peer
  99  * @next_in_no: next sequence number to expect for inbound messages
 100  * @deferred_inqueue_sz: # of messages in inbound message queue
 101  * @oldest_deferred_in: ptr to first inbound message in queue
 102  * @newest_deferred_in: ptr to last inbound message in queue
 103  * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
 104  * @proto_msg_queue: ptr to (single) outbound control message
 105  * @retransm_queue_size: number of messages to retransmit
 106  * @retransm_queue_head: sequence number of first message to retransmit
 107  * @next_out: ptr to first unsent outbound message in queue
 108  * @waiting_ports: linked list of ports waiting for link congestion to abate
 109  * @long_msg_seq_no: next identifier to use for outbound fragmented messages
 110  * @defragm_buf: list of partially reassembled inbound message fragments
 111  * @stats: collects statistics regarding link activity
 112  * @print_buf: print buffer used to log link activity
 113  */
 114
 115 struct link {
 116         u32 addr;
 117         char name[TIPC_MAX_LINK_NAME];
 118         struct tipc_media_addr media_addr;
 119         struct timer_list timer;
 120         struct node *owner;
 121         struct list_head link_list;
 122
 123         /* Management and link supervision data */
 124         int started;
 125         u32 checkpoint;
 126         u32 peer_session;
 127         u32 peer_bearer_id;
 128         struct bearer *b_ptr;
 129         u32 tolerance;
 130         u32 continuity_interval;
 131         u32 abort_limit;
 132         int state;
 133         int blocked;
 134         u32 fsm_msg_cnt;
 135         struct {
 136                 unchar hdr[INT_H_SIZE];
 137                 unchar body[TIPC_MAX_IF_NAME];
 138         } proto_msg;
 139         struct tipc_msg *pmsg;
 140         u32 priority;
 141         u32 queue_limit[15];    /* queue_limit[0]==window limit */
 142
 143         /* Changeover */
 144         u32 exp_msg_count;
 145         u32 reset_checkpoint;
 146
 147         /* Max packet negotiation */
 148         u32 max_pkt;
 149         u32 max_pkt_target;
 150         u32 max_pkt_probes;
 151
 152         /* Sending */
 153         u32 out_queue_size;
 154         struct sk_buff *first_out;
 155         struct sk_buff *last_out;
 156         u32 next_out_no;
 157         u32 last_retransmitted;
 158         u32 stale_count;
 159
 160         /* Reception */
 161         u32 next_in_no;
 162         u32 deferred_inqueue_sz;
 163         struct sk_buff *oldest_deferred_in;
 164         struct sk_buff *newest_deferred_in;
 165         u32 unacked_window;
 166
 167         /* Congestion handling */
 168         struct sk_buff *proto_msg_queue;
 169         u32 retransm_queue_size;
 170         u32 retransm_queue_head;
 171         struct sk_buff *next_out;
 172         struct list_head waiting_ports;
 173
 174         /* Fragmentation/defragmentation */
 175         u32 long_msg_seq_no;
 176         struct sk_buff *defragm_buf;
 177
 178         /* Statistics */
 179         struct {
 180                 u32 sent_info;          /* used in counting # sent packets */
 181                 u32 recv_info;          /* used in counting # recv'd packets */
 182                 u32 sent_states;
 183                 u32 recv_states;
 184                 u32 sent_probes;
 185                 u32 recv_probes;
 186                 u32 sent_nacks;
 187                 u32 recv_nacks;
 188                 u32 sent_acks;
 189                 u32 sent_bundled;
 190                 u32 sent_bundles;
 191                 u32 recv_bundled;
 192                 u32 recv_bundles;
 193                 u32 retransmitted;
 194                 u32 sent_fragmented;
 195                 u32 sent_fragments;
 196                 u32 recv_fragmented;
 197                 u32 recv_fragments;
 198                 u32 link_congs;         /* # port sends blocked by congestion */
 199                 u32 bearer_congs;
 200                 u32 deferred_recv;
 201                 u32 duplicates;
 202
 203                 /* for statistical profiling of send queue size */
 204
 205                 u32 max_queue_sz;
 206                 u32 accu_queue_sz;
 207                 u32 queue_sz_counts;
 208
 209                 /* for statistical profiling of message lengths */
 210
 211                 u32 msg_length_counts;
 212                 u32 msg_lengths_total;
 213                 u32 msg_length_profile[7];
 214 #if 0
 215                 u32 sent_tunneled;
 216                 u32 recv_tunneled;
 217 #endif
 218         } stats;
 219
 220         struct print_buf print_buf;
 221 };
 222
 223 struct port;
 224
 225 struct link *link_create(struct bearer *b_ptr, const u32 peer,
 226                          const struct tipc_media_addr *media_addr);
 227 void link_delete(struct link *l_ptr);
 228 void link_changeover(struct link *l_ptr);
 229 void link_send_duplicate(struct link *l_ptr, struct link *dest);
 230 void link_reset_fragments(struct link *l_ptr);
 231 int link_is_up(struct link *l_ptr);
 232 int link_is_active(struct link *l_ptr);
 233 void link_start(struct link *l_ptr);
 234 u32 link_push_packet(struct link *l_ptr);
 235 void link_stop(struct link *l_ptr);
 236 struct sk_buff *link_cmd_config(const void *req_tlv_area, int req_tlv_space, u16 cmd);
 237 struct sk_buff *link_cmd_show_stats(const void *req_tlv_area, int req_tlv_space);
 238 struct sk_buff *link_cmd_reset_stats(const void *req_tlv_area, int req_tlv_space);
 239 void link_reset(struct link *l_ptr);
 240 int link_send(struct sk_buff *buf, u32 dest, u32 selector);
 241 int link_send_buf(struct link *l_ptr, struct sk_buff *buf);
 242 u32 link_get_max_pkt(u32 dest,u32 selector);
 243 int link_send_sections_fast(struct port* sender,
 244                             struct iovec const *msg_sect,
 245                             const u32 num_sect,
 246                             u32 destnode);
 247
 248 int link_send_long_buf(struct link *l_ptr, struct sk_buff *buf);
 249 void link_tunnel(struct link *l_ptr, struct tipc_msg *tnl_hdr,
 250                  struct tipc_msg *msg, u32 selector);
 251 void link_recv_bundle(struct sk_buff *buf);
 252 int  link_recv_fragment(struct sk_buff **pending,
 253                         struct sk_buff **fb,
 254                         struct tipc_msg **msg);
 255 void link_send_proto_msg(struct link *l_ptr, u32 msg_typ, int prob, u32 gap,
 256                          u32 tolerance, u32 priority, u32 acked_mtu);
 257 void link_push_queue(struct link *l_ptr);
 258 u32 link_defer_pkt(struct sk_buff **head, struct sk_buff **tail,
 259                    struct sk_buff *buf);
 260 void link_wakeup_ports(struct link *l_ptr, int all);
 261 void link_set_queue_limits(struct link *l_ptr, u32 window);
 262 void link_retransmit(struct link *l_ptr, struct sk_buff *start, u32 retransmits);
 263
 264 /*
 265  * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
 266  */
 267
 268 static inline u32 mod(u32 x)
 269 {
 270         return x & 0xffffu;
 271 }
 272
 273 static inline int between(u32 lower, u32 upper, u32 n)
 274 {
 275         if ((lower < n) && (n < upper))
 276                 return 1;
 277         if ((upper < lower) && ((n > lower) || (n < upper)))
 278                 return 1;
 279         return 0;
 280 }
 281
 282 static inline int less_eq(u32 left, u32 right)
 283 {
 284         return (mod(right - left) < 32768u);
 285 }
 286
 287 static inline int less(u32 left, u32 right)
 288 {
 289         return (less_eq(left, right) && (mod(right) != mod(left)));
 290 }
 291
 292 static inline u32 lesser(u32 left, u32 right)
 293 {
 294         return less_eq(left, right) ? left : right;
 295 }
 296
 297 #endif