gio/gunixfdlist.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2009 Codethink Limited
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License as published
   7  * by the Free Software Foundation; either version 2 of the licence or (at
   8  * your option) any later version.
   9  *
  10  * See the included COPYING file for more information.
  11  *
  12  * Authors: Ryan Lortie <desrt@desrt.ca>
  13  */
  14
  15 /**
  16  * SECTION: gunixfdlist
  17  * @title: GUnixFDList
  18  * @short_description: An object containing a set of file descriptors
  19  * @see_also: #GUnixFDMessage
  20  *
  21  * A #GUnixFDList contains a list of file descriptors.  It owns the file
  22  * descriptors that it contains, closing them when finalized.
  23  *
  24  * It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in
  25  * the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message()
  26  * and received using g_socket_receive_message().
  27  */
  28
  29 #define _GNU_SOURCE /* for F_DUPFD_CLOEXEC */
  30
  31 #include "config.h"
  32
  33 #include <sys/types.h>
  34 #include <sys/socket.h>
  35 #include <unistd.h>
  36 #include <fcntl.h>
  37 #include <string.h>
  38 #include <errno.h>
  39
  40 #include "gunixfdlist.h"
  41 #include "gioerror.h"
  42
  43 #include "gioalias.h"
  44
  45
  46 G_DEFINE_TYPE (GUnixFDList, g_unix_fd_list, G_TYPE_OBJECT)
  47
  48 struct _GUnixFDListPrivate
  49 {
  50   gint *fds;
  51   gint nfd;
  52 };
  53
  54 static void
  55 g_unix_fd_list_init (GUnixFDList *list)
  56 {
  57   list->priv = G_TYPE_INSTANCE_GET_PRIVATE (list,
  58                                                G_TYPE_UNIX_FD_LIST,
  59                                                GUnixFDListPrivate);
  60 }
  61
  62 static void
  63 g_unix_fd_list_finalize (GObject *object)
  64 {
  65   GUnixFDList *list = G_UNIX_FD_LIST (object);
  66   gint i;
  67
  68   for (i = 0; i < list->priv->nfd; i++)
  69     close (list->priv->fds[i]);
  70   g_free (list->priv->fds);
  71
  72   G_OBJECT_CLASS (g_unix_fd_list_parent_class)
  73     ->finalize (object);
  74 }
  75
  76 static void
  77 g_unix_fd_list_class_init (GUnixFDListClass *class)
  78 {
  79   GObjectClass *object_class = G_OBJECT_CLASS (class);
  80
  81   g_type_class_add_private (class, sizeof (GUnixFDListPrivate));
  82   object_class->finalize = g_unix_fd_list_finalize;
  83 }
  84
  85 static int
  86 dup_close_on_exec_fd (gint     fd,
  87                       GError **error)
  88 {
  89   gint new_fd;
  90   gint s;
  91
  92 #ifdef F_DUPFD_CLOEXEC
  93   do
  94     new_fd = fcntl (fd, F_DUPFD_CLOEXEC, 0l);
  95   while (new_fd < 0 && (errno == EINTR));
  96
  97   if (new_fd >= 0)
  98     return new_fd;
  99
 100   /* if that didn't work (new libc/old kernel?), try it the other way. */
 101 #endif
 102
 103   do
 104     new_fd = dup (fd);
 105   while (new_fd < 0 && (errno == EINTR));
 106
 107   if (new_fd < 0)
 108     {
 109       int saved_errno = errno;
 110
 111       g_set_error (error, G_IO_ERROR,
 112                    g_io_error_from_errno (saved_errno),
 113                    "dup: %s", g_strerror (saved_errno));
 114       close (new_fd);
 115
 116       return -1;
 117     }
 118
 119   do
 120     s = fcntl (new_fd, F_SETFD, FD_CLOEXEC);
 121   while (s < 0 && (errno == EINTR));
 122
 123   if (new_fd < 0)
 124     {
 125       int saved_errno = errno;
 126
 127       g_set_error (error, G_IO_ERROR,
 128                    g_io_error_from_errno (saved_errno),
 129                    "fcntl: %s", g_strerror (saved_errno));
 130       close (new_fd);
 131
 132       return -1;
 133     }
 134
 135   return new_fd;
 136 }
 137
 138 /**
 139  * g_unix_fd_list_new:
 140  *
 141  * Creates a new #GUnixFDList containing no file descriptors.
 142  *
 143  * Returns: a new #GUnixFDList
 144  *
 145  * Since: 2.24
 146  **/
 147 GUnixFDList *
 148 g_unix_fd_list_new (void)
 149 {
 150   return g_object_new (G_TYPE_UNIX_FD_LIST, NULL);
 151 }
 152
 153 /**
 154  * g_unix_fd_list_new_from_array:
 155  * @fds: the initial list of file descriptors
 156  * @n_fds: the length of #fds, or -1
 157  *
 158  * Creates a new #GUnixFDList containing the file descriptors given in
 159  * @fds.  The file descriptors become the property of the new list and
 160  * may no longer be used by the caller.  The array itself is owned by
 161  * the caller.
 162  *
 163  * Each file descriptor in the array should be set to close-on-exec.
 164  *
 165  * If @n_fds is -1 then @fds must be terminated with -1.
 166  *
 167  * Returns: a new #GUnixFDList
 168  *
 169  * Since: 2.24
 170  **/
 171 GUnixFDList *
 172 g_unix_fd_list_new_from_array (const gint *fds,
 173                                gint        n_fds)
 174 {
 175   GUnixFDList *list;
 176
 177   g_return_val_if_fail (fds != NULL || n_fds == 0, NULL);
 178
 179   if (n_fds == -1)
 180     for (n_fds = 0; fds[n_fds] != -1; n_fds++);
 181
 182   list = g_object_new (G_TYPE_UNIX_FD_LIST, NULL);
 183   list->priv->fds = g_new (gint, n_fds + 1);
 184   list->priv->nfd = n_fds;
 185
 186   memcpy (list->priv->fds, fds, sizeof (gint) * n_fds);
 187   list->priv->fds[n_fds] = -1;
 188
 189   return list;
 190 }
 191
 192 /**
 193  * g_unix_fd_list_steal_fds:
 194  * @list: a #GUnixFDList
 195  * @length: pointer to the length of the returned array, or %NULL
 196  *
 197  * Returns the array of file descriptors that is contained in this
 198  * object.
 199  *
 200  * After this call, the descriptors are no longer contained in
 201  * @list. Further calls will return an empty list (unless more
 202  * descriptors have been added).
 203  *
 204  * The return result of this function must be freed with g_free().
 205  * The caller is also responsible for closing all of the file
 206  * descriptors.  The file descriptors in the array are set to
 207  * close-on-exec.
 208  *
 209  * If @length is non-%NULL then it is set to the number of file
 210  * descriptors in the returned array. The returned array is also
 211  * terminated with -1.
 212  *
 213  * This function never returns %NULL. In case there are no file
 214  * descriptors contained in @list, an empty array is returned.
 215  *
 216  * Returns: an array of file descriptors
 217  *
 218  * Since: 2.24
 219  */
 220 gint *
 221 g_unix_fd_list_steal_fds (GUnixFDList *list,
 222                           gint        *length)
 223 {
 224   gint *result;
 225
 226   g_return_val_if_fail (G_IS_UNIX_FD_LIST (list), NULL);
 227
 228   /* will be true for fresh object or if we were just called */
 229   if (list->priv->fds == NULL)
 230     {
 231       list->priv->fds = g_new (gint, 1);
 232       list->priv->fds[0] = -1;
 233       list->priv->nfd = 0;
 234     }
 235
 236   if (length)
 237     *length = list->priv->nfd;
 238   result = list->priv->fds;
 239
 240   list->priv->fds = NULL;
 241   list->priv->nfd = 0;
 242
 243   return result;
 244 }
 245
 246 /**
 247  * g_unix_fd_list_peek_fds:
 248  * @list: a #GUnixFDList
 249  * @length: pointer to the length of the returned array, or %NULL
 250  *
 251  * Returns the array of file descriptors that is contained in this
 252  * object.
 253  *
 254  * After this call, the descriptors remain the property of @list.  The
 255  * caller must not close them and must not free the array.  The array is
 256  * valid only until @list is changed in any way.
 257  *
 258  * If @length is non-%NULL then it is set to the number of file
 259  * descriptors in the returned array. The returned array is also
 260  * terminated with -1.
 261  *
 262  * This function never returns %NULL. In case there are no file
 263  * descriptors contained in @list, an empty array is returned.
 264  *
 265  * Returns: an array of file descriptors
 266  *
 267  * Since: 2.24
 268  */
 269 const gint *
 270 g_unix_fd_list_peek_fds (GUnixFDList *list,
 271                          gint        *length)
 272 {
 273   g_return_val_if_fail (G_IS_UNIX_FD_LIST (list), NULL);
 274
 275   /* will be true for fresh object or if steal() was just called */
 276   if (list->priv->fds == NULL)
 277     {
 278       list->priv->fds = g_new (gint, 1);
 279       list->priv->fds[0] = -1;
 280       list->priv->nfd = 0;
 281     }
 282
 283   if (length)
 284     *length = list->priv->nfd;
 285
 286   return list->priv->fds;
 287 }
 288
 289 /**
 290  * g_unix_fd_list_append:
 291  * @list: a #GUnixFDList
 292  * @fd: a valid open file descriptor
 293  * @error: a #GError pointer
 294  *
 295  * Adds a file descriptor to @list.
 296  *
 297  * The file descriptor is duplicated using dup(). You keep your copy
 298  * of the descriptor and the copy contained in @list will be closed
 299  * when @list is finalized.
 300  *
 301  * A possible cause of failure is exceeding the per-process or
 302  * system-wide file descriptor limit.
 303  *
 304  * The index of the file descriptor in the list is returned.  If you use
 305  * this index with g_unix_fd_list_get() then you will receive back a
 306  * duplicated copy of the same file descriptor.
 307  *
 308  * Returns: the index of the appended fd in case of success, else -1
 309  *          (and @error is set)
 310  *
 311  * Since: 2.24
 312  */
 313 gint
 314 g_unix_fd_list_append (GUnixFDList  *list,
 315                        gint          fd,
 316                        GError      **error)
 317 {
 318   gint new_fd;
 319
 320   g_return_val_if_fail (G_IS_UNIX_FD_LIST (list), -1);
 321   g_return_val_if_fail (fd >= 0, -1);
 322   g_return_val_if_fail (error == NULL || *error == NULL, -1);
 323
 324   if ((new_fd = dup_close_on_exec_fd (fd, error)) < 0)
 325     return -1;
 326
 327   list->priv->fds = g_realloc (list->priv->fds,
 328                                   sizeof (gint) *
 329                                    (list->priv->nfd + 2));
 330   list->priv->fds[list->priv->nfd++] = new_fd;
 331   list->priv->fds[list->priv->nfd] = -1;
 332
 333   return list->priv->nfd - 1;
 334 }
 335
 336 /**
 337  * g_unix_fd_list_get:
 338  * @list: a #GUnixFDList
 339  * @index_: the index into the list
 340  * @error: a #GError pointer
 341  *
 342  * Gets a file descriptor out of @list.
 343  *
 344  * @index_ specifies the index of the file descriptor to get.  It is a
 345  * programmer error for @index_ to be out of range; see
 346  * g_unix_fd_list_get_length().
 347  *
 348  * The file descriptor is duplicated using dup() and set as
 349  * close-on-exec before being returned.  You must call close() on it
 350  * when you are done.
 351  *
 352  * A possible cause of failure is exceeding the per-process or
 353  * system-wide file descriptor limit.
 354  *
 355  * Returns: the file descriptor, or -1 in case of error
 356  *
 357  * Since: 2.24
 358  **/
 359 gint
 360 g_unix_fd_list_get (GUnixFDList  *list,
 361                     gint          index_,
 362                     GError      **error)
 363 {
 364   g_return_val_if_fail (G_IS_UNIX_FD_LIST (list), -1);
 365   g_return_val_if_fail (index_ < list->priv->nfd, -1);
 366   g_return_val_if_fail (error == NULL || *error == NULL, -1);
 367
 368   return dup_close_on_exec_fd (list->priv->fds[index_], error);
 369 }
 370
 371 /**
 372  * g_unix_fd_list_get_length:
 373  * @list: a #GUnixFDList
 374  *
 375  * Gets the length of @list (ie: the number of file descriptors
 376  * contained within).
 377  *
 378  * Returns: the length of @list
 379  *
 380  * Since: 2.24
 381  **/
 382 gint
 383 g_unix_fd_list_get_length (GUnixFDList *list)
 384 {
 385   g_return_val_if_fail (G_IS_UNIX_FD_LIST (list), 0);
 386
 387   return list->priv->nfd;
 388 }
 389
 390 #define __G_UNIX_FD_LIST_C__
 391 #include "gioaliasdef.c"