-/*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
+
+/** \file close_on_fork.c Manage a list of fds that should be closed on fork. */
+
+#include <regex.h>
-/** \file close_on_fork.c manage a list of fds that should be closed on fork */
#include "para.h"
#include "list.h"
#include "string.h"
+#include "close_on_fork.h"
static struct list_head close_on_fork_list;
static int initialized;
/**
- * describes an element of the close-on-fork list
+ * Describes an element of the close-on-fork list.
*
- * \sa list.h
+ * \sa \ref list.h.
*/
struct close_on_fork {
- /** the file descriptor which should be closed after fork() */
+ /** The file descriptor which should be closed after fork(). */
int fd;
- /** the position in the close-on-fork list */
+ /** The position in the close-on-fork list. */
struct list_head node;
};
/**
- * add one file descriptor to the close-on-fork list
+ * Add one file descriptor to the close-on-fork list.
*
- * \param fd the file descriptor to add
+ * \param fd The file descriptor to add.
*/
void add_close_on_fork_list(int fd)
{
para_list_add(&cof->node, &close_on_fork_list);
}
-
/**
- * delete one file descriptor from the close-on-fork list
+ * Delete one file descriptor from the close-on-fork list.
*
- * \param fd the file descriptor to delete
+ * \param fd The file descriptor to delete.
*
* Noop if \a fd does not belong to the close-on-fork list.
*/
}
}
-/**
- * call close(3) for each fd in the close-on-fork list
- */
-void close_listed_fds(void)
+static void deplete_cof_list(bool close_fds)
{
- struct close_on_fork *cof;
+ struct close_on_fork *cof, *tmp;
if (!initialized)
return;
- list_for_each_entry(cof, &close_on_fork_list, node) {
+ list_for_each_entry_safe(cof, tmp, &close_on_fork_list, node) {
PARA_DEBUG_LOG("closing fd %d\n", cof->fd);
- close(cof->fd);
+ if (close_fds)
+ close(cof->fd);
+ list_del(&cof->node);
+ free(cof);
}
}
+
+/**
+ * Close all fds in the list and destroy all list entries.
+ *
+ * This function calls close(3) for each fd in the close-on-fork list
+ * and empties the list afterwards.
+ *
+ * \sa \ref deplete_close_on_fork_list().
+ */
+void close_listed_fds(void)
+{
+ deplete_cof_list(true);
+}
+
+/**
+ * Remove all listed fds from the close on fork list.
+ *
+ * This is like \ref close_listed_fds() but does not close the fds.
+ */
+void deplete_close_on_fork_list(void)
+{
+ deplete_cof_list(false);
+}