blob: 5069288031629ca0a30370942c6ab742a069890a [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/user_reg.c: TIPC user registry code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2000-2006, Ericsson AB
Per Lidenb97bf3f2006-01-02 19:04:38 +01005 * Copyright (c) 2004-2005, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * 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:
Per Liden9ea1fd32006-01-11 13:30:43 +010010 *
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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010023 *
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#include "core.h"
38#include "user_reg.h"
39
40/*
41 * TIPC user registry keeps track of users of the tipc_port interface.
42 *
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090043 * The registry utilizes an array of "TIPC user" entries;
Per Lidenb97bf3f2006-01-02 19:04:38 +010044 * a user's ID is the index of their associated array entry.
45 * Array entry 0 is not used, so userid 0 is not valid;
46 * TIPC sometimes uses this value to denote an anonymous user.
47 * The list of free entries is initially chained from last entry to entry 1.
48 */
49
50/**
51 * struct tipc_user - registered TIPC user info
52 * @next: index of next free registry entry (or -1 for an allocated entry)
53 * @callback: ptr to routine to call when TIPC mode changes (NULL if none)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090054 * @usr_handle: user-defined value passed to callback routine
Per Lidenb97bf3f2006-01-02 19:04:38 +010055 * @ports: list of user ports owned by the user
56 */
57
58struct tipc_user {
59 int next;
60 tipc_mode_event callback;
61 void *usr_handle;
62 struct list_head ports;
63};
64
65#define MAX_USERID 64
66#define USER_LIST_SIZE ((MAX_USERID + 1) * sizeof(struct tipc_user))
67
Sam Ravnborg1fc54d82006-03-20 22:36:47 -080068static struct tipc_user *users = NULL;
Per Lidenb97bf3f2006-01-02 19:04:38 +010069static u32 next_free_user = MAX_USERID + 1;
Ingo Molnar34af9462006-06-27 02:53:55 -070070static DEFINE_SPINLOCK(reg_lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +010071
72/**
73 * reg_init - create TIPC user registry (but don't activate it)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090074 *
Per Lidenb97bf3f2006-01-02 19:04:38 +010075 * If registry has been pre-initialized it is left "as is".
76 * NOTE: This routine may be called when TIPC is inactive.
77 */
78
79static int reg_init(void)
80{
81 u32 i;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090082
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 spin_lock_bh(&reg_lock);
84 if (!users) {
Panagiotis Issaris0da974f2006-07-21 14:51:30 -070085 users = kzalloc(USER_LIST_SIZE, GFP_ATOMIC);
Per Lidenb97bf3f2006-01-02 19:04:38 +010086 if (users) {
Per Lidenb97bf3f2006-01-02 19:04:38 +010087 for (i = 1; i <= MAX_USERID; i++) {
88 users[i].next = i - 1;
89 }
90 next_free_user = MAX_USERID;
91 }
92 }
93 spin_unlock_bh(&reg_lock);
Allan Stephens0e35fd52008-07-14 22:44:01 -070094 return users ? 0 : -ENOMEM;
Per Lidenb97bf3f2006-01-02 19:04:38 +010095}
96
97/**
98 * reg_callback - inform TIPC user about current operating mode
99 */
100
101static void reg_callback(struct tipc_user *user_ptr)
102{
103 tipc_mode_event cb;
104 void *arg;
105
106 spin_lock_bh(&reg_lock);
107 cb = user_ptr->callback;
108 arg = user_ptr->usr_handle;
109 spin_unlock_bh(&reg_lock);
110
111 if (cb)
112 cb(arg, tipc_mode, tipc_own_addr);
113}
114
115/**
Per Liden4323add2006-01-18 00:38:21 +0100116 * tipc_reg_start - activate TIPC user registry
Per Lidenb97bf3f2006-01-02 19:04:38 +0100117 */
118
Per Liden4323add2006-01-18 00:38:21 +0100119int tipc_reg_start(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120{
121 u32 u;
122 int res;
123
124 if ((res = reg_init()))
125 return res;
126
127 for (u = 1; u <= MAX_USERID; u++) {
128 if (users[u].callback)
Per Liden4323add2006-01-18 00:38:21 +0100129 tipc_k_signal((Handler)reg_callback,
130 (unsigned long)&users[u]);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100131 }
Allan Stephens0e35fd52008-07-14 22:44:01 -0700132 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133}
134
135/**
Per Liden4323add2006-01-18 00:38:21 +0100136 * tipc_reg_stop - shut down & delete TIPC user registry
Per Lidenb97bf3f2006-01-02 19:04:38 +0100137 */
138
Per Liden4323add2006-01-18 00:38:21 +0100139void tipc_reg_stop(void)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900140{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100141 int id;
142
143 if (!users)
144 return;
145
146 for (id = 1; id <= MAX_USERID; id++) {
147 if (users[id].callback)
148 reg_callback(&users[id]);
149 }
150 kfree(users);
Sam Ravnborg1fc54d82006-03-20 22:36:47 -0800151 users = NULL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100152}
153
154/**
155 * tipc_attach - register a TIPC user
156 *
157 * NOTE: This routine may be called when TIPC is inactive.
158 */
159
160int tipc_attach(u32 *userid, tipc_mode_event cb, void *usr_handle)
161{
162 struct tipc_user *user_ptr;
163
164 if ((tipc_mode == TIPC_NOT_RUNNING) && !cb)
165 return -ENOPROTOOPT;
166 if (!users)
167 reg_init();
168
169 spin_lock_bh(&reg_lock);
170 if (!next_free_user) {
171 spin_unlock_bh(&reg_lock);
172 return -EBUSY;
173 }
174 user_ptr = &users[next_free_user];
175 *userid = next_free_user;
176 next_free_user = user_ptr->next;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900177 user_ptr->next = -1;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100178 spin_unlock_bh(&reg_lock);
179
180 user_ptr->callback = cb;
181 user_ptr->usr_handle = usr_handle;
182 INIT_LIST_HEAD(&user_ptr->ports);
183 atomic_inc(&tipc_user_count);
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900184
Per Lidenb97bf3f2006-01-02 19:04:38 +0100185 if (cb && (tipc_mode != TIPC_NOT_RUNNING))
Per Liden4323add2006-01-18 00:38:21 +0100186 tipc_k_signal((Handler)reg_callback, (unsigned long)user_ptr);
Allan Stephens0e35fd52008-07-14 22:44:01 -0700187 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188}
189
190/**
191 * tipc_detach - deregister a TIPC user
192 */
193
194void tipc_detach(u32 userid)
195{
196 struct tipc_user *user_ptr;
197 struct list_head ports_temp;
198 struct user_port *up_ptr, *temp_up_ptr;
199
200 if ((userid == 0) || (userid > MAX_USERID))
201 return;
202
203 spin_lock_bh(&reg_lock);
204 if ((!users) || (users[userid].next >= 0)) {
205 spin_unlock_bh(&reg_lock);
206 return;
207 }
208
209 user_ptr = &users[userid];
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900210 user_ptr->callback = NULL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100211 INIT_LIST_HEAD(&ports_temp);
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900212 list_splice(&user_ptr->ports, &ports_temp);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100213 user_ptr->next = next_free_user;
214 next_free_user = userid;
215 spin_unlock_bh(&reg_lock);
216
217 atomic_dec(&tipc_user_count);
218
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900219 list_for_each_entry_safe(up_ptr, temp_up_ptr, &ports_temp, uport_list) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100220 tipc_deleteport(up_ptr->ref);
221 }
222}
223
224/**
Per Liden4323add2006-01-18 00:38:21 +0100225 * tipc_reg_add_port - register a user's driver port
Per Lidenb97bf3f2006-01-02 19:04:38 +0100226 */
227
Per Liden4323add2006-01-18 00:38:21 +0100228int tipc_reg_add_port(struct user_port *up_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100229{
230 struct tipc_user *user_ptr;
231
232 if (up_ptr->user_ref == 0)
Allan Stephens0e35fd52008-07-14 22:44:01 -0700233 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100234 if (up_ptr->user_ref > MAX_USERID)
235 return -EINVAL;
236 if ((tipc_mode == TIPC_NOT_RUNNING) || !users )
237 return -ENOPROTOOPT;
238
239 spin_lock_bh(&reg_lock);
240 user_ptr = &users[up_ptr->user_ref];
241 list_add(&up_ptr->uport_list, &user_ptr->ports);
242 spin_unlock_bh(&reg_lock);
Allan Stephens0e35fd52008-07-14 22:44:01 -0700243 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100244}
245
246/**
Per Liden4323add2006-01-18 00:38:21 +0100247 * tipc_reg_remove_port - deregister a user's driver port
Per Lidenb97bf3f2006-01-02 19:04:38 +0100248 */
249
Per Liden4323add2006-01-18 00:38:21 +0100250int tipc_reg_remove_port(struct user_port *up_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100251{
252 if (up_ptr->user_ref == 0)
Allan Stephens0e35fd52008-07-14 22:44:01 -0700253 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100254 if (up_ptr->user_ref > MAX_USERID)
255 return -EINVAL;
256 if (!users )
257 return -ENOPROTOOPT;
258
259 spin_lock_bh(&reg_lock);
260 list_del_init(&up_ptr->uport_list);
261 spin_unlock_bh(&reg_lock);
Allan Stephens0e35fd52008-07-14 22:44:01 -0700262 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100263}
264