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)
229 GCancellablePrivate *priv;
231 priv = cancellable->priv;
232 if (pipe (priv->cancel_pipe) == 0)
234 /* Make them nonblocking, just to be sure we don't block
235 * on errors and stuff
237 set_fd_nonblocking (priv->cancel_pipe[0]);
238 set_fd_nonblocking (priv->cancel_pipe[1]);
239 set_fd_close_exec (priv->cancel_pipe[0]);
240 set_fd_close_exec (priv->cancel_pipe[1]);
246 g_cancellable_init (GCancellable *cancellable)
248 cancellable->priv = G_TYPE_INSTANCE_GET_PRIVATE (cancellable,
250 GCancellablePrivate);
251 cancellable->priv->cancel_pipe[0] = -1;
252 cancellable->priv->cancel_pipe[1] = -1;
258 * Creates a new #GCancellable object.
260 * Applications that want to start one or more operations
261 * that should be cancellable should create a #GCancellable
262 * and pass it to the operations.
264 * One #GCancellable can be used in multiple consecutive
265 * operations, but not in multiple concurrent operations.
267 * Returns: a #GCancellable.
270 g_cancellable_new (void)
272 return g_object_new (G_TYPE_CANCELLABLE, NULL);
276 * g_cancellable_push_current:
277 * @cancellable: a #GCancellable object
279 * Pushes @cancellable onto the cancellable stack. The current
280 * cancllable can then be recieved using g_cancellable_get_current().
282 * This is useful when implementing cancellable operations in
283 * code that does not allow you to pass down the cancellable object.
285 * This is typically called automatically by e.g. #GFile operations,
286 * so you rarely have to call this yourself.
289 g_cancellable_push_current (GCancellable *cancellable)
293 g_return_if_fail (cancellable != NULL);
295 l = g_static_private_get (¤t_cancellable);
296 l = g_slist_prepend (l, cancellable);
297 g_static_private_set (¤t_cancellable, l, NULL);
301 * g_cancellable_pop_current:
302 * @cancellable: a #GCancellable object
304 * Pops @cancellable off the cancellable stack (verifying that @cancellable
305 * is on the top of the stack).
308 g_cancellable_pop_current (GCancellable *cancellable)
312 l = g_static_private_get (¤t_cancellable);
314 g_return_if_fail (l != NULL);
315 g_return_if_fail (l->data == cancellable);
317 l = g_slist_delete_link (l, l);
318 g_static_private_set (¤t_cancellable, l, NULL);
322 * g_cancellable_get_current:
324 * Gets the top cancellable from the stack.
326 * Returns: a #GCancellable from the top of the stack, or %NULL
327 * if the stack is empty.
330 g_cancellable_get_current (void)
334 l = g_static_private_get (¤t_cancellable);
338 return G_CANCELLABLE (l->data);
342 * g_cancellable_reset:
343 * @cancellable: a #GCancellable object.
345 * Resets @cancellable to its uncancelled state.
348 g_cancellable_reset (GCancellable *cancellable)
350 GCancellablePrivate *priv;
352 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
356 priv = cancellable->priv;
358 while (priv->cancelled_running)
360 priv->cancelled_running_waiting = TRUE;
361 g_cond_wait (cancellable_cond,
362 g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
369 /* Make sure we're not leaving old cancel state around */
373 ResetEvent (priv->event);
376 if (priv->cancel_pipe[0] != -1)
377 read (priv->cancel_pipe[0], &ch, 1);
378 priv->cancelled = FALSE;
380 G_UNLOCK(cancellable);
384 * g_cancellable_is_cancelled:
385 * @cancellable: a #GCancellable or NULL.
387 * Checks if a cancellable job has been cancelled.
389 * Returns: %TRUE if @cancellable is cancelled,
390 * FALSE if called with %NULL or if item is not cancelled.
393 g_cancellable_is_cancelled (GCancellable *cancellable)
395 return cancellable != NULL && cancellable->priv->cancelled;
399 * g_cancellable_set_error_if_cancelled:
400 * @cancellable: a #GCancellable object.
401 * @error: #GError to append error state to.
403 * If the @cancellable is cancelled, sets the error to notify
404 * that the operation was cancelled.
406 * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not.
409 g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
412 if (g_cancellable_is_cancelled (cancellable))
414 g_set_error_literal (error,
416 G_IO_ERROR_CANCELLED,
417 _("Operation was cancelled"));
425 * g_cancellable_get_fd:
426 * @cancellable: a #GCancellable.
428 * Gets the file descriptor for a cancellable job. This can be used to
429 * implement cancellable operations on Unix systems. The returned fd will
430 * turn readable when @cancellable is cancelled.
432 * You are not supposed to read from the fd yourself, just check for
433 * readable status. Reading to unset the readable status is done
434 * with g_cancellable_reset().
436 * After a successful return from this function, you should use
437 * g_cancellable_release_fd() to free up resources allocated for
438 * the returned file descriptor.
440 * See also g_cancellable_make_pollfd().
442 * Returns: A valid file descriptor. %-1 if the file descriptor
443 * is not supported, or on errors.
446 g_cancellable_get_fd (GCancellable *cancellable)
448 GCancellablePrivate *priv;
451 if (cancellable == NULL)
454 priv = cancellable->priv;
460 if (priv->cancel_pipe[0] == -1)
461 g_cancellable_open_pipe (cancellable);
462 fd = priv->cancel_pipe[0];
465 G_UNLOCK(cancellable);
472 * g_cancellable_make_pollfd:
473 * @cancellable: a #GCancellable or %NULL
474 * @pollfd: a pointer to a #GPollFD
476 * Creates a #GPollFD corresponding to @cancellable; this can be passed
477 * to g_poll() and used to poll for cancellation. This is useful both
478 * for unix systems without a native poll and for portability to
481 * When this function returns %TRUE, you should use
482 * g_cancellable_release_fd() to free up resources allocated for the
483 * @pollfd. After a %FALSE return, do not call g_cancellable_release_fd().
485 * If this function returns %FALSE, either no @cancellable was given or
486 * resource limits prevent this function from allocating the necessary
487 * structures for polling. (On Linux, you will likely have reached
488 * the maximum number of file descriptors.) The suggested way to handle
489 * these cases is to ignore the @cancellable.
491 * You are not supposed to read from the fd yourself, just check for
492 * readable status. Reading to unset the readable status is done
493 * with g_cancellable_reset().
495 * @Returns: %TRUE if @pollfd was successfully initialized, %FALSE on
496 * failure to prepare the cancellable.
501 g_cancellable_make_pollfd (GCancellable *cancellable, GPollFD *pollfd)
503 GCancellablePrivate *priv;
505 g_return_val_if_fail (pollfd != NULL, FALSE);
506 if (cancellable == NULL)
508 g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), FALSE);
510 priv = cancellable->priv;
514 if (priv->event == NULL)
516 /* A manual reset anonymous event, starting unset */
517 priv->event = CreateEvent (NULL, TRUE, FALSE, NULL);
518 if (priv->event == NULL)
520 G_UNLOCK(cancellable);
526 G_UNLOCK(cancellable);
528 pollfd->fd = (gintptr)priv->event;
529 #else /* !G_OS_WIN32 */
531 int fd = g_cancellable_get_fd (cancellable);
536 #endif /* G_OS_WIN32 */
537 pollfd->events = G_IO_IN;
544 * g_cancellable_release_fd:
545 * @cancellable: a #GCancellable
547 * Releases a resources previously allocated by g_cancellable_get_fd()
548 * or g_cancellable_make_pollfd().
550 * For compatibility reasons with older releases, calling this function
551 * is not strictly required, the resources will be automatically freed
552 * when the @cancellable is finalized. However, the @cancellable will
553 * block scarce file descriptors until it is finalized if this function
554 * is not called. This can cause the application to run out of file
555 * descriptors when many #GCancellables are used at the same time.
560 g_cancellable_release_fd (GCancellable *cancellable)
562 GCancellablePrivate *priv;
564 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
565 g_return_if_fail (cancellable->priv->fd_refcount > 0);
567 priv = cancellable->priv;
569 G_LOCK (cancellable);
571 if (priv->fd_refcount == 0)
572 g_cancellable_close_pipe (cancellable);
573 G_UNLOCK (cancellable);
577 * g_cancellable_cancel:
578 * @cancellable: a #GCancellable object.
580 * Will set @cancellable to cancelled, and will emit the
581 * #GCancellable::cancelled signal. (However, see the warning about
582 * race conditions in the documentation for that signal if you are
583 * planning to connect to it.)
585 * This function is thread-safe. In other words, you can safely call
586 * it from a thread other than the one running the operation that was
587 * passed the @cancellable.
589 * The convention within gio is that cancelling an asynchronous
590 * operation causes it to complete asynchronously. That is, if you
591 * cancel the operation from the same thread in which it is running,
592 * then the operation's #GAsyncReadyCallback will not be invoked until
593 * the application returns to the main loop.
596 g_cancellable_cancel (GCancellable *cancellable)
600 GCancellablePrivate *priv;
602 if (cancellable == NULL ||
603 cancellable->priv->cancelled)
606 priv = cancellable->priv;
611 priv->cancelled = TRUE;
612 priv->cancelled_running = TRUE;
615 SetEvent (priv->event);
617 if (priv->cancel_pipe[1] != -1)
618 write (priv->cancel_pipe[1], &ch, 1);
619 G_UNLOCK(cancellable);
623 g_object_ref (cancellable);
624 g_signal_emit (cancellable, signals[CANCELLED], 0);
628 priv->cancelled_running = FALSE;
629 if (priv->cancelled_running_waiting)
630 g_cond_broadcast (cancellable_cond);
631 priv->cancelled_running_waiting = FALSE;
633 G_UNLOCK(cancellable);
635 g_object_unref (cancellable);
640 * g_cancellable_connect:
641 * @cancellable: A #GCancellable.
642 * @callback: The #GCallback to connect.
643 * @data: Data to pass to @callback.
644 * @data_destroy_func: Free function for @data or %NULL.
646 * Convenience function to connect to the #GCancellable::cancelled
647 * signal. Also handles the race condition that may happen
648 * if the cancellable is cancelled right before connecting.
650 * @callback is called at most once, either directly at the
651 * time of the connect if @cancellable is already cancelled,
652 * or when @cancellable is cancelled in some thread.
654 * @data_destroy_func will be called when the handler is
655 * disconnected, or immediately if the cancellable is already
658 * See #GCancellable::cancelled for details on how to use this.
660 * Returns: The id of the signal handler or 0 if @cancellable has already
666 g_cancellable_connect (GCancellable *cancellable,
669 GDestroyNotify data_destroy_func)
673 g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), 0);
675 G_LOCK (cancellable);
677 if (cancellable->priv->cancelled)
679 void (*_callback) (GCancellable *cancellable,
682 _callback = (void *)callback;
685 _callback (cancellable, data);
687 if (data_destroy_func)
688 data_destroy_func (data);
692 id = g_signal_connect_data (cancellable, "cancelled",
694 (GClosureNotify) data_destroy_func,
697 G_UNLOCK (cancellable);
703 * g_cancellable_disconnect:
704 * @cancellable: A #GCancellable or %NULL.
705 * @handler_id: Handler id of the handler to be disconnected, or %0.
707 * Disconnects a handler from an cancellable instance similar to
708 * g_signal_handler_disconnect() but ensures that once this
709 * function returns the handler will not run anymore in any thread.
711 * This avoids a race condition where a thread cancels at the
712 * same time as the cancellable operation is finished and the
713 * signal handler is removed. See #GCancellable::cancelled for
714 * details on how to use this.
716 * If @cancellable is %NULL or @handler_id is %0 this function does
722 g_cancellable_disconnect (GCancellable *cancellable,
725 GCancellablePrivate *priv;
727 if (handler_id == 0 || cancellable == NULL)
730 G_LOCK (cancellable);
732 priv = cancellable->priv;
734 while (priv->cancelled_running)
736 priv->cancelled_running_waiting = TRUE;
737 g_cond_wait (cancellable_cond,
738 g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
741 g_signal_handler_disconnect (cancellable, handler_id);
742 G_UNLOCK (cancellable);
745 #define __G_CANCELLABLE_C__
746 #include "gioaliasdef.c"