1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
33 #include "gcancellable.h"
39 * SECTION:gcancellable
40 * @short_description: Thread-safe Operation Cancellation Stack
43 * GCancellable is a thread-safe operation cancellation stack used
44 * throughout GIO to allow for cancellation of synchronous and
45 * asynchronous operations.
53 struct _GCancellablePrivate
56 guint cancelled_running : 1;
57 guint cancelled_running_waiting : 1;
67 static guint signals[LAST_SIGNAL] = { 0 };
69 G_DEFINE_TYPE (GCancellable, g_cancellable, G_TYPE_OBJECT);
71 static GStaticPrivate current_cancellable = G_STATIC_PRIVATE_INIT;
72 G_LOCK_DEFINE_STATIC(cancellable);
73 static GCond *cancellable_cond = NULL;
76 g_cancellable_close_pipe (GCancellable *cancellable)
78 GCancellablePrivate *priv;
80 priv = cancellable->priv;
82 if (priv->cancel_pipe[0] != -1)
84 close (priv->cancel_pipe[0]);
85 priv->cancel_pipe[0] = -1;
88 if (priv->cancel_pipe[1] != -1)
90 close (priv->cancel_pipe[1]);
91 priv->cancel_pipe[1] = -1;
97 CloseHandle (priv->event);
104 g_cancellable_finalize (GObject *object)
106 GCancellable *cancellable = G_CANCELLABLE (object);
108 g_cancellable_close_pipe (cancellable);
110 G_OBJECT_CLASS (g_cancellable_parent_class)->finalize (object);
114 g_cancellable_class_init (GCancellableClass *klass)
116 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
118 g_type_class_add_private (klass, sizeof (GCancellablePrivate));
120 if (cancellable_cond == NULL && g_thread_supported ())
121 cancellable_cond = g_cond_new ();
123 gobject_class->finalize = g_cancellable_finalize;
126 * GCancellable::cancelled:
127 * @cancellable: a #GCancellable.
129 * Emitted when the operation has been cancelled.
131 * Can be used by implementations of cancellable operations. If the
132 * operation is cancelled from another thread, the signal will be
133 * emitted in the thread that cancelled the operation, not the
134 * thread that is running the operation.
136 * Note that disconnecting from this signal (or any signal) in a
137 * multi-threaded program is prone to race conditions. For instance
138 * it is possible that a signal handler may be invoked even
139 * <emphasis>after</emphasis> a call to
140 * g_signal_handler_disconnect() for that handler has already
143 * There is also a problem when cancellation happen
144 * right before connecting to the signal. If this happens the
145 * signal will unexpectedly not be emitted, and checking before
146 * connecting to the signal leaves a race condition where this is
149 * In order to make it safe and easy to connect handlers there
150 * are two helper functions: g_cancellable_connect() and
151 * g_cancellable_disconnect() which protect against problems
154 * An example of how to us this:
156 * /<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/
157 * if (g_cancellable_set_error_if_cancelled (cancellable))
160 * /<!-- -->* Set up all the data needed to be able to
161 * * handle cancellation of the operation *<!-- -->/
162 * my_data = my_data_new (...);
166 * id = g_cancellable_connect (cancellable,
167 * G_CALLBACK (cancelled_handler)
170 * /<!-- -->* cancellable operation here... *<!-- -->/
172 * g_cancellable_disconnect (cancellable, id);
174 * /<!-- -->* cancelled_handler is never called after this, it
175 * * is now safe to free the data *<!-- -->/
176 * my_data_free (my_data);
179 * Note that the cancelled signal is emitted in the thread that
180 * the user cancelled from, which may be the main thread. So, the
181 * cancellable signal should not do something that can block.
184 g_signal_new (I_("cancelled"),
185 G_TYPE_FROM_CLASS (gobject_class),
187 G_STRUCT_OFFSET (GCancellableClass, cancelled),
189 g_cclosure_marshal_VOID__VOID,
196 set_fd_nonblocking (int fd)
200 fcntl_flags = fcntl (fd, F_GETFL);
203 fcntl_flags |= O_NONBLOCK;
205 fcntl_flags |= O_NDELAY;
208 fcntl (fd, F_SETFL, fcntl_flags);
213 set_fd_close_exec (int fd)
217 flags = fcntl (fd, F_GETFD, 0);
218 if (flags != -1 && (flags & FD_CLOEXEC) == 0)
221 fcntl (fd, F_SETFD, flags);
227 g_cancellable_open_pipe (GCancellable *cancellable)
230 GCancellablePrivate *priv;
232 priv = cancellable->priv;
233 if (pipe (priv->cancel_pipe) == 0)
235 /* Make them nonblocking, just to be sure we don't block
236 * on errors and stuff
238 set_fd_nonblocking (priv->cancel_pipe[0]);
239 set_fd_nonblocking (priv->cancel_pipe[1]);
240 set_fd_close_exec (priv->cancel_pipe[0]);
241 set_fd_close_exec (priv->cancel_pipe[1]);
244 write (priv->cancel_pipe[1], &ch, 1);
250 g_cancellable_init (GCancellable *cancellable)
252 cancellable->priv = G_TYPE_INSTANCE_GET_PRIVATE (cancellable,
254 GCancellablePrivate);
255 cancellable->priv->cancel_pipe[0] = -1;
256 cancellable->priv->cancel_pipe[1] = -1;
262 * Creates a new #GCancellable object.
264 * Applications that want to start one or more operations
265 * that should be cancellable should create a #GCancellable
266 * and pass it to the operations.
268 * One #GCancellable can be used in multiple consecutive
269 * operations, but not in multiple concurrent operations.
271 * Returns: a #GCancellable.
274 g_cancellable_new (void)
276 return g_object_new (G_TYPE_CANCELLABLE, NULL);
280 * g_cancellable_push_current:
281 * @cancellable: a #GCancellable object
283 * Pushes @cancellable onto the cancellable stack. The current
284 * cancllable can then be recieved using g_cancellable_get_current().
286 * This is useful when implementing cancellable operations in
287 * code that does not allow you to pass down the cancellable object.
289 * This is typically called automatically by e.g. #GFile operations,
290 * so you rarely have to call this yourself.
293 g_cancellable_push_current (GCancellable *cancellable)
297 g_return_if_fail (cancellable != NULL);
299 l = g_static_private_get (¤t_cancellable);
300 l = g_slist_prepend (l, cancellable);
301 g_static_private_set (¤t_cancellable, l, NULL);
305 * g_cancellable_pop_current:
306 * @cancellable: a #GCancellable object
308 * Pops @cancellable off the cancellable stack (verifying that @cancellable
309 * is on the top of the stack).
312 g_cancellable_pop_current (GCancellable *cancellable)
316 l = g_static_private_get (¤t_cancellable);
318 g_return_if_fail (l != NULL);
319 g_return_if_fail (l->data == cancellable);
321 l = g_slist_delete_link (l, l);
322 g_static_private_set (¤t_cancellable, l, NULL);
326 * g_cancellable_get_current:
328 * Gets the top cancellable from the stack.
330 * Returns: a #GCancellable from the top of the stack, or %NULL
331 * if the stack is empty.
334 g_cancellable_get_current (void)
338 l = g_static_private_get (¤t_cancellable);
342 return G_CANCELLABLE (l->data);
346 * g_cancellable_reset:
347 * @cancellable: a #GCancellable object.
349 * Resets @cancellable to its uncancelled state.
352 g_cancellable_reset (GCancellable *cancellable)
354 GCancellablePrivate *priv;
356 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
360 priv = cancellable->priv;
362 while (priv->cancelled_running)
364 priv->cancelled_running_waiting = TRUE;
365 g_cond_wait (cancellable_cond,
366 g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
373 /* Make sure we're not leaving old cancel state around */
377 ResetEvent (priv->event);
379 if (priv->cancel_pipe[0] != -1)
380 read (priv->cancel_pipe[0], &ch, 1);
381 priv->cancelled = FALSE;
383 G_UNLOCK(cancellable);
387 * g_cancellable_is_cancelled:
388 * @cancellable: a #GCancellable or NULL.
390 * Checks if a cancellable job has been cancelled.
392 * Returns: %TRUE if @cancellable is cancelled,
393 * FALSE if called with %NULL or if item is not cancelled.
396 g_cancellable_is_cancelled (GCancellable *cancellable)
398 return cancellable != NULL && cancellable->priv->cancelled;
402 * g_cancellable_set_error_if_cancelled:
403 * @cancellable: a #GCancellable object.
404 * @error: #GError to append error state to.
406 * If the @cancellable is cancelled, sets the error to notify
407 * that the operation was cancelled.
409 * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not.
412 g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
415 if (g_cancellable_is_cancelled (cancellable))
417 g_set_error_literal (error,
419 G_IO_ERROR_CANCELLED,
420 _("Operation was cancelled"));
428 * g_cancellable_get_fd:
429 * @cancellable: a #GCancellable.
431 * Gets the file descriptor for a cancellable job. This can be used to
432 * implement cancellable operations on Unix systems. The returned fd will
433 * turn readable when @cancellable is cancelled.
435 * You are not supposed to read from the fd yourself, just check for
436 * readable status. Reading to unset the readable status is done
437 * with g_cancellable_reset().
439 * After a successful return from this function, you should use
440 * g_cancellable_release_fd() to free up resources allocated for
441 * the returned file descriptor.
443 * See also g_cancellable_make_pollfd().
445 * Returns: A valid file descriptor. %-1 if the file descriptor
446 * is not supported, or on errors.
449 g_cancellable_get_fd (GCancellable *cancellable)
451 GCancellablePrivate *priv;
454 if (cancellable == NULL)
457 priv = cancellable->priv;
463 if (priv->cancel_pipe[0] == -1)
464 g_cancellable_open_pipe (cancellable);
465 fd = priv->cancel_pipe[0];
468 G_UNLOCK(cancellable);
475 * g_cancellable_make_pollfd:
476 * @cancellable: a #GCancellable or %NULL
477 * @pollfd: a pointer to a #GPollFD
479 * Creates a #GPollFD corresponding to @cancellable; this can be passed
480 * to g_poll() and used to poll for cancellation. This is useful both
481 * for unix systems without a native poll and for portability to
484 * When this function returns %TRUE, you should use
485 * g_cancellable_release_fd() to free up resources allocated for the
486 * @pollfd. After a %FALSE return, do not call g_cancellable_release_fd().
488 * If this function returns %FALSE, either no @cancellable was given or
489 * resource limits prevent this function from allocating the necessary
490 * structures for polling. (On Linux, you will likely have reached
491 * the maximum number of file descriptors.) The suggested way to handle
492 * these cases is to ignore the @cancellable.
494 * You are not supposed to read from the fd yourself, just check for
495 * readable status. Reading to unset the readable status is done
496 * with g_cancellable_reset().
498 * Returns: %TRUE if @pollfd was successfully initialized, %FALSE on
499 * failure to prepare the cancellable.
504 g_cancellable_make_pollfd (GCancellable *cancellable, GPollFD *pollfd)
506 g_return_val_if_fail (pollfd != NULL, FALSE);
507 if (cancellable == NULL)
509 g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), FALSE);
513 GCancellablePrivate *priv;
515 priv = cancellable->priv;
517 if (priv->event == NULL)
519 /* A manual reset anonymous event, starting unset */
520 priv->event = CreateEvent (NULL, TRUE, FALSE, NULL);
521 if (priv->event == NULL)
523 G_UNLOCK(cancellable);
527 SetEvent(priv->event);
530 G_UNLOCK(cancellable);
532 pollfd->fd = (gintptr)priv->event;
533 #else /* !G_OS_WIN32 */
534 int fd = g_cancellable_get_fd (cancellable);
539 #endif /* G_OS_WIN32 */
542 pollfd->events = G_IO_IN;
549 * g_cancellable_release_fd:
550 * @cancellable: a #GCancellable
552 * Releases a resources previously allocated by g_cancellable_get_fd()
553 * or g_cancellable_make_pollfd().
555 * For compatibility reasons with older releases, calling this function
556 * is not strictly required, the resources will be automatically freed
557 * when the @cancellable is finalized. However, the @cancellable will
558 * block scarce file descriptors until it is finalized if this function
559 * is not called. This can cause the application to run out of file
560 * descriptors when many #GCancellables are used at the same time.
565 g_cancellable_release_fd (GCancellable *cancellable)
567 GCancellablePrivate *priv;
569 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
570 g_return_if_fail (cancellable->priv->fd_refcount > 0);
572 priv = cancellable->priv;
574 G_LOCK (cancellable);
576 if (priv->fd_refcount == 0)
577 g_cancellable_close_pipe (cancellable);
578 G_UNLOCK (cancellable);
582 * g_cancellable_cancel:
583 * @cancellable: a #GCancellable object.
585 * Will set @cancellable to cancelled, and will emit the
586 * #GCancellable::cancelled signal. (However, see the warning about
587 * race conditions in the documentation for that signal if you are
588 * planning to connect to it.)
590 * This function is thread-safe. In other words, you can safely call
591 * it from a thread other than the one running the operation that was
592 * passed the @cancellable.
594 * The convention within gio is that cancelling an asynchronous
595 * operation causes it to complete asynchronously. That is, if you
596 * cancel the operation from the same thread in which it is running,
597 * then the operation's #GAsyncReadyCallback will not be invoked until
598 * the application returns to the main loop.
601 g_cancellable_cancel (GCancellable *cancellable)
605 GCancellablePrivate *priv;
607 if (cancellable == NULL ||
608 cancellable->priv->cancelled)
611 priv = cancellable->priv;
616 priv->cancelled = TRUE;
617 priv->cancelled_running = TRUE;
620 SetEvent (priv->event);
622 if (priv->cancel_pipe[1] != -1)
623 write (priv->cancel_pipe[1], &ch, 1);
624 G_UNLOCK(cancellable);
628 g_object_ref (cancellable);
629 g_signal_emit (cancellable, signals[CANCELLED], 0);
633 priv->cancelled_running = FALSE;
634 if (priv->cancelled_running_waiting)
635 g_cond_broadcast (cancellable_cond);
636 priv->cancelled_running_waiting = FALSE;
638 G_UNLOCK(cancellable);
640 g_object_unref (cancellable);
645 * g_cancellable_connect:
646 * @cancellable: A #GCancellable.
647 * @callback: The #GCallback to connect.
648 * @data: Data to pass to @callback.
649 * @data_destroy_func: Free function for @data or %NULL.
651 * Convenience function to connect to the #GCancellable::cancelled
652 * signal. Also handles the race condition that may happen
653 * if the cancellable is cancelled right before connecting.
655 * @callback is called at most once, either directly at the
656 * time of the connect if @cancellable is already cancelled,
657 * or when @cancellable is cancelled in some thread.
659 * @data_destroy_func will be called when the handler is
660 * disconnected, or immediately if the cancellable is already
663 * See #GCancellable::cancelled for details on how to use this.
665 * Returns: The id of the signal handler or 0 if @cancellable has already
671 g_cancellable_connect (GCancellable *cancellable,
674 GDestroyNotify data_destroy_func)
678 g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), 0);
680 G_LOCK (cancellable);
682 if (cancellable->priv->cancelled)
684 void (*_callback) (GCancellable *cancellable,
687 _callback = (void *)callback;
690 _callback (cancellable, data);
692 if (data_destroy_func)
693 data_destroy_func (data);
697 id = g_signal_connect_data (cancellable, "cancelled",
699 (GClosureNotify) data_destroy_func,
702 G_UNLOCK (cancellable);
708 * g_cancellable_disconnect:
709 * @cancellable: A #GCancellable or %NULL.
710 * @handler_id: Handler id of the handler to be disconnected, or %0.
712 * Disconnects a handler from a cancellable instance similar to
713 * g_signal_handler_disconnect(). Additionally, in the event that a
714 * signal handler is currently running, this call will block until the
715 * handler has finished. Calling this function from a
716 * #GCancellable::cancelled signal handler will therefore result in a
719 * This avoids a race condition where a thread cancels at the
720 * same time as the cancellable operation is finished and the
721 * signal handler is removed. See #GCancellable::cancelled for
722 * details on how to use this.
724 * If @cancellable is %NULL or @handler_id is %0 this function does
730 g_cancellable_disconnect (GCancellable *cancellable,
733 GCancellablePrivate *priv;
735 if (handler_id == 0 || cancellable == NULL)
738 G_LOCK (cancellable);
740 priv = cancellable->priv;
742 while (priv->cancelled_running)
744 priv->cancelled_running_waiting = TRUE;
745 g_cond_wait (cancellable_cond,
746 g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
749 g_signal_handler_disconnect (cancellable, handler_id);
750 G_UNLOCK (cancellable);
753 #define __G_CANCELLABLE_C__
754 #include "gioaliasdef.c"