5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2005 - 2008 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 #include "silcruntime.h"
22 /************************** Types and definitions ***************************/
24 /* Stream operation functions (platform specific) */
25 int silc_socket_stream_read(SilcStream stream, unsigned char *buf,
27 int silc_socket_stream_write(SilcStream stream, const unsigned char *data,
29 SilcBool silc_socket_stream_close(SilcStream stream);
30 void silc_socket_stream_destroy(SilcStream stream);
31 int silc_socket_udp_stream_read(SilcStream stream, unsigned char *buf,
33 int silc_socket_udp_stream_write(SilcStream stream, const unsigned char *data,
35 SilcBool silc_socket_stream_close(SilcStream stream);
36 void silc_socket_stream_destroy(SilcStream stream);
37 SilcBool silc_socket_stream_notifier(SilcStream stream,
38 SilcSchedule schedule,
39 SilcStreamNotifier callback,
41 SilcSchedule silc_socket_stream_get_schedule(SilcStream stream);
43 /* Internal async host lookup context. */
45 SilcSocketStream stream;
47 SilcSocketStreamCallback callback;
48 SilcAsyncOperation op;
50 unsigned int require_fqdn : 1;
51 unsigned int aborted : 1;
52 } *SilcSocketHostLookup;
55 /************************ Static utility functions **************************/
57 /* Finishing timeout callback that will actually call the user specified
58 host lookup callback. This is executed back in the calling thread and
59 not in the lookup thread. */
61 SILC_TASK_CALLBACK(silc_socket_host_lookup_finish)
63 SilcSocketHostLookup lookup = context;
64 SilcSocketStream stream = lookup->stream;
66 if (lookup->aborted) {
67 SILC_LOG_DEBUG(("Socket stream creation was aborted"));
68 stream->schedule = NULL;
69 silc_socket_stream_destroy(stream);
74 if (lookup->status != SILC_OK) {
75 SILC_LOG_DEBUG(("Socket stream lookup failed"));
76 stream->schedule = NULL;
77 silc_socket_stream_destroy(stream);
78 stream = lookup->stream = NULL;
81 /* Return the created socket stream to the caller */
83 lookup->callback(lookup->status, stream, lookup->context);
86 silc_async_free(lookup->op);
90 /* The thread function that performs the actual lookup. */
92 static void *silc_socket_host_lookup_start(void *context)
94 SilcSocketHostLookup lookup = (SilcSocketHostLookup)context;
95 SilcSocketStream stream = lookup->stream;
96 SilcSchedule schedule = stream->schedule;
98 stream->port = silc_net_get_remote_port(stream->sock);
100 silc_net_check_host_by_sock(stream->sock, &stream->hostname, &stream->ip);
102 lookup->status = SILC_ERR_UNKNOWN_IP;
106 if (!stream->hostname && lookup->require_fqdn) {
107 lookup->status = SILC_ERR_UNKNOWN_HOST;
111 if (!stream->hostname) {
112 stream->hostname = silc_strdup(stream->ip);
113 if (!stream->hostname) {
114 lookup->status = SILC_ERR_OUT_OF_MEMORY;
119 lookup->status = SILC_OK;
122 silc_schedule_task_add_timeout(schedule, silc_socket_host_lookup_finish,
124 silc_schedule_wakeup(schedule);
128 /* Abort callback for stream creation. */
130 static void silc_socket_host_lookup_abort(SilcAsyncOperation op,
133 SilcSocketHostLookup lookup = context;
135 /* The host lookup is done in thread. We'll let it finish in its own
136 good time and handle the abortion after it finishes. */
137 lookup->aborted = TRUE;
141 /******************************* Public API *********************************/
143 /* Creates TCP socket stream */
146 silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
147 SilcBool require_fqdn,
148 SilcSchedule schedule,
149 SilcSocketStreamCallback callback,
152 SilcSocketStream stream;
153 SilcSocketHostLookup l;
156 schedule = silc_schedule_get_global();
158 silc_set_errno(SILC_ERR_INVALID_ARGUMENT);
160 callback(silc_errno, NULL, context);
166 silc_set_errno(SILC_ERR_INVALID_ARGUMENT);
168 callback(silc_errno, NULL, context);
172 stream = silc_calloc(1, sizeof(*stream));
175 callback(silc_errno, NULL, context);
179 SILC_LOG_DEBUG(("Creating TCP socket stream %p, sock %lu", stream, sock));
181 stream->ops = &silc_socket_stream_ops;
183 stream->schedule = schedule;
184 stream->connected = TRUE;
186 l = silc_calloc(1, sizeof(*l));
190 callback(silc_errno, NULL, context);
195 l->callback = callback;
196 l->context = context;
197 l->require_fqdn = require_fqdn;
200 /* Start asynchronous IP, hostname and port lookup process */
201 l->op = silc_async_alloc(silc_socket_host_lookup_abort, NULL, l);
206 callback(silc_errno, NULL, context);
210 /* Lookup in thread */
211 SILC_LOG_DEBUG(("Starting async host lookup"));
212 silc_thread_create(silc_socket_host_lookup_start, l, FALSE);
217 silc_socket_host_lookup_finish(schedule,
218 silc_schedule_get_context(schedule),
224 /* Creates UDP socket stream */
226 SilcStream silc_socket_udp_stream_create(SilcSocket sock, SilcBool ipv6,
228 SilcSchedule schedule)
230 SilcSocketStream stream;
233 schedule = silc_schedule_get_global();
235 silc_set_errno(SILC_ERR_INVALID_ARGUMENT);
240 stream = silc_calloc(1, sizeof(*stream));
244 SILC_LOG_DEBUG(("Creating UDP socket stream %p", stream));
246 stream->ops = &silc_socket_udp_stream_ops;
248 stream->schedule = schedule;
250 stream->connected = connected;
252 return (SilcStream)stream;
255 /* Returns TRUE if the stream is UDP stream */
257 SilcBool silc_socket_stream_is_udp(SilcStream stream, SilcBool *connected)
259 SilcSocketStream socket_stream = stream;
261 if (!SILC_IS_SOCKET_STREAM_UDP(socket_stream))
265 *connected = socket_stream->connected;
270 /* Returns socket stream information */
272 SilcBool silc_socket_stream_get_info(SilcStream stream,
273 SilcSocket *sock, const char **hostname,
274 const char **ip, SilcUInt16 *port)
276 SilcSocketStream socket_stream = stream;
278 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
279 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
283 *sock = socket_stream->sock;
285 if (!socket_stream->port)
287 *port = socket_stream->port;
290 if (!socket_stream->ip)
292 *ip = socket_stream->ip;
295 if (!socket_stream->hostname)
297 *hostname = socket_stream->hostname;
303 /* Set socket information */
305 SilcBool silc_socket_stream_set_info(SilcStream stream,
306 const char *hostname,
307 const char *ip, SilcUInt16 port)
309 SilcSocketStream socket_stream = stream;
311 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
312 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
316 silc_free(socket_stream->hostname);
317 socket_stream->hostname = silc_strdup(hostname);
318 if (!socket_stream->hostname)
322 silc_free(socket_stream->ip);
323 socket_stream->ip = silc_strdup(ip);
324 if (!socket_stream->ip)
326 if (!socket_stream->hostname) {
327 socket_stream->hostname = silc_strdup(ip);
328 if (!socket_stream->hostname)
333 socket_stream->port = port;
338 /* Set QoS for socket stream */
340 SilcBool silc_socket_stream_set_qos(SilcStream stream,
341 SilcUInt32 read_rate,
342 SilcUInt32 read_limit_bytes,
343 SilcUInt32 limit_sec,
344 SilcUInt32 limit_usec)
346 SilcSocketStream socket_stream = stream;
348 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
349 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
352 SILC_LOG_DEBUG(("Setting QoS for socket stream"));
354 if (socket_stream->qos && !read_rate && !read_limit_bytes &&
355 !limit_sec && !limit_usec) {
356 silc_schedule_task_del_by_context(socket_stream->schedule,
358 silc_free(socket_stream->qos);
359 socket_stream->qos = NULL;
363 if (!socket_stream->qos) {
364 socket_stream->qos = silc_calloc(1, sizeof(*socket_stream->qos));
365 if (!socket_stream->qos)
369 socket_stream->qos->read_rate = read_rate;
370 socket_stream->qos->read_limit_bytes = read_limit_bytes;
371 socket_stream->qos->limit_sec = limit_sec;
372 socket_stream->qos->limit_usec = limit_usec;
373 memset(&socket_stream->qos->next_limit, 0,
374 sizeof(socket_stream->qos->next_limit));
375 socket_stream->qos->cur_rate = 0;
376 socket_stream->qos->sock = socket_stream;
378 socket_stream->qos->buffer = silc_malloc(read_limit_bytes);
379 if (!socket_stream->qos->buffer)
385 /* Return associated scheduler */
387 SilcSchedule silc_socket_stream_get_schedule(SilcStream stream)
389 SilcSocketStream socket_stream = stream;
391 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
392 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
395 return socket_stream->schedule;
398 /* SILC Socket Stream ops. Functions are implemented under the
399 platform specific subdirectories. */
400 const SilcStreamOps silc_socket_stream_ops =
402 silc_socket_stream_read,
403 silc_socket_stream_write,
404 silc_socket_stream_close,
405 silc_socket_stream_destroy,
406 silc_socket_stream_notifier,
407 silc_socket_stream_get_schedule,
409 const SilcStreamOps silc_socket_udp_stream_ops =
411 silc_socket_udp_stream_read,
412 silc_socket_udp_stream_write,
413 silc_socket_stream_close,
414 silc_socket_stream_destroy,
415 silc_socket_stream_notifier,
416 silc_socket_stream_get_schedule,