5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2005 - 2007 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.
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;
46 SilcSocketStreamStatus status;
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_SOCKET_OK) {
75 SILC_LOG_DEBUG(("Socket stream 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_SOCKET_UNKNOWN_IP;
106 if (!stream->hostname && lookup->require_fqdn) {
107 lookup->status = SILC_SOCKET_UNKNOWN_HOST;
111 if (!stream->hostname) {
112 stream->hostname = strdup(stream->ip);
113 if (!stream->hostname) {
114 lookup->status = SILC_SOCKET_NO_MEMORY;
119 lookup->status = SILC_SOCKET_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;
157 callback(SILC_SOCKET_ERROR, NULL, context);
161 stream = silc_calloc(1, sizeof(*stream));
164 callback(SILC_SOCKET_NO_MEMORY, NULL, context);
168 SILC_LOG_DEBUG(("Creating TCP socket stream %p, sock %lu", stream, sock));
170 stream->ops = &silc_socket_stream_ops;
172 stream->schedule = schedule;
174 l = silc_calloc(1, sizeof(*l));
178 callback(SILC_SOCKET_NO_MEMORY, NULL, context);
183 l->callback = callback;
184 l->context = context;
185 l->require_fqdn = require_fqdn;
188 /* Start asynchronous IP, hostname and port lookup process */
189 l->op = silc_async_alloc(silc_socket_host_lookup_abort, NULL, l);
194 callback(SILC_SOCKET_ERROR, NULL, context);
198 /* Lookup in thread */
199 SILC_LOG_DEBUG(("Starting async host lookup"));
200 silc_thread_create(silc_socket_host_lookup_start, l, FALSE);
204 l->status = SILC_SOCKET_OK;
205 silc_socket_host_lookup_finish(schedule,
206 silc_schedule_get_context(schedule),
212 /* Creates UDP socket stream */
214 SilcStream silc_socket_udp_stream_create(SilcSocket sock, SilcBool ipv6,
216 SilcSchedule schedule)
218 SilcSocketStream stream;
220 stream = silc_calloc(1, sizeof(*stream));
224 SILC_LOG_DEBUG(("Creating UDP socket stream %p", stream));
226 stream->ops = &silc_socket_udp_stream_ops;
228 stream->schedule = schedule;
230 stream->connected = connected;
232 return (SilcStream)stream;
235 /* Returns TRUE if the stream is UDP stream */
237 SilcBool silc_socket_stream_is_udp(SilcStream stream, SilcBool *connected)
239 SilcSocketStream socket_stream = stream;
241 if (!SILC_IS_SOCKET_STREAM_UDP(socket_stream))
245 *connected = socket_stream->connected;
250 /* Returns socket stream information */
252 SilcBool silc_socket_stream_get_info(SilcStream stream,
253 SilcSocket *sock, const char **hostname,
254 const char **ip, SilcUInt16 *port)
256 SilcSocketStream socket_stream = stream;
258 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
259 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
263 *sock = socket_stream->sock;
265 if (!socket_stream->port)
267 *port = socket_stream->port;
270 if (!socket_stream->ip)
272 *ip = socket_stream->ip;
275 if (!socket_stream->hostname)
277 *hostname = socket_stream->hostname;
283 /* Set socket information */
285 SilcBool silc_socket_stream_set_info(SilcStream stream,
286 const char *hostname,
287 const char *ip, SilcUInt16 port)
289 SilcSocketStream socket_stream = stream;
291 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
292 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
296 silc_free(socket_stream->hostname);
297 socket_stream->hostname = strdup(hostname);
298 if (!socket_stream->hostname)
302 silc_free(socket_stream->ip);
303 socket_stream->ip = strdup(ip);
304 if (!socket_stream->ip)
306 if (!socket_stream->hostname) {
307 socket_stream->hostname = strdup(ip);
308 if (!socket_stream->hostname)
313 socket_stream->port = port;
318 /* Return socket errno */
320 int silc_socket_stream_get_error(SilcStream stream)
322 SilcSocketStream socket_stream = stream;
324 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
325 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
328 return socket_stream->sock_error;
331 /* Set QoS for socket stream */
333 SilcBool silc_socket_stream_set_qos(SilcStream stream,
334 SilcUInt32 read_rate,
335 SilcUInt32 read_limit_bytes,
336 SilcUInt32 limit_sec,
337 SilcUInt32 limit_usec)
339 SilcSocketStream socket_stream = stream;
341 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
342 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
345 SILC_LOG_DEBUG(("Setting QoS for socket stream"));
347 if (socket_stream->qos && !read_rate && !read_limit_bytes &&
348 !limit_sec && !limit_usec) {
349 silc_schedule_task_del_by_context(socket_stream->schedule,
351 silc_free(socket_stream->qos);
352 socket_stream->qos = NULL;
356 if (!socket_stream->qos) {
357 socket_stream->qos = silc_calloc(1, sizeof(*socket_stream->qos));
358 if (!socket_stream->qos)
362 socket_stream->qos->read_rate = read_rate;
363 socket_stream->qos->read_limit_bytes = read_limit_bytes;
364 socket_stream->qos->limit_sec = limit_sec;
365 socket_stream->qos->limit_usec = limit_usec;
366 memset(&socket_stream->qos->next_limit, 0,
367 sizeof(socket_stream->qos->next_limit));
368 socket_stream->qos->cur_rate = 0;
369 socket_stream->qos->sock = socket_stream;
371 socket_stream->qos->buffer = silc_malloc(read_limit_bytes);
372 if (!socket_stream->qos->buffer)
378 /* Return associated scheduler */
380 SilcSchedule silc_socket_stream_get_schedule(SilcStream stream)
382 SilcSocketStream socket_stream = stream;
384 if (!SILC_IS_SOCKET_STREAM(socket_stream) &&
385 !SILC_IS_SOCKET_STREAM_UDP(socket_stream))
388 return socket_stream->schedule;
391 /* SILC Socket Stream ops. Functions are implemented under the
392 platform specific subdirectories. */
393 const SilcStreamOps silc_socket_stream_ops =
395 silc_socket_stream_read,
396 silc_socket_stream_write,
397 silc_socket_stream_close,
398 silc_socket_stream_destroy,
399 silc_socket_stream_notifier,
400 silc_socket_stream_get_schedule,
402 const SilcStreamOps silc_socket_udp_stream_ops =
404 silc_socket_udp_stream_read,
405 silc_socket_udp_stream_write,
406 silc_socket_stream_close,
407 silc_socket_stream_destroy,
408 silc_socket_stream_notifier,
409 silc_socket_stream_get_schedule,