fix some doxygen warnings

[paraslash.git] / fd.c

diff --git a/fd.c b/fd.c
index 81ba5cffb7e6919ec7eca5d4fdfd9d0aecc92f61..dd07466cef2623e5aaa053178d7eda9e992e3dcd 100644 (file)
--- a/fd.c
+++ b/fd.c
@@ -19,6 +19,10 @@
 /** \file fd.c helper functions for file descriptor handling */
 
 #include "para.h"
+
+#include <fcntl.h>
+#include <sys/select.h>
+
 #include "error.h"
 /**
  * check whether a file exists
@@ -43,8 +47,8 @@ int file_exists(const char *fn)
  * \param n the highest-numbered descriptor in any of the two sets, plus 1
  * \param readfds fds that should be checked for readability
  * \param writefds fds that should be checked for writablility
- * \param timeout upper bound on the amount of time elapsed before select()
- *  returns
+ * \param timeout_tv upper bound on the amount of time elapsed before select()
+ * returns
  *
  * \return The return value of the underlying select() call.
  *
@@ -52,15 +56,16 @@ int file_exists(const char *fn)
  * \sa select(2) select_tut(2)
  */
 int para_select(int n, fd_set *readfds, fd_set *writefds,
-               struct timeval *timeout)
+               struct timeval *timeout_tv)
 {
        int ret, err;
        do {
-               ret = select(n, readfds, writefds, NULL, timeout);
+               ret = select(n, readfds, writefds, NULL, timeout_tv);
                err = errno;
        } while (ret < 0 && err == EINTR);
        if (ret < 0)
-               PARA_CRIT_LOG("select error (%s)\n", strerror(err));
+               PARA_CRIT_LOG("select error: %s, max_fileno: %d\n",
+                       strerror(err), n);
        return ret;
 }
 
@@ -81,3 +86,57 @@ int mark_fd_nonblock(int fd)
        return 1;
 }
 
+/**
+ * set a file descriptor in a fd_set
+ *
+ * \param fd the file descriptor to be set
+ * \param fds the file descriptor set
+ * \param max_fileno highest-numbered file descriptor
+ *
+ * This wrapper for FD_SET() passes its first two arguments to \p FD_SET. Upon
+ * return, \a max_fileno contains the maximum of the old_value and \a fd.
+ *
+ * \sa para_select
+*/
+void para_fd_set(int fd, fd_set *fds, int *max_fileno)
+{
+
+       if (fd < 0 || fd >= FD_SETSIZE) {
+               PARA_EMERG_LOG("fatal: tried to add invalid fd %d\n", fd);
+               exit(EXIT_FAILURE);
+       }
+#if 0
+       {
+               int flags = fcntl(fd, F_GETFL);
+               if (!(flags & O_NONBLOCK)) {
+                       PARA_EMERG_LOG("fd %d is a blocking file descriptor\n", fd);
+                       exit(EXIT_FAILURE);
+               }
+       }
+#endif
+       FD_SET(fd, fds);
+       *max_fileno = PARA_MAX(*max_fileno, fd);
+}
+
+/**
+ * paraslash's wrapper for fread(3)
+ *
+ * \param dest destination pointer
+ * \param nbytes size of one element
+ * \param nmemb number of elements to write
+ * \param stream the input stream
+ *
+ * \return negative on errors, zero on end of file, and the number of bytes
+ * (not elements) read on success.
+ *
+ * \sa fread(3)
+ */
+__must_check int para_fread(void *dest, size_t nbytes, size_t nmemb, FILE *stream)
+{
+       size_t res = fread(dest, nbytes, nmemb, stream);
+       if (res == nmemb)
+               return nbytes * nmemb;
+       if (feof(stream))
+               return 0;
+       return -E_FREAD;
+}