Fix gtk-doc syntax
[platform/upstream/glib.git] / gio / gcancellable.c
1 /* GIO - GLib Input, Output and Streaming Library
2  * 
3  * Copyright (C) 2006-2007 Red Hat, Inc.
4  *
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.
9  *
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.
14  *
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.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #include "config.h"
24 #ifdef HAVE_UNISTD_H
25 #include <unistd.h>
26 #endif
27 #include <fcntl.h>
28 #include <gioerror.h>
29 #ifdef G_OS_WIN32
30 #include <windows.h>
31 #include <io.h>
32 #endif
33 #include "gcancellable.h"
34 #include "glibintl.h"
35
36 #include "gioalias.h"
37
38 /**
39  * SECTION:gcancellable
40  * @short_description: Thread-safe Operation Cancellation Stack
41  * @include: gio/gio.h
42  *
43  * GCancellable is a thread-safe operation cancellation stack used 
44  * throughout GIO to allow for cancellation of synchronous and
45  * asynchronous operations.
46  */
47
48 enum {
49   CANCELLED,
50   LAST_SIGNAL
51 };
52
53 struct _GCancellablePrivate
54 {
55   guint cancelled : 1;
56   guint cancelled_running : 1;
57   guint cancelled_running_waiting : 1;
58
59   guint fd_refcount;
60   int cancel_pipe[2];
61
62 #ifdef G_OS_WIN32
63   HANDLE event;
64 #endif
65 };
66
67 static guint signals[LAST_SIGNAL] = { 0 };
68
69 G_DEFINE_TYPE (GCancellable, g_cancellable, G_TYPE_OBJECT);
70
71 static GStaticPrivate current_cancellable = G_STATIC_PRIVATE_INIT;
72 G_LOCK_DEFINE_STATIC(cancellable);
73 static GCond *cancellable_cond = NULL;
74   
75 static void
76 g_cancellable_close_pipe (GCancellable *cancellable)
77 {
78   GCancellablePrivate *priv;
79   
80   priv = cancellable->priv;
81
82   if (priv->cancel_pipe[0] != -1)
83     {
84       close (priv->cancel_pipe[0]);
85       priv->cancel_pipe[0] = -1;
86     }
87   
88   if (priv->cancel_pipe[1] != -1)
89     {
90       close (priv->cancel_pipe[1]);
91       priv->cancel_pipe[1] = -1;
92     }
93
94 #ifdef G_OS_WIN32
95   if (priv->event)
96     {
97       CloseHandle (priv->event);
98       priv->event = NULL;
99     }
100 #endif
101 }
102
103 static void
104 g_cancellable_finalize (GObject *object)
105 {
106   GCancellable *cancellable = G_CANCELLABLE (object);
107
108   g_cancellable_close_pipe (cancellable);
109
110   G_OBJECT_CLASS (g_cancellable_parent_class)->finalize (object);
111 }
112
113 static void
114 g_cancellable_class_init (GCancellableClass *klass)
115 {
116   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
117
118   g_type_class_add_private (klass, sizeof (GCancellablePrivate));
119
120   if (cancellable_cond == NULL && g_thread_supported ())
121     cancellable_cond = g_cond_new ();
122   
123   gobject_class->finalize = g_cancellable_finalize;
124
125   /**
126    * GCancellable::cancelled:
127    * @cancellable: a #GCancellable.
128    * 
129    * Emitted when the operation has been cancelled.
130    * 
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.
135    *
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
141    * returned.
142    * 
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
147    * still happening.
148    *
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
152    * like this.
153    *
154    * An example of how to us this:
155    * |[
156    *     /<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/
157    *     if (g_cancellable_set_error_if_cancelled (cancellable))
158    *       return;
159    *
160    *     /<!-- -->* Set up all the data needed to be able to
161    *      * handle cancellation of the operation *<!-- -->/
162    *     my_data = my_data_new (...);
163    *
164    *     id = 0;
165    *     if (cancellable)
166    *       id = g_cancellable_connect (cancellable,
167    *                                  G_CALLBACK (cancelled_handler)
168    *                                  data, NULL);
169    *
170    *     /<!-- -->* cancellable operation here... *<!-- -->/
171    *
172    *     g_cancellable_disconnect (cancellable, id);
173    *
174    *     /<!-- -->* cancelled_handler is never called after this, it
175    *      * is now safe to free the data *<!-- -->/
176    *     my_data_free (my_data);  
177    * ]|
178    *
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.
182    */
183   signals[CANCELLED] =
184     g_signal_new (I_("cancelled"),
185                   G_TYPE_FROM_CLASS (gobject_class),
186                   G_SIGNAL_RUN_LAST,
187                   G_STRUCT_OFFSET (GCancellableClass, cancelled),
188                   NULL, NULL,
189                   g_cclosure_marshal_VOID__VOID,
190                   G_TYPE_NONE, 0);
191   
192 }
193
194 #ifndef G_OS_WIN32
195 static void
196 set_fd_nonblocking (int fd)
197 {
198 #ifdef F_GETFL
199   glong fcntl_flags;
200   fcntl_flags = fcntl (fd, F_GETFL);
201
202 #ifdef O_NONBLOCK
203   fcntl_flags |= O_NONBLOCK;
204 #else
205   fcntl_flags |= O_NDELAY;
206 #endif
207
208   fcntl (fd, F_SETFL, fcntl_flags);
209 #endif
210 }
211
212 static void
213 set_fd_close_exec (int fd)
214 {
215   int flags;
216
217   flags = fcntl (fd, F_GETFD, 0);
218   if (flags != -1 && (flags & FD_CLOEXEC) == 0)
219     {
220       flags |= FD_CLOEXEC;
221       fcntl (fd, F_SETFD, flags);
222     }
223 }
224
225
226 static void
227 g_cancellable_open_pipe (GCancellable *cancellable)
228 {
229   const char ch = 'x';
230   GCancellablePrivate *priv;
231
232   priv = cancellable->priv;
233   if (pipe (priv->cancel_pipe) == 0)
234     {
235       /* Make them nonblocking, just to be sure we don't block
236        * on errors and stuff
237        */
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]);
242       
243       if (priv->cancelled)
244         write (priv->cancel_pipe[1], &ch, 1);
245     }
246 }
247 #endif
248
249 static void
250 g_cancellable_init (GCancellable *cancellable)
251 {
252   cancellable->priv = G_TYPE_INSTANCE_GET_PRIVATE (cancellable,
253                                                    G_TYPE_CANCELLABLE,
254                                                    GCancellablePrivate);
255   cancellable->priv->cancel_pipe[0] = -1;
256   cancellable->priv->cancel_pipe[1] = -1;
257 }
258
259 /**
260  * g_cancellable_new:
261  * 
262  * Creates a new #GCancellable object.
263  *
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.
267  *
268  * One #GCancellable can be used in multiple consecutive
269  * operations, but not in multiple concurrent operations.
270  *  
271  * Returns: a #GCancellable.
272  **/
273 GCancellable *
274 g_cancellable_new (void)
275 {
276   return g_object_new (G_TYPE_CANCELLABLE, NULL);
277 }
278
279 /**
280  * g_cancellable_push_current:
281  * @cancellable: a #GCancellable object
282  *
283  * Pushes @cancellable onto the cancellable stack. The current
284  * cancllable can then be recieved using g_cancellable_get_current().
285  *
286  * This is useful when implementing cancellable operations in
287  * code that does not allow you to pass down the cancellable object.
288  *
289  * This is typically called automatically by e.g. #GFile operations,
290  * so you rarely have to call this yourself.
291  **/
292 void
293 g_cancellable_push_current (GCancellable *cancellable)
294 {
295   GSList *l;
296
297   g_return_if_fail (cancellable != NULL);
298
299   l = g_static_private_get (&current_cancellable);
300   l = g_slist_prepend (l, cancellable);
301   g_static_private_set (&current_cancellable, l, NULL);
302 }
303
304 /**
305  * g_cancellable_pop_current:
306  * @cancellable: a #GCancellable object
307  *
308  * Pops @cancellable off the cancellable stack (verifying that @cancellable
309  * is on the top of the stack).
310  **/
311 void
312 g_cancellable_pop_current (GCancellable *cancellable)
313 {
314   GSList *l;
315
316   l = g_static_private_get (&current_cancellable);
317
318   g_return_if_fail (l != NULL);
319   g_return_if_fail (l->data == cancellable);
320
321   l = g_slist_delete_link (l, l);
322   g_static_private_set (&current_cancellable, l, NULL);
323 }
324
325 /**
326  * g_cancellable_get_current:
327  *
328  * Gets the top cancellable from the stack.
329  *
330  * Returns: a #GCancellable from the top of the stack, or %NULL
331  * if the stack is empty.
332  **/
333 GCancellable *
334 g_cancellable_get_current  (void)
335 {
336   GSList *l;
337
338   l = g_static_private_get (&current_cancellable);
339   if (l == NULL)
340     return NULL;
341
342   return G_CANCELLABLE (l->data);
343 }
344
345 /**
346  * g_cancellable_reset:
347  * @cancellable: a #GCancellable object.
348  * 
349  * Resets @cancellable to its uncancelled state. 
350  **/
351 void 
352 g_cancellable_reset (GCancellable *cancellable)
353 {
354   GCancellablePrivate *priv;
355
356   g_return_if_fail (G_IS_CANCELLABLE (cancellable));
357
358   G_LOCK(cancellable);
359
360   priv = cancellable->priv;
361   
362   while (priv->cancelled_running)
363     {
364       priv->cancelled_running_waiting = TRUE;
365       g_cond_wait (cancellable_cond,
366                    g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
367     }
368   
369   if (priv->cancelled)
370     {
371       char ch;
372       
373     /* Make sure we're not leaving old cancel state around */
374       
375 #ifdef G_OS_WIN32
376       if (priv->event)
377         ResetEvent (priv->event);
378 #endif
379       if (priv->cancel_pipe[0] != -1)
380         read (priv->cancel_pipe[0], &ch, 1);
381       priv->cancelled = FALSE;
382     }
383   G_UNLOCK(cancellable);
384 }
385
386 /**
387  * g_cancellable_is_cancelled:
388  * @cancellable: a #GCancellable or NULL.
389  * 
390  * Checks if a cancellable job has been cancelled.
391  * 
392  * Returns: %TRUE if @cancellable is cancelled, 
393  * FALSE if called with %NULL or if item is not cancelled. 
394  **/
395 gboolean
396 g_cancellable_is_cancelled (GCancellable *cancellable)
397 {
398   return cancellable != NULL && cancellable->priv->cancelled;
399 }
400
401 /**
402  * g_cancellable_set_error_if_cancelled:
403  * @cancellable: a #GCancellable object.
404  * @error: #GError to append error state to.
405  * 
406  * If the @cancellable is cancelled, sets the error to notify
407  * that the operation was cancelled.
408  * 
409  * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not.
410  **/
411 gboolean
412 g_cancellable_set_error_if_cancelled (GCancellable  *cancellable,
413                                       GError       **error)
414 {
415   if (g_cancellable_is_cancelled (cancellable))
416     {
417       g_set_error_literal (error,
418                            G_IO_ERROR,
419                            G_IO_ERROR_CANCELLED,
420                            _("Operation was cancelled"));
421       return TRUE;
422     }
423   
424   return FALSE;
425 }
426
427 /**
428  * g_cancellable_get_fd:
429  * @cancellable: a #GCancellable.
430  * 
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.
434  *
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().
438  * 
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.
442  *
443  * See also g_cancellable_make_pollfd().
444  *
445  * Returns: A valid file descriptor. %-1 if the file descriptor 
446  * is not supported, or on errors. 
447  **/
448 int
449 g_cancellable_get_fd (GCancellable *cancellable)
450 {
451   GCancellablePrivate *priv;
452   int fd;
453
454   if (cancellable == NULL)
455     return -1;
456
457   priv = cancellable->priv;
458
459 #ifdef G_OS_WIN32
460   return -1;
461 #else
462   G_LOCK(cancellable);
463   if (priv->cancel_pipe[0] == -1)
464     g_cancellable_open_pipe (cancellable);
465   fd = priv->cancel_pipe[0];
466   if (fd != -1)
467     priv->fd_refcount++;
468   G_UNLOCK(cancellable);
469 #endif
470
471   return fd;
472 }
473
474 /**
475  * g_cancellable_make_pollfd:
476  * @cancellable: a #GCancellable or %NULL
477  * @pollfd: a pointer to a #GPollFD
478  * 
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
482  * windows.
483  *
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().
487  *
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.
493  *
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().
497  *
498  * Returns: %TRUE if @pollfd was successfully initialized, %FALSE on 
499  *          failure to prepare the cancellable.
500  * 
501  * Since: 2.22
502  **/
503 gboolean
504 g_cancellable_make_pollfd (GCancellable *cancellable, GPollFD *pollfd)
505 {
506   GCancellablePrivate *priv;
507
508   g_return_val_if_fail (pollfd != NULL, FALSE);
509   if (cancellable == NULL)
510     return FALSE;
511   g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), FALSE);
512
513   priv = cancellable->priv;
514
515 #ifdef G_OS_WIN32
516   G_LOCK(cancellable);
517   if (priv->event == NULL)
518     {
519       /* A manual reset anonymous event, starting unset */
520       priv->event = CreateEvent (NULL, TRUE, FALSE, NULL);
521       if (priv->event == NULL)
522         {
523           G_UNLOCK(cancellable);
524           return FALSE;
525         }
526       if (priv->cancelled)
527         SetEvent(priv->event);
528     }
529   priv->fd_refcount++;
530   G_UNLOCK(cancellable);
531
532   pollfd->fd = (gintptr)priv->event;
533 #else /* !G_OS_WIN32 */
534   {
535     int fd = g_cancellable_get_fd (cancellable);
536     if (fd == -1)
537       return FALSE;
538     pollfd->fd = fd;
539   }
540 #endif /* G_OS_WIN32 */
541   pollfd->events = G_IO_IN;
542   pollfd->revents = 0;
543
544   return TRUE;
545 }
546
547 /**
548  * g_cancellable_release_fd:
549  * @cancellable: a #GCancellable
550  *
551  * Releases a resources previously allocated by g_cancellable_get_fd()
552  * or g_cancellable_make_pollfd().
553  *
554  * For compatibility reasons with older releases, calling this function 
555  * is not strictly required, the resources will be automatically freed
556  * when the @cancellable is finalized. However, the @cancellable will
557  * block scarce file descriptors until it is finalized if this function
558  * is not called. This can cause the application to run out of file 
559  * descriptors when many #GCancellables are used at the same time.
560  * 
561  * Since: 2.22
562  **/
563 void
564 g_cancellable_release_fd (GCancellable *cancellable)
565 {
566   GCancellablePrivate *priv;
567
568   g_return_if_fail (G_IS_CANCELLABLE (cancellable));
569   g_return_if_fail (cancellable->priv->fd_refcount > 0);
570
571   priv = cancellable->priv;
572
573   G_LOCK (cancellable);
574   priv->fd_refcount--;
575   if (priv->fd_refcount == 0)
576     g_cancellable_close_pipe (cancellable);
577   G_UNLOCK (cancellable);
578 }
579
580 /**
581  * g_cancellable_cancel:
582  * @cancellable: a #GCancellable object.
583  * 
584  * Will set @cancellable to cancelled, and will emit the
585  * #GCancellable::cancelled signal. (However, see the warning about
586  * race conditions in the documentation for that signal if you are
587  * planning to connect to it.)
588  *
589  * This function is thread-safe. In other words, you can safely call
590  * it from a thread other than the one running the operation that was
591  * passed the @cancellable.
592  *
593  * The convention within gio is that cancelling an asynchronous
594  * operation causes it to complete asynchronously. That is, if you
595  * cancel the operation from the same thread in which it is running,
596  * then the operation's #GAsyncReadyCallback will not be invoked until
597  * the application returns to the main loop.
598  **/
599 void
600 g_cancellable_cancel (GCancellable *cancellable)
601 {
602   const char ch = 'x';
603   gboolean cancel;
604   GCancellablePrivate *priv;
605
606   if (cancellable == NULL ||
607       cancellable->priv->cancelled)
608     return;
609
610   priv = cancellable->priv;
611   cancel = FALSE;
612
613   G_LOCK(cancellable);
614   cancel = TRUE;
615   priv->cancelled = TRUE;
616   priv->cancelled_running = TRUE;
617 #ifdef G_OS_WIN32
618   if (priv->event)
619     SetEvent (priv->event);
620 #endif
621   if (priv->cancel_pipe[1] != -1)
622     write (priv->cancel_pipe[1], &ch, 1);
623   G_UNLOCK(cancellable);
624
625   if (cancel)
626     {
627       g_object_ref (cancellable);
628       g_signal_emit (cancellable, signals[CANCELLED], 0);
629
630       G_LOCK(cancellable);
631
632       priv->cancelled_running = FALSE;
633       if (priv->cancelled_running_waiting)
634         g_cond_broadcast (cancellable_cond);
635       priv->cancelled_running_waiting = FALSE;
636
637       G_UNLOCK(cancellable);
638
639       g_object_unref (cancellable);
640     }
641 }
642
643 /**
644  * g_cancellable_connect:
645  * @cancellable: A #GCancellable.
646  * @callback: The #GCallback to connect.
647  * @data: Data to pass to @callback.
648  * @data_destroy_func: Free function for @data or %NULL.
649  *
650  * Convenience function to connect to the #GCancellable::cancelled
651  * signal. Also handles the race condition that may happen
652  * if the cancellable is cancelled right before connecting.
653  *
654  * @callback is called at most once, either directly at the
655  * time of the connect if @cancellable is already cancelled,
656  * or when @cancellable is cancelled in some thread.
657  *
658  * @data_destroy_func will be called when the handler is
659  * disconnected, or immediately if the cancellable is already
660  * cancelled.
661  *
662  * See #GCancellable::cancelled for details on how to use this.
663  *
664  * Returns: The id of the signal handler or 0 if @cancellable has already
665  *          been cancelled.
666  *
667  * Since: 2.22
668  */
669 gulong
670 g_cancellable_connect (GCancellable   *cancellable,
671                        GCallback       callback,
672                        gpointer        data,
673                        GDestroyNotify  data_destroy_func)
674 {
675   gulong id;
676
677   g_return_val_if_fail (G_IS_CANCELLABLE (cancellable), 0);
678
679   G_LOCK (cancellable);
680
681   if (cancellable->priv->cancelled)
682     {
683       void (*_callback) (GCancellable *cancellable,
684                          gpointer      user_data);
685
686       _callback = (void *)callback;
687       id = 0;
688
689       _callback (cancellable, data);
690
691       if (data_destroy_func)
692         data_destroy_func (data);
693     }
694   else
695     {
696       id = g_signal_connect_data (cancellable, "cancelled",
697                                   callback, data,
698                                   (GClosureNotify) data_destroy_func,
699                                   0);
700     }
701   G_UNLOCK (cancellable);
702
703   return id;
704 }
705
706 /**
707  * g_cancellable_disconnect:
708  * @cancellable: A #GCancellable or %NULL.
709  * @handler_id: Handler id of the handler to be disconnected, or %0.
710  *
711  * Disconnects a handler from an cancellable instance similar to
712  * g_signal_handler_disconnect() but ensures that once this
713  * function returns the handler will not run anymore in any thread.
714  *
715  * This avoids a race condition where a thread cancels at the
716  * same time as the cancellable operation is finished and the
717  * signal handler is removed. See #GCancellable::cancelled for
718  * details on how to use this.
719  *
720  * If @cancellable is %NULL or @handler_id is %0 this function does
721  * nothing.
722  *
723  * Since: 2.22
724  */
725 void
726 g_cancellable_disconnect (GCancellable  *cancellable,
727                           gulong         handler_id)
728 {
729   GCancellablePrivate *priv;
730
731   if (handler_id == 0 ||  cancellable == NULL)
732     return;
733
734   G_LOCK (cancellable);
735
736   priv = cancellable->priv;
737
738   while (priv->cancelled_running)
739     {
740       priv->cancelled_running_waiting = TRUE;
741       g_cond_wait (cancellable_cond,
742                    g_static_mutex_get_mutex (& G_LOCK_NAME (cancellable)));
743     }
744
745   g_signal_handler_disconnect (cancellable, handler_id);
746   G_UNLOCK (cancellable);
747 }
748
749 #define __G_CANCELLABLE_C__
750 #include "gioaliasdef.c"