port.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. /*
  2. * net/tipc/port.h: Include file for TIPC port code
  3. *
  4. * Copyright (c) 1994-2006, Ericsson AB
  5. * Copyright (c) 2004-2005, Wind River Systems
  6. * All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in the
  15. * documentation and/or other materials provided with the distribution.
  16. * 3. Neither the names of the copyright holders nor the names of its
  17. * contributors may be used to endorse or promote products derived from
  18. * this software without specific prior written permission.
  19. *
  20. * Alternatively, this software may be distributed under the terms of the
  21. * GNU General Public License ("GPL") version 2 as published by the Free
  22. * Software Foundation.
  23. *
  24. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34. * POSSIBILITY OF SUCH DAMAGE.
  35. */
  36. #ifndef _TIPC_PORT_H
  37. #define _TIPC_PORT_H
  38. #include "core.h"
  39. #include "ref.h"
  40. #include "net.h"
  41. #include "msg.h"
  42. #include "dbg.h"
  43. #include "node_subscr.h"
  44. /**
  45. * struct user_port - TIPC user port (used with native API)
  46. * @user_ref: id of user who created user port
  47. * @usr_handle: user-specified field
  48. * @ref: object reference to associated TIPC port
  49. * <various callback routines>
  50. * @uport_list: adjacent user ports in list of ports held by user
  51. */
  52. struct user_port {
  53. u32 user_ref;
  54. void *usr_handle;
  55. u32 ref;
  56. tipc_msg_err_event err_cb;
  57. tipc_named_msg_err_event named_err_cb;
  58. tipc_conn_shutdown_event conn_err_cb;
  59. tipc_msg_event msg_cb;
  60. tipc_named_msg_event named_msg_cb;
  61. tipc_conn_msg_event conn_msg_cb;
  62. tipc_continue_event continue_event_cb;
  63. struct list_head uport_list;
  64. };
  65. /**
  66. * struct port - TIPC port structure
  67. * @publ: TIPC port info available to privileged users
  68. * @port_list: adjacent ports in TIPC's global list of ports
  69. * @dispatcher: ptr to routine which handles received messages
  70. * @wakeup: ptr to routine to call when port is no longer congested
  71. * @user_port: ptr to user port associated with port (if any)
  72. * @wait_list: adjacent ports in list of ports waiting on link congestion
  73. * @congested_link: ptr to congested link port is waiting on
  74. * @waiting_pkts:
  75. * @sent:
  76. * @acked:
  77. * @publications: list of publications for port
  78. * @pub_count: total # of publications port has made during its lifetime
  79. * @max_pkt: maximum packet size "hint" used when building messages sent by port
  80. * @probing_state:
  81. * @probing_interval:
  82. * @last_in_seqno:
  83. * @timer_ref:
  84. * @subscription: "node down" subscription used to terminate failed connections
  85. */
  86. struct port {
  87. struct tipc_port publ;
  88. struct list_head port_list;
  89. u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
  90. void (*wakeup)(struct tipc_port *);
  91. struct user_port *user_port;
  92. struct list_head wait_list;
  93. struct link *congested_link;
  94. u32 waiting_pkts;
  95. u32 sent;
  96. u32 acked;
  97. struct list_head publications;
  98. u32 pub_count;
  99. u32 max_pkt;
  100. u32 probing_state;
  101. u32 probing_interval;
  102. u32 last_in_seqno;
  103. struct timer_list timer;
  104. struct node_subscr subscription;
  105. };
  106. extern spinlock_t tipc_port_list_lock;
  107. struct port_list;
  108. int tipc_port_recv_sections(struct port *p_ptr, u32 num_sect,
  109. struct iovec const *msg_sect);
  110. int tipc_port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr,
  111. struct iovec const *msg_sect, u32 num_sect,
  112. int err);
  113. struct sk_buff *tipc_port_get_ports(void);
  114. struct sk_buff *port_show_stats(const void *req_tlv_area, int req_tlv_space);
  115. void tipc_port_recv_proto_msg(struct sk_buff *buf);
  116. void tipc_port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
  117. void tipc_port_reinit(void);
  118. /**
  119. * tipc_port_lock - lock port instance referred to and return its pointer
  120. */
  121. static inline struct port *tipc_port_lock(u32 ref)
  122. {
  123. return (struct port *)tipc_ref_lock(ref);
  124. }
  125. /**
  126. * tipc_port_unlock - unlock a port instance
  127. *
  128. * Can use pointer instead of tipc_ref_unlock() since port is already locked.
  129. */
  130. static inline void tipc_port_unlock(struct port *p_ptr)
  131. {
  132. spin_unlock_bh(p_ptr->publ.lock);
  133. }
  134. static inline struct port* tipc_port_deref(u32 ref)
  135. {
  136. return (struct port *)tipc_ref_deref(ref);
  137. }
  138. static inline u32 tipc_peer_port(struct port *p_ptr)
  139. {
  140. return msg_destport(&p_ptr->publ.phdr);
  141. }
  142. static inline u32 tipc_peer_node(struct port *p_ptr)
  143. {
  144. return msg_destnode(&p_ptr->publ.phdr);
  145. }
  146. static inline int tipc_port_congested(struct port *p_ptr)
  147. {
  148. return((p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2));
  149. }
  150. /**
  151. * tipc_port_recv_msg - receive message from lower layer and deliver to port user
  152. */
  153. static inline int tipc_port_recv_msg(struct sk_buff *buf)
  154. {
  155. struct port *p_ptr;
  156. struct tipc_msg *msg = buf_msg(buf);
  157. u32 destport = msg_destport(msg);
  158. u32 dsz = msg_data_sz(msg);
  159. u32 err;
  160. /* forward unresolved named message */
  161. if (unlikely(!destport)) {
  162. tipc_net_route_msg(buf);
  163. return dsz;
  164. }
  165. /* validate destination & pass to port, otherwise reject message */
  166. p_ptr = tipc_port_lock(destport);
  167. if (likely(p_ptr)) {
  168. if (likely(p_ptr->publ.connected)) {
  169. if ((unlikely(msg_origport(msg) != tipc_peer_port(p_ptr))) ||
  170. (unlikely(msg_orignode(msg) != tipc_peer_node(p_ptr))) ||
  171. (unlikely(!msg_connected(msg)))) {
  172. err = TIPC_ERR_NO_PORT;
  173. tipc_port_unlock(p_ptr);
  174. goto reject;
  175. }
  176. }
  177. err = p_ptr->dispatcher(&p_ptr->publ, buf);
  178. tipc_port_unlock(p_ptr);
  179. if (likely(!err))
  180. return dsz;
  181. } else {
  182. err = TIPC_ERR_NO_PORT;
  183. }
  184. reject:
  185. dbg("port->rejecting, err = %x..\n",err);
  186. return tipc_reject_msg(buf, err);
  187. }
  188. #endif