c2d0577f977613bf21313cd64e561a5220b5c7ac
[asterisk/asterisk.git] / main / endpoints.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Asterisk endpoint API.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/astobj2.h"
35 #include "asterisk/endpoints.h"
36 #include "asterisk/stasis.h"
37 #include "asterisk/stasis_channels.h"
38 #include "asterisk/stasis_endpoints.h"
39 #include "asterisk/stasis_message_router.h"
40 #include "asterisk/stringfields.h"
41
42 /*! Buckets for endpoint->channel mappings. Keep it prime! */
43 #define ENDPOINT_BUCKETS 127
44
45 struct ast_endpoint {
46         AST_DECLARE_STRING_FIELDS(
47                 AST_STRING_FIELD(tech); /*!< Technology (SIP, IAX2, etc.). */
48                 AST_STRING_FIELD(resource);     /*!< Name, unique to the tech. */
49                 AST_STRING_FIELD(id);   /*!< tech/resource id */
50                 );
51         /*! Endpoint's current state */
52         enum ast_endpoint_state state;
53         /*!
54          * \brief Max channels for this endpoint. -1 means unlimited or unknown.
55          *
56          * Note that this simply documents the limits of an endpoint, and does
57          * nothing to try to enforce the limit.
58          */
59         int max_channels;
60         /*! Topic for this endpoint's messages */
61         struct stasis_topic *topic;
62         /*!
63          * Forwarding subscription sending messages to ast_endpoint_topic_all()
64          */
65         struct stasis_subscription *forward;
66         /*! Router for handling this endpoint's messages */
67         struct stasis_message_router *router;
68         /*! ast_str_container of channels associated with this endpoint */
69         struct ao2_container *channel_ids;
70 };
71
72 const char *ast_endpoint_state_to_string(enum ast_endpoint_state state)
73 {
74         switch (state) {
75         case AST_ENDPOINT_UNKNOWN:
76                 return "unknown";
77         case AST_ENDPOINT_OFFLINE:
78                 return "offline";
79         case AST_ENDPOINT_ONLINE:
80                 return "online";
81         }
82         return "?";
83 }
84
85 static void endpoint_publish_snapshot(struct ast_endpoint *endpoint)
86 {
87         RAII_VAR(struct ast_endpoint_snapshot *, snapshot, NULL, ao2_cleanup);
88         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
89
90         ast_assert(endpoint != NULL);
91         ast_assert(endpoint->topic != NULL);
92
93         snapshot = ast_endpoint_snapshot_create(endpoint);
94         if (!snapshot) {
95                 return;
96         }
97         message = stasis_message_create(ast_endpoint_snapshot_type(), snapshot);
98         if (!message) {
99                 return;
100         }
101         stasis_publish(endpoint->topic, message);
102 }
103
104 static void endpoint_dtor(void *obj)
105 {
106         struct ast_endpoint *endpoint = obj;
107
108         /* The router should be shut down already */
109         ast_assert(stasis_message_router_is_done(endpoint->router));
110         ao2_cleanup(endpoint->router);
111         endpoint->router = NULL;
112
113         stasis_unsubscribe(endpoint->forward);
114         endpoint->forward = NULL;
115
116         ao2_cleanup(endpoint->topic);
117         endpoint->topic = NULL;
118
119         ast_string_field_free_memory(endpoint);
120 }
121
122 static void endpoint_channel_snapshot(void *data,
123         struct stasis_subscription *sub, struct stasis_topic *topic,
124         struct stasis_message *message)
125 {
126         struct ast_endpoint *endpoint = data;
127         struct ast_channel_snapshot *snapshot = stasis_message_data(message);
128         RAII_VAR(char *, existing_id, NULL, ao2_cleanup);
129         int publish = 0;
130
131         ast_assert(endpoint != NULL);
132         ast_assert(snapshot != NULL);
133
134         ao2_lock(endpoint);
135         existing_id = ao2_find(endpoint->channel_ids, snapshot->uniqueid,
136                 OBJ_POINTER);
137         if (!existing_id) {
138                 ast_str_container_add(endpoint->channel_ids,
139                         snapshot->uniqueid);
140                 publish = 1;
141         }
142         ao2_unlock(endpoint);
143         if (publish) {
144                 endpoint_publish_snapshot(endpoint);
145         }
146 }
147
148 static void endpoint_cache_clear(void *data,
149         struct stasis_subscription *sub, struct stasis_topic *topic,
150         struct stasis_message *message)
151 {
152         struct ast_endpoint *endpoint = data;
153         struct stasis_cache_clear *clear = stasis_message_data(message);
154
155         ast_assert(endpoint != NULL);
156         ast_assert(clear != NULL);
157
158         ao2_lock(endpoint);
159         ao2_find(endpoint->channel_ids, clear->id, OBJ_POINTER | OBJ_NODATA | OBJ_UNLINK);
160         ao2_unlock(endpoint);
161         endpoint_publish_snapshot(endpoint);
162 }
163
164 static void endpoint_default(void *data,
165         struct stasis_subscription *sub, struct stasis_topic *topic,
166         struct stasis_message *message)
167 {
168         struct stasis_endpoint *endpoint = data;
169
170         if (stasis_subscription_final_message(sub, message)) {
171                 ao2_cleanup(endpoint);
172         }
173 }
174
175 struct ast_endpoint *ast_endpoint_create(const char *tech, const char *resource)
176 {
177         RAII_VAR(struct ast_endpoint *, endpoint, NULL, ao2_cleanup);
178         int r = 0;
179
180         if (ast_strlen_zero(tech)) {
181                 ast_log(LOG_ERROR, "Endpoint tech cannot be empty\n");
182                 return NULL;
183         }
184
185         if (ast_strlen_zero(resource)) {
186                 ast_log(LOG_ERROR, "Endpoint resource cannot be empty\n");
187                 return NULL;
188         }
189
190         endpoint = ao2_alloc(sizeof(*endpoint), endpoint_dtor);
191         if (!endpoint) {
192                 return NULL;
193         }
194
195         endpoint->max_channels = -1;
196         endpoint->state = AST_ENDPOINT_UNKNOWN;
197
198         if (ast_string_field_init(endpoint, 80) != 0) {
199                 return NULL;
200         }
201
202         ast_string_field_set(endpoint, tech, tech);
203         ast_string_field_set(endpoint, resource, resource);
204         ast_string_field_build(endpoint, id, "%s/%s", tech, resource);
205
206         /* All access to channel_ids should be covered by the endpoint's
207          * lock; no extra lock needed. */
208         endpoint->channel_ids = ast_str_container_alloc_options(
209                 AO2_ALLOC_OPT_LOCK_NOLOCK, ENDPOINT_BUCKETS);
210         if (!endpoint->channel_ids) {
211                 return NULL;
212         }
213
214         endpoint->topic = stasis_topic_create(endpoint->id);
215         if (!endpoint->topic) {
216                 return NULL;
217         }
218
219         endpoint->forward =
220                 stasis_forward_all(endpoint->topic, ast_endpoint_topic_all());
221         if (!endpoint->forward) {
222                 return NULL;
223         }
224
225         endpoint->router = stasis_message_router_create(endpoint->topic);
226         if (!endpoint->router) {
227                 return NULL;
228         }
229         r |= stasis_message_router_add(endpoint->router,
230                 ast_channel_snapshot_type(), endpoint_channel_snapshot,
231                 endpoint);
232         r |= stasis_message_router_add(endpoint->router,
233                 stasis_cache_clear_type(), endpoint_cache_clear,
234                 endpoint);
235         r |= stasis_message_router_set_default(endpoint->router,
236                 endpoint_default, endpoint);
237
238         endpoint_publish_snapshot(endpoint);
239
240         ao2_ref(endpoint, +1);
241         return endpoint;
242 }
243
244 const char *ast_endpoint_get_tech(const struct ast_endpoint *endpoint)
245 {
246         ast_assert(endpoint != NULL);
247         return endpoint->tech;
248 }
249
250 void ast_endpoint_shutdown(struct ast_endpoint *endpoint)
251 {
252         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
253
254         if (endpoint == NULL) {
255                 return;
256         }
257
258         message = stasis_cache_clear_create(ast_endpoint_snapshot_type(), endpoint->id);
259         if (message) {
260                 stasis_publish(endpoint->topic, message);
261         }
262
263         /* Bump refcount to hold on to the router */
264         ao2_ref(endpoint->router, +1);
265         stasis_message_router_unsubscribe(endpoint->router);
266 }
267
268 const char *ast_endpoint_get_resource(const struct ast_endpoint *endpoint)
269 {
270         return endpoint->resource;
271 }
272
273 struct stasis_topic *ast_endpoint_topic(struct ast_endpoint *endpoint)
274 {
275         return endpoint ? endpoint->topic : ast_endpoint_topic_all();
276 }
277
278 void ast_endpoint_set_state(struct ast_endpoint *endpoint,
279         enum ast_endpoint_state state)
280 {
281         ast_assert(endpoint != NULL);
282         ao2_lock(endpoint);
283         endpoint->state = state;
284         ao2_unlock(endpoint);
285         endpoint_publish_snapshot(endpoint);
286 }
287
288 void ast_endpoint_set_max_channels(struct ast_endpoint *endpoint,
289         int max_channels)
290 {
291         ast_assert(endpoint != NULL);
292         ao2_lock(endpoint);
293         endpoint->max_channels = max_channels;
294         ao2_unlock(endpoint);
295         endpoint_publish_snapshot(endpoint);
296 }
297
298 static void endpoint_snapshot_dtor(void *obj)
299 {
300         struct ast_endpoint_snapshot *snapshot = obj;
301
302         ast_assert(snapshot != NULL);
303         ast_string_field_free_memory(snapshot);
304 }
305
306 struct ast_endpoint_snapshot *ast_endpoint_snapshot_create(
307         struct ast_endpoint *endpoint)
308 {
309         RAII_VAR(struct ast_endpoint_snapshot *, snapshot, NULL, ao2_cleanup);
310         int channel_count;
311         struct ao2_iterator i;
312         void *obj;
313         SCOPED_AO2LOCK(lock, endpoint);
314
315         channel_count = ao2_container_count(endpoint->channel_ids);
316
317         snapshot = ao2_alloc(
318                 sizeof(*snapshot) + channel_count * sizeof(char *),
319                 endpoint_snapshot_dtor);
320
321         if (ast_string_field_init(snapshot, 80) != 0) {
322                 return NULL;
323         }
324
325         ast_string_field_build(snapshot, id, "%s/%s", endpoint->tech,
326                 endpoint->resource);
327         ast_string_field_set(snapshot, tech, endpoint->tech);
328         ast_string_field_set(snapshot, resource, endpoint->resource);
329
330         snapshot->state = endpoint->state;
331         snapshot->max_channels = endpoint->max_channels;
332
333         i = ao2_iterator_init(endpoint->channel_ids, 0);
334         while ((obj = ao2_iterator_next(&i))) {
335                 RAII_VAR(char *, channel_id, obj, ao2_cleanup);
336                 snapshot->channel_ids[snapshot->num_channels++] = channel_id;
337         }
338
339         ao2_ref(snapshot, +1);
340         return snapshot;
341 }