blob: 60b877531b668157c7c7ac5aa3bdd549af9240ce [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
Allan Stephens5b06c85c2008-05-19 13:30:13 -07002 * net/tipc/subscr.h: Include file for TIPC network topology service
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Maloy242e82c2018-02-15 10:40:47 +01004 * Copyright (c) 2003-2017, Ericsson AB
Ying Xue13a2e892013-06-17 10:54:40 -04005 * Copyright (c) 2005-2007, 2012-2013, Wind River Systems
Jon Maloy09f78b82021-03-16 22:06:21 -04006 * Copyright (c) 2020-2021, Red Hat Inc
Per Lidenb97bf3f2006-01-02 19:04:38 +01007 * All rights reserved.
8 *
Per Liden9ea1fd32006-01-11 13:30:43 +01009 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +010010 * modification, are permitted provided that the following conditions are met:
11 *
Per Liden9ea1fd32006-01-11 13:30:43 +010012 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010020 *
Per Liden9ea1fd32006-01-11 13:30:43 +010021 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010035 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38#ifndef _TIPC_SUBSCR_H
39#define _TIPC_SUBSCR_H
40
Jon Maloy026321c2018-02-15 10:40:51 +010041#include "topsrv.h"
Ying Xue13a2e892013-06-17 10:54:40 -040042
Jon Maloy242e82c2018-02-15 10:40:47 +010043#define TIPC_MAX_SUBSCR 65535
Jon Maloy218527f2018-03-29 23:20:41 +020044#define TIPC_MAX_PUBL 65535
Ying Xue859fc7c2015-01-09 15:27:01 +080045
Jon Maloy09f78b82021-03-16 22:06:21 -040046struct publication;
Paul Gortmakerfead3902011-12-29 20:43:44 -050047struct tipc_subscription;
Jon Maloydf79d042018-02-15 10:40:44 +010048struct tipc_conn;
Allan Stephense15f8802008-05-19 13:27:31 -070049
Per Lidenb97bf3f2006-01-02 19:04:38 +010050/**
Paul Gortmakerfead3902011-12-29 20:43:44 -050051 * struct tipc_subscription - TIPC network topology subscription object
Jon Maloy02fdc142021-03-29 13:17:31 -040052 * @s: host-endian copy of the user subscription
53 * @evt: template for events generated by subscription
Randy Dunlapff105272020-11-29 10:32:43 -080054 * @kref: reference count for this subscription
55 * @net: network namespace associated with subscription
Allan Stephens5b06c85c2008-05-19 13:30:13 -070056 * @timer: timer governing subscription duration (optional)
Randy Dunlapff105272020-11-29 10:32:43 -080057 * @service_list: adjacent subscriptions in name sequence's subscription list
Jon Maloyda0a75e2018-02-15 10:40:48 +010058 * @sub_list: adjacent subscriptions in subscriber's subscription list
Randy Dunlapff105272020-11-29 10:32:43 -080059 * @conid: connection identifier of topology server
60 * @inactive: true if this subscription is inactive
61 * @lock: serialize up/down and timer events
Per Lidenb97bf3f2006-01-02 19:04:38 +010062 */
Paul Gortmakerfead3902011-12-29 20:43:44 -050063struct tipc_subscription {
Jon Maloy429189a2021-03-16 22:06:22 -040064 struct tipc_subscr s;
65 struct tipc_event evt;
Parthasarathy Bhuvaragand094c4d2017-01-24 13:00:44 +010066 struct kref kref;
Jon Maloy5c45ab22018-02-15 10:40:49 +010067 struct net *net;
Allan Stephens5b06c85c2008-05-19 13:30:13 -070068 struct timer_list timer;
Jon Maloy218527f2018-03-29 23:20:41 +020069 struct list_head service_list;
Jon Maloyda0a75e2018-02-15 10:40:48 +010070 struct list_head sub_list;
Jon Maloydf79d042018-02-15 10:40:44 +010071 int conid;
Jon Maloydf79d042018-02-15 10:40:44 +010072 bool inactive;
Randy Dunlapff105272020-11-29 10:32:43 -080073 spinlock_t lock;
Per Lidenb97bf3f2006-01-02 19:04:38 +010074};
75
Jon Maloy5c45ab22018-02-15 10:40:49 +010076struct tipc_subscription *tipc_sub_subscribe(struct net *net,
Jon Maloy242e82c2018-02-15 10:40:47 +010077 struct tipc_subscr *s,
78 int conid);
79void tipc_sub_unsubscribe(struct tipc_subscription *sub);
Jon Maloyda0a75e2018-02-15 10:40:48 +010080void tipc_sub_report_overlap(struct tipc_subscription *sub,
Jon Maloy09f78b82021-03-16 22:06:21 -040081 struct publication *p,
82 u32 event, bool must);
Junwei Hu526f5b82019-05-20 14:43:59 +080083
84int __net_init tipc_topsrv_init_net(struct net *net);
85void __net_exit tipc_topsrv_exit_net(struct net *net);
Per Lidenb97bf3f2006-01-02 19:04:38 +010086
Jon Maloyda0a75e2018-02-15 10:40:48 +010087void tipc_sub_put(struct tipc_subscription *subscription);
88void tipc_sub_get(struct tipc_subscription *subscription);
Ying Xue7efea602017-03-28 12:28:28 +020089
Jon Maloy8985ecc2018-02-15 10:40:46 +010090#define TIPC_FILTER_MASK (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | TIPC_SUB_CANCEL)
91
92/* tipc_sub_read - return field_ of struct sub_ in host endian format
93 */
94#define tipc_sub_read(sub_, field_) \
95 ({ \
96 struct tipc_subscr *sub__ = sub_; \
97 u32 val__ = (sub__)->field_; \
98 int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \
99 (swap_ ? swab32(val__) : val__); \
100 })
101
Tuong Lien88690b12020-05-13 19:33:18 +0700102/* tipc_sub_write - write val_ to field_ of struct sub_ in user endian format
103 */
104#define tipc_sub_write(sub_, field_, val_) \
105 ({ \
106 struct tipc_subscr *sub__ = sub_; \
107 u32 val__ = val_; \
108 int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \
109 (sub__)->field_ = swap_ ? swab32(val__) : val__; \
110 })
111
Jon Maloy8985ecc2018-02-15 10:40:46 +0100112/* tipc_evt_write - write val_ to field_ of struct evt_ in user endian format
113 */
114#define tipc_evt_write(evt_, field_, val_) \
115 ({ \
116 struct tipc_event *evt__ = evt_; \
117 u32 val__ = val_; \
118 int swap_ = !((evt__)->s.filter & (TIPC_FILTER_MASK)); \
119 (evt__)->field_ = swap_ ? swab32(val__) : val__; \
120 })
121
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122#endif