name_table.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. /*
  2. * net/tipc/name_table.h: Include file for TIPC name table code
  3. *
  4. * Copyright (c) 2000-2006, 2014-2018, Ericsson AB
  5. * Copyright (c) 2004-2005, 2010-2011, 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_NAME_TABLE_H
  37. #define _TIPC_NAME_TABLE_H
  38. struct tipc_subscription;
  39. struct tipc_plist;
  40. struct tipc_nlist;
  41. struct tipc_group;
  42. /*
  43. * TIPC name types reserved for internal TIPC use (both current and planned)
  44. */
  45. #define TIPC_ZM_SRV 3 /* zone master service name type */
  46. #define TIPC_PUBL_SCOPE_NUM (TIPC_NODE_SCOPE + 1)
  47. #define TIPC_NAMETBL_SIZE 1024 /* must be a power of 2 */
  48. /**
  49. * struct publication - info about a published (name or) name sequence
  50. * @type: name sequence type
  51. * @lower: name sequence lower bound
  52. * @upper: name sequence upper bound
  53. * @scope: scope of publication, TIPC_NODE_SCOPE or TIPC_CLUSTER_SCOPE
  54. * @node: network address of publishing socket's node
  55. * @port: publishing port
  56. * @key: publication key, unique across the cluster
  57. * @binding_node: all publications from the same node which bound this one
  58. * - Remote publications: in node->publ_list
  59. * Used by node/name distr to withdraw publications when node is lost
  60. * - Local/node scope publications: in name_table->node_scope list
  61. * - Local/cluster scope publications: in name_table->cluster_scope list
  62. * @binding_sock: all publications from the same socket which bound this one
  63. * Used by socket to withdraw publications when socket is unbound/released
  64. * @local_publ: list of identical publications made from this node
  65. * Used by closest_first and multicast receive lookup algorithms
  66. * @all_publ: all publications identical to this one, whatever node and scope
  67. * Used by round-robin lookup algorithm
  68. * @rcu: RCU callback head used for deferred freeing
  69. */
  70. struct publication {
  71. u32 type;
  72. u32 lower;
  73. u32 upper;
  74. u32 scope;
  75. u32 node;
  76. u32 port;
  77. u32 key;
  78. struct list_head binding_node;
  79. struct list_head binding_sock;
  80. struct list_head local_publ;
  81. struct list_head all_publ;
  82. struct rcu_head rcu;
  83. };
  84. /**
  85. * struct name_table - table containing all existing port name publications
  86. * @seq_hlist: name sequence hash lists
  87. * @node_scope: all local publications with node scope
  88. * - used by name_distr during re-init of name table
  89. * @cluster_scope: all local publications with cluster scope
  90. * - used by name_distr to send bulk updates to new nodes
  91. * - used by name_distr during re-init of name table
  92. * @local_publ_count: number of publications issued by this node
  93. */
  94. struct name_table {
  95. struct hlist_head services[TIPC_NAMETBL_SIZE];
  96. struct list_head node_scope;
  97. struct list_head cluster_scope;
  98. rwlock_t cluster_scope_lock;
  99. u32 local_publ_count;
  100. };
  101. int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb);
  102. u32 tipc_nametbl_translate(struct net *net, u32 type, u32 instance, u32 *node);
  103. void tipc_nametbl_mc_lookup(struct net *net, u32 type, u32 lower, u32 upper,
  104. u32 scope, bool exact, struct list_head *dports);
  105. void tipc_nametbl_build_group(struct net *net, struct tipc_group *grp,
  106. u32 type, u32 domain);
  107. void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower,
  108. u32 upper, struct tipc_nlist *nodes);
  109. bool tipc_nametbl_lookup(struct net *net, u32 type, u32 instance, u32 domain,
  110. struct list_head *dsts, int *dstcnt, u32 exclude,
  111. bool all);
  112. struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower,
  113. u32 upper, u32 scope, u32 port,
  114. u32 key);
  115. int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 upper,
  116. u32 key);
  117. struct publication *tipc_nametbl_insert_publ(struct net *net, u32 type,
  118. u32 lower, u32 upper, u32 scope,
  119. u32 node, u32 ref, u32 key);
  120. struct publication *tipc_nametbl_remove_publ(struct net *net, u32 type,
  121. u32 lower, u32 upper,
  122. u32 node, u32 key);
  123. bool tipc_nametbl_subscribe(struct tipc_subscription *s);
  124. void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
  125. int tipc_nametbl_init(struct net *net);
  126. void tipc_nametbl_stop(struct net *net);
  127. struct tipc_dest {
  128. struct list_head list;
  129. u32 port;
  130. u32 node;
  131. };
  132. struct tipc_dest *tipc_dest_find(struct list_head *l, u32 node, u32 port);
  133. bool tipc_dest_push(struct list_head *l, u32 node, u32 port);
  134. bool tipc_dest_pop(struct list_head *l, u32 *node, u32 *port);
  135. bool tipc_dest_del(struct list_head *l, u32 node, u32 port);
  136. void tipc_dest_list_purge(struct list_head *l);
  137. int tipc_dest_list_len(struct list_head *l);
  138. #endif