net/tipc/name_table.h

   1 /*
   2  * net/tipc/name_table.h: Include file for TIPC name table 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  * Redistributions of source code must retain the above copyright notice, this
  13  * list of conditions and the following disclaimer.
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution.
  17  * Neither the names of the copyright holders nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _TIPC_NAME_TABLE_H
  35 #define _TIPC_NAME_TABLE_H
  36
  37 #include "node_subscr.h"
  38
  39 struct subscription;
  40 struct port_list;
  41
  42 /*
  43  * TIPC name types reserved for internal TIPC use (both current and planned)
  44  */
  45
  46 #define TIPC_ZM_SRV 3           /* zone master service name type */
  47
  48
  49 /**
  50  * struct publication - info about a published (name or) name sequence
  51  * @type: name sequence type
  52  * @lower: name sequence lower bound
  53  * @upper: name sequence upper bound
  54  * @scope: scope of publication
  55  * @node: network address of publishing port's node
  56  * @ref: publishing port
  57  * @key: publication key
  58  * @subscr: subscription to "node down" event (for off-node publications only)
  59  * @local_list: adjacent entries in list of publications made by this node
  60  * @pport_list: adjacent entries in list of publications made by this port
  61  * @node_list: next matching name seq publication with >= node scope
  62  * @cluster_list: next matching name seq publication with >= cluster scope
  63  * @zone_list: next matching name seq publication with >= zone scope
  64  *
  65  * Note that the node list, cluster list, and zone list are circular lists.
  66  */
  67
  68 struct publication {
  69         u32 type;
  70         u32 lower;
  71         u32 upper;
  72         u32 scope;
  73         u32 node;
  74         u32 ref;
  75         u32 key;
  76         struct node_subscr subscr;
  77         struct list_head local_list;
  78         struct list_head pport_list;
  79         struct publication *node_list_next;
  80         struct publication *cluster_list_next;
  81         struct publication *zone_list_next;
  82 };
  83
  84
  85 extern rwlock_t nametbl_lock;
  86
  87 struct sk_buff *nametbl_get(const void *req_tlv_area, int req_tlv_space);
  88 u32 nametbl_translate(u32 type, u32 instance, u32 *node);
  89 int nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit,
  90                          struct port_list *dports);
  91 int nametbl_publish_rsv(u32 ref, unsigned int scope,
  92                         struct tipc_name_seq const *seq);
  93 struct publication *nametbl_publish(u32 type, u32 lower, u32 upper,
  94                                     u32 scope, u32 port_ref, u32 key);
  95 int nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key);
  96 struct publication *nametbl_insert_publ(u32 type, u32 lower, u32 upper,
  97                                         u32 scope, u32 node, u32 ref, u32 key);
  98 struct publication *nametbl_remove_publ(u32 type, u32 lower,
  99                                         u32 node, u32 ref, u32 key);
 100 void nametbl_subscribe(struct subscription *s);
 101 void nametbl_unsubscribe(struct subscription *s);
 102 int nametbl_init(void);
 103 void nametbl_stop(void);
 104
 105 #endif