1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2008 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
30 #include "gwin32resolver.h"
31 #include "gnetworkingprivate.h"
33 #include "gcancellable.h"
34 #include "gsimpleasyncresult.h"
35 #include "gsocketaddress.h"
39 G_DEFINE_TYPE (GWin32Resolver, g_win32_resolver, G_TYPE_THREADED_RESOLVER)
42 g_win32_resolver_init (GWin32Resolver *gwr)
46 /* This is simpler than GThreadedResolver since we don't have to worry
47 * about multiple application-level threads, but more complicated than
48 * GUnixResolver, since we do have to deal with multiple threads of
51 * The various request possibilities:
53 * 1. Synchronous: handed off to the base class (GThreadedResolver);
54 * since it's never possible to cancel a synchronous request in a
55 * single-threaded program, the request is done in the calling
58 * 2. Asynchronous: A GWin32ResolverRequest is created with
59 * appropriate query-specific information, a Windows event handle,
60 * and a GSimpleAsyncResult. This is then handed to the
61 * Windows-internal thread pool, which does the raw DNS query part
62 * of the operation (being careful to not call any glib methods
63 * that might fail when called from another thread when
64 * g_thread_init() has not been called). The main thread sets up a
65 * GSource to asynchronously poll the event handle. There are two
68 * a. The resolution completes: the threadpool function calls
69 * SetEvent() on the event handle and then returns.
71 * b. The resolution is cancelled: request_cancelled()
72 * disconnects the "cancelled" signal handler, and queues an
73 * idle handler to complete the async_result.
75 * Since we can't free the request from the threadpool thread
76 * (because of glib locking issues), we *always* have to have it
77 * call SetEvent and trigger the callback to indicate that it is
78 * done. But this means that it's possible for the request to be
79 * cancelled (queuing an idle handler to return that result) and
80 * then have the resolution thread complete before the idle handler
81 * runs. So the event callback and the idle handler need to both
82 * watch out for this, making sure we don't complete the same
86 typedef struct GWin32ResolverRequest GWin32ResolverRequest;
87 typedef void (*GWin32ResolverRequestFreeFunc) (GWin32ResolverRequest *);
89 struct GWin32ResolverRequest {
90 GWin32ResolverRequestFreeFunc free_func;
92 GCancellable *cancellable;
96 GSimpleAsyncResult *async_result;
98 GSource *cancelled_idle;
104 struct addrinfo *res;
109 struct sockaddr_storage addr;
124 static GSource *g_win32_handle_source_add (HANDLE handle,
125 GSourceFunc callback,
128 static gboolean request_completed (gpointer user_data);
129 static void request_cancelled (GCancellable *cancellable,
132 GWin32ResolverRequest *
133 g_win32_resolver_request_new (GResolver *resolver,
134 GWin32ResolverRequestFreeFunc free_func,
135 GCancellable *cancellable,
136 GAsyncReadyCallback callback,
140 GWin32ResolverRequest *req;
142 req = g_slice_new0 (GWin32ResolverRequest);
143 req->free_func = free_func;
145 req->async_result = g_simple_async_result_new (G_OBJECT (resolver), callback,
147 g_simple_async_result_set_op_res_gpointer (req->async_result, req, NULL);
149 req->event = CreateEvent (NULL, FALSE, FALSE, NULL);
150 g_win32_handle_source_add (req->event, request_completed, req);
154 req->cancellable = g_object_ref (cancellable);
155 g_signal_connect (cancellable, "cancelled",
156 G_CALLBACK (request_cancelled), req);
163 request_completed (gpointer user_data)
165 GWin32ResolverRequest *req = user_data;
167 /* Clean up cancellation-related stuff first */
168 if (req->cancelled_idle)
170 g_source_destroy (req->cancelled_idle);
171 g_source_unref (req->cancelled_idle);
172 req->cancelled_idle = NULL;
174 if (req->cancellable)
176 g_signal_handlers_disconnect_by_func (req->cancellable, request_cancelled, req);
177 g_object_unref (req->cancellable);
180 /* Now complete the result (assuming it wasn't already completed) */
181 if (req->async_result)
183 g_simple_async_result_complete (req->async_result);
184 g_object_unref (req->async_result);
188 CloseHandle (req->event);
189 req->free_func (req);
190 g_slice_free (GWin32ResolverRequest, req);
196 request_cancelled_idle (gpointer user_data)
198 GWin32ResolverRequest *req = user_data;
199 GError *error = NULL;
201 g_source_unref (req->cancelled_idle);
202 req->cancelled_idle = NULL;
204 g_cancellable_set_error_if_cancelled (req->cancellable, &error);
205 g_simple_async_result_set_from_error (req->async_result, error);
206 g_simple_async_result_complete (req->async_result);
208 g_object_unref (req->async_result);
209 req->async_result = NULL;
211 /* request_completed will eventually be called to free req */
217 request_cancelled (GCancellable *cancellable,
220 GWin32ResolverRequest *req = user_data;
222 if (req->cancellable)
224 g_signal_handlers_disconnect_by_func (req->cancellable, request_cancelled, req);
225 g_object_unref (req->cancellable);
226 req->cancellable = NULL;
229 /* We need to wait until main-loop-time to actually complete the
230 * result; we don't use _complete_in_idle() here because we need to
231 * keep track of the source so we can potentially cancel it before
234 req->cancelled_idle = g_idle_source_new ();
235 g_source_set_callback (req->cancelled_idle,
236 (GSourceFunc)request_cancelled_idle, req, NULL);
237 g_source_attach (req->cancelled_idle, NULL);
241 lookup_by_name_in_thread (LPVOID data)
243 GWin32ResolverRequest *req = data;
245 req->u.name.retval = getaddrinfo (req->u.name.name, NULL,
246 &_g_resolver_addrinfo_hints,
248 SetEvent (req->event);
253 free_lookup_by_name (GWin32ResolverRequest *req)
255 g_free (req->u.name.name);
257 freeaddrinfo (req->u.name.res);
261 lookup_by_name_async (GResolver *resolver,
262 const gchar *hostname,
263 GCancellable *cancellable,
264 GAsyncReadyCallback callback,
267 GWin32ResolverRequest *req;
269 req = g_win32_resolver_request_new (resolver, free_lookup_by_name,
270 cancellable, callback, user_data,
271 lookup_by_name_async);
272 req->u.name.name = g_strdup (hostname);
274 QueueUserWorkItem (lookup_by_name_in_thread, req, 0);
278 lookup_by_name_finish (GResolver *resolver,
279 GAsyncResult *result,
282 GSimpleAsyncResult *simple;
283 GWin32ResolverRequest *req;
285 g_return_val_if_fail (g_simple_async_result_is_valid (result, G_OBJECT (resolver), lookup_by_name_async), NULL);
286 simple = G_SIMPLE_ASYNC_RESULT (result);
288 req = g_simple_async_result_get_op_res_gpointer (simple);
289 return _g_resolver_addresses_from_addrinfo (req->u.name.name, req->u.name.res,
290 req->u.name.retval, error);
295 lookup_by_addresses_in_thread (LPVOID data)
297 GWin32ResolverRequest *req = data;
299 req->u.address.retval =
300 getnameinfo ((struct sockaddr *)&req->u.address.addr,
301 req->u.address.addrlen,
302 req->u.address.namebuf, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
303 SetEvent (req->event);
308 free_lookup_by_address (GWin32ResolverRequest *req)
310 g_object_unref (req->u.address.iaddr);
311 g_free (req->u.address.namebuf);
315 lookup_by_address_async (GResolver *resolver,
316 GInetAddress *address,
317 GCancellable *cancellable,
318 GAsyncReadyCallback callback,
321 GWin32ResolverRequest *req;
323 req = g_win32_resolver_request_new (resolver, free_lookup_by_address,
324 cancellable, callback, user_data,
325 lookup_by_address_async);
327 req->u.address.iaddr = g_object_ref (address);
328 _g_resolver_address_to_sockaddr (address, &req->u.address.addr,
329 &req->u.address.addrlen);
330 req->u.address.namebuf = g_malloc (NI_MAXHOST);
332 QueueUserWorkItem (lookup_by_addresses_in_thread, req, 0);
336 lookup_by_address_finish (GResolver *resolver,
337 GAsyncResult *result,
340 GSimpleAsyncResult *simple;
341 GWin32ResolverRequest *req;
343 g_return_val_if_fail (g_simple_async_result_is_valid (result, G_OBJECT (resolver), lookup_by_address_async), NULL);
344 simple = G_SIMPLE_ASYNC_RESULT (result);
346 req = g_simple_async_result_get_op_res_gpointer (simple);
347 return _g_resolver_name_from_nameinfo (req->u.address.iaddr,
348 req->u.address.namebuf,
349 req->u.address.retval, error);
354 lookup_service_in_thread (LPVOID data)
356 GWin32ResolverRequest *req = data;
358 req->u.service.retval =
359 DnsQuery_A (req->u.service.rrname, DNS_TYPE_SRV, DNS_QUERY_STANDARD,
360 NULL, &req->u.service.results, NULL);
361 SetEvent (req->event);
366 free_lookup_service (GWin32ResolverRequest *req)
368 g_free (req->u.service.rrname);
369 if (req->u.service.results)
370 DnsRecordListFree (req->u.service.results, DnsFreeRecordList);
374 lookup_service_async (GResolver *resolver,
376 GCancellable *cancellable,
377 GAsyncReadyCallback callback,
380 GWin32ResolverRequest *req;
382 req = g_win32_resolver_request_new (resolver, free_lookup_service,
383 cancellable, callback, user_data,
384 lookup_service_async);
385 req->u.service.rrname = g_strdup (rrname);
387 QueueUserWorkItem (lookup_service_in_thread, req, 0);
391 lookup_service_finish (GResolver *resolver,
392 GAsyncResult *result,
395 GSimpleAsyncResult *simple;
396 GWin32ResolverRequest *req;
398 g_return_val_if_fail (g_simple_async_result_is_valid (result, G_OBJECT (resolver), lookup_service_async), NULL);
399 simple = G_SIMPLE_ASYNC_RESULT (result);
401 req = g_simple_async_result_get_op_res_gpointer (simple);
402 return _g_resolver_targets_from_DnsQuery (req->u.service.rrname,
403 req->u.service.retval,
404 req->u.service.results, error);
409 g_win32_resolver_class_init (GWin32ResolverClass *win32_class)
411 GResolverClass *resolver_class = G_RESOLVER_CLASS (win32_class);
413 resolver_class->lookup_by_name_async = lookup_by_name_async;
414 resolver_class->lookup_by_name_finish = lookup_by_name_finish;
415 resolver_class->lookup_by_address_async = lookup_by_address_async;
416 resolver_class->lookup_by_address_finish = lookup_by_address_finish;
417 resolver_class->lookup_service_async = lookup_service_async;
418 resolver_class->lookup_service_finish = lookup_service_finish;
422 /* Windows HANDLE GSource */
427 } GWin32HandleSource;
430 g_win32_handle_source_prepare (GSource *source,
438 g_win32_handle_source_check (GSource *source)
440 GWin32HandleSource *hsource = (GWin32HandleSource *)source;
442 return hsource->pollfd.revents;
446 g_win32_handle_source_dispatch (GSource *source,
447 GSourceFunc callback,
450 return (*callback) (user_data);
454 g_win32_handle_source_finalize (GSource *source)
459 GSourceFuncs g_win32_handle_source_funcs = {
460 g_win32_handle_source_prepare,
461 g_win32_handle_source_check,
462 g_win32_handle_source_dispatch,
463 g_win32_handle_source_finalize
467 g_win32_handle_source_add (HANDLE handle,
468 GSourceFunc callback,
471 GWin32HandleSource *hsource;
474 source = g_source_new (&g_win32_handle_source_funcs, sizeof (GWin32HandleSource));
475 hsource = (GWin32HandleSource *)source;
476 hsource->pollfd.fd = (gint)handle;
477 hsource->pollfd.events = G_IO_IN;
478 hsource->pollfd.revents = 0;
479 g_source_add_poll (source, &hsource->pollfd);
481 g_source_set_callback (source, callback, user_data, NULL);
482 g_source_attach (source, NULL);
486 #define __G_WIN32_RESOLVER_C__
487 #include "gioaliasdef.c"