LXR linux/net/tipc/name

   1/*
   2 * net/tipc/name_table.h: Include file for TIPC name table code
   3 *
   4 * Copyright (c) 2000-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
  37#ifndef _TIPC_NAME_TABLE_H
  38#define _TIPC_NAME_TABLE_H
  39
  40#include "node_subscr.h"
  41
  42struct subscription;
  43struct port_list;
  44
  45/*
  46 * TIPC name types reserved for internal TIPC use (both current and planned)
  47 */
  48
  49#define TIPC_ZM_SRV 3           /* zone master service name type */
  50
  51
  52/**
  53 * struct publication - info about a published (name or) name sequence
  54 * @type: name sequence type
  55 * @lower: name sequence lower bound
  56 * @upper: name sequence upper bound
  57 * @scope: scope of publication
  58 * @node: network address of publishing port's node
  59 * @ref: publishing port
  60 * @key: publication key
  61 * @subscr: subscription to "node down" event (for off-node publications only)
  62 * @local_list: adjacent entries in list of publications made by this node
  63 * @pport_list: adjacent entries in list of publications made by this port
  64 * @node_list: next matching name seq publication with >= node scope
  65 * @cluster_list: next matching name seq publication with >= cluster scope
  66 * @zone_list: next matching name seq publication with >= zone scope
  67 *
  68 * Note that the node list, cluster list, and zone list are circular lists.
  69 */
  70
  71struct publication {
  72        u32 type;
  73        u32 lower;
  74        u32 upper;
  75        u32 scope;
  76        u32 node;
  77        u32 ref;
  78        u32 key;
  79        struct tipc_node_subscr subscr;
  80        struct list_head local_list;
  81        struct list_head pport_list;
  82        struct publication *node_list_next;
  83        struct publication *cluster_list_next;
  84        struct publication *zone_list_next;
  85};
  86
  87
  88extern rwlock_t tipc_nametbl_lock;
  89
  90struct sk_buff *tipc_nametbl_get(const void *req_tlv_area, int req_tlv_space);
  91u32 tipc_nametbl_translate(u32 type, u32 instance, u32 *node);
  92int tipc_nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit,
  93                         struct port_list *dports);
  94int tipc_nametbl_publish_rsv(u32 ref, unsigned int scope,
  95                        struct tipc_name_seq const *seq);
  96struct publication *tipc_nametbl_publish(u32 type, u32 lower, u32 upper,
  97                                    u32 scope, u32 port_ref, u32 key);
  98int tipc_nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key);
  99struct publication *tipc_nametbl_insert_publ(u32 type, u32 lower, u32 upper,
 100                                        u32 scope, u32 node, u32 ref, u32 key);
 101struct publication *tipc_nametbl_remove_publ(u32 type, u32 lower,
 102                                        u32 node, u32 ref, u32 key);
 103void tipc_nametbl_subscribe(struct subscription *s);
 104void tipc_nametbl_unsubscribe(struct subscription *s);
 105int tipc_nametbl_init(void);
 106void tipc_nametbl_stop(void);
 107
 108#endif
 109