Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 1 | /* |
Allan Stephens | 5b06c85c | 2008-05-19 13:30:13 -0700 | [diff] [blame] | 2 | * net/tipc/subscr.h: Include file for TIPC network topology service |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 3 | * |
Jon Maloy | 242e82c | 2018-02-15 10:40:47 +0100 | [diff] [blame] | 4 | * Copyright (c) 2003-2017, Ericsson AB |
Ying Xue | 13a2e89 | 2013-06-17 10:54:40 -0400 | [diff] [blame] | 5 | * Copyright (c) 2005-2007, 2012-2013, Wind River Systems |
Jon Maloy | 09f78b8 | 2021-03-16 22:06:21 -0400 | [diff] [blame] | 6 | * Copyright (c) 2020-2021, Red Hat Inc |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 7 | * All rights reserved. |
| 8 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 9 | * Redistribution and use in source and binary forms, with or without |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 10 | * modification, are permitted provided that the following conditions are met: |
| 11 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 12 | * 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 Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 20 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 21 | * 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 Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 35 | * POSSIBILITY OF SUCH DAMAGE. |
| 36 | */ |
| 37 | |
| 38 | #ifndef _TIPC_SUBSCR_H |
| 39 | #define _TIPC_SUBSCR_H |
| 40 | |
Jon Maloy | 026321c | 2018-02-15 10:40:51 +0100 | [diff] [blame] | 41 | #include "topsrv.h" |
Ying Xue | 13a2e89 | 2013-06-17 10:54:40 -0400 | [diff] [blame] | 42 | |
Jon Maloy | 242e82c | 2018-02-15 10:40:47 +0100 | [diff] [blame] | 43 | #define TIPC_MAX_SUBSCR 65535 |
Jon Maloy | 218527f | 2018-03-29 23:20:41 +0200 | [diff] [blame] | 44 | #define TIPC_MAX_PUBL 65535 |
Ying Xue | 859fc7c | 2015-01-09 15:27:01 +0800 | [diff] [blame] | 45 | |
Jon Maloy | 09f78b8 | 2021-03-16 22:06:21 -0400 | [diff] [blame] | 46 | struct publication; |
Paul Gortmaker | fead390 | 2011-12-29 20:43:44 -0500 | [diff] [blame] | 47 | struct tipc_subscription; |
Jon Maloy | df79d04 | 2018-02-15 10:40:44 +0100 | [diff] [blame] | 48 | struct tipc_conn; |
Allan Stephens | e15f880 | 2008-05-19 13:27:31 -0700 | [diff] [blame] | 49 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 50 | /** |
Paul Gortmaker | fead390 | 2011-12-29 20:43:44 -0500 | [diff] [blame] | 51 | * struct tipc_subscription - TIPC network topology subscription object |
Jon Maloy | 02fdc14 | 2021-03-29 13:17:31 -0400 | [diff] [blame] | 52 | * @s: host-endian copy of the user subscription |
| 53 | * @evt: template for events generated by subscription |
Randy Dunlap | ff10527 | 2020-11-29 10:32:43 -0800 | [diff] [blame] | 54 | * @kref: reference count for this subscription |
| 55 | * @net: network namespace associated with subscription |
Allan Stephens | 5b06c85c | 2008-05-19 13:30:13 -0700 | [diff] [blame] | 56 | * @timer: timer governing subscription duration (optional) |
Randy Dunlap | ff10527 | 2020-11-29 10:32:43 -0800 | [diff] [blame] | 57 | * @service_list: adjacent subscriptions in name sequence's subscription list |
Jon Maloy | da0a75e | 2018-02-15 10:40:48 +0100 | [diff] [blame] | 58 | * @sub_list: adjacent subscriptions in subscriber's subscription list |
Randy Dunlap | ff10527 | 2020-11-29 10:32:43 -0800 | [diff] [blame] | 59 | * @conid: connection identifier of topology server |
| 60 | * @inactive: true if this subscription is inactive |
| 61 | * @lock: serialize up/down and timer events |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 62 | */ |
Paul Gortmaker | fead390 | 2011-12-29 20:43:44 -0500 | [diff] [blame] | 63 | struct tipc_subscription { |
Jon Maloy | 429189a | 2021-03-16 22:06:22 -0400 | [diff] [blame] | 64 | struct tipc_subscr s; |
| 65 | struct tipc_event evt; |
Parthasarathy Bhuvaragan | d094c4d | 2017-01-24 13:00:44 +0100 | [diff] [blame] | 66 | struct kref kref; |
Jon Maloy | 5c45ab2 | 2018-02-15 10:40:49 +0100 | [diff] [blame] | 67 | struct net *net; |
Allan Stephens | 5b06c85c | 2008-05-19 13:30:13 -0700 | [diff] [blame] | 68 | struct timer_list timer; |
Jon Maloy | 218527f | 2018-03-29 23:20:41 +0200 | [diff] [blame] | 69 | struct list_head service_list; |
Jon Maloy | da0a75e | 2018-02-15 10:40:48 +0100 | [diff] [blame] | 70 | struct list_head sub_list; |
Jon Maloy | df79d04 | 2018-02-15 10:40:44 +0100 | [diff] [blame] | 71 | int conid; |
Jon Maloy | df79d04 | 2018-02-15 10:40:44 +0100 | [diff] [blame] | 72 | bool inactive; |
Randy Dunlap | ff10527 | 2020-11-29 10:32:43 -0800 | [diff] [blame] | 73 | spinlock_t lock; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 74 | }; |
| 75 | |
Jon Maloy | 5c45ab2 | 2018-02-15 10:40:49 +0100 | [diff] [blame] | 76 | struct tipc_subscription *tipc_sub_subscribe(struct net *net, |
Jon Maloy | 242e82c | 2018-02-15 10:40:47 +0100 | [diff] [blame] | 77 | struct tipc_subscr *s, |
| 78 | int conid); |
| 79 | void tipc_sub_unsubscribe(struct tipc_subscription *sub); |
Jon Maloy | da0a75e | 2018-02-15 10:40:48 +0100 | [diff] [blame] | 80 | void tipc_sub_report_overlap(struct tipc_subscription *sub, |
Jon Maloy | 09f78b8 | 2021-03-16 22:06:21 -0400 | [diff] [blame] | 81 | struct publication *p, |
| 82 | u32 event, bool must); |
Junwei Hu | 526f5b8 | 2019-05-20 14:43:59 +0800 | [diff] [blame] | 83 | |
| 84 | int __net_init tipc_topsrv_init_net(struct net *net); |
| 85 | void __net_exit tipc_topsrv_exit_net(struct net *net); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 86 | |
Jon Maloy | da0a75e | 2018-02-15 10:40:48 +0100 | [diff] [blame] | 87 | void tipc_sub_put(struct tipc_subscription *subscription); |
| 88 | void tipc_sub_get(struct tipc_subscription *subscription); |
Ying Xue | 7efea60 | 2017-03-28 12:28:28 +0200 | [diff] [blame] | 89 | |
Jon Maloy | 8985ecc | 2018-02-15 10:40:46 +0100 | [diff] [blame] | 90 | #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 Lien | 88690b1 | 2020-05-13 19:33:18 +0700 | [diff] [blame] | 102 | /* 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 Maloy | 8985ecc | 2018-02-15 10:40:46 +0100 | [diff] [blame] | 112 | /* 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 Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 122 | #endif |