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