mhd_itc.h

Go to the documentation of this file.

/*
  This file is part of libmicrohttpd
  Copyright (C) 2016-2023 Karlson2k (Evgeny Grin)

  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.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

*/

#ifndef MHD_ITC_H
#define MHD_ITC_H 1
#include "mhd_itc_types.h"

#include <fcntl.h>

#ifndef MHD_PANIC
#  include <stdio.h>
#  ifdef HAVE_STDLIB_H
#    include <stdlib.h>
#  endif /* HAVE_STDLIB_H */
/* Simple implementation of MHD_PANIC, to be used outside lib */
#  define MHD_PANIC(msg)                                             \
  do { fprintf (stderr,                                              \
                "Abnormal termination at %d line in file %s: %s\n",  \
                (int) __LINE__, __FILE__, msg); abort ();            \
     } while (0)
#endif /* ! MHD_PANIC */

#if defined(_MHD_ITC_EVENTFD)

/* **************** Optimized GNU/Linux ITC implementation by eventfd ********** */
#include <sys/eventfd.h>
#include <stdint.h>      /* for uint64_t */
#ifdef HAVE_UNISTD_H
#include <unistd.h>      /* for read(), write() */
#endif /* HAVE_UNISTD_H */
#ifdef HAVE_STRING_H
#include <string.h> /* for strerror() */
#include <errno.h>
#endif

#define MHD_ITC_NUM_FDS_ (1)

#define MHD_itc_init_(itc) \
  (-1 != ((itc).fd = eventfd (0, EFD_CLOEXEC | EFD_NONBLOCK)))

#define MHD_itc_last_strerror_() strerror (errno)

static const uint64_t _MHD_itc_wr_data = 1;

#define MHD_itc_activate_(itc, str)                    \
  ((write ((itc).fd, (const void*) &_MHD_itc_wr_data,  \
           sizeof(_MHD_itc_wr_data)) > 0) || (EAGAIN == errno))

#define MHD_itc_r_fd_(itc) ((itc).fd)

#define MHD_itc_w_fd_(itc) ((itc).fd)

#define MHD_itc_clear_(itc)                               \
  do { uint64_t __b;                                      \
       (void) read ((itc).fd, (void*)&__b, sizeof(__b));  \
     } while (0)

#define MHD_itc_destroy_(itc) \
  ((0 == close ((itc).fd)) || (EBADF != errno))

#define MHD_ITC_IS_VALID_(itc)  (-1 != ((itc).fd))

#define MHD_itc_set_invalid_(itc) ((itc).fd = -1)


#elif defined(_MHD_ITC_PIPE)

/* **************** Standard UNIX ITC implementation by pipe ********** */

#if defined(HAVE_PIPE2_FUNC) && defined(HAVE_FCNTL_H)
#  include <fcntl.h>     /* for O_CLOEXEC, O_NONBLOCK */
#endif /* HAVE_PIPE2_FUNC && HAVE_FCNTL_H */
#ifdef HAVE_UNISTD_H
#include <unistd.h>      /* for read(), write(), errno */
#endif /* HAVE_UNISTD_H */
#ifdef HAVE_STRING_H
#include <string.h> /* for strerror() */
#endif


#define MHD_ITC_NUM_FDS_ (2)

#ifdef HAVE_PIPE2_FUNC
#  define MHD_itc_init_(itc) (! pipe2 ((itc).fd, O_CLOEXEC | O_NONBLOCK))
#else  /* ! HAVE_PIPE2_FUNC */
#  define MHD_itc_init_(itc)          \
  ( (! pipe ((itc).fd)) ?             \
    (MHD_itc_nonblocking_ ((itc)) ?   \
     (! 0) :                          \
     (MHD_itc_destroy_ ((itc)), 0) )  \
    : (0) )
#endif /* ! HAVE_PIPE2_FUNC */

#define MHD_itc_last_strerror_() strerror (errno)

#define MHD_itc_activate_(itc, str) \
  ((write ((itc).fd[1], (const void*) (str), 1) > 0) || (EAGAIN == errno))


#define MHD_itc_r_fd_(itc) ((itc).fd[0])

#define MHD_itc_w_fd_(itc) ((itc).fd[1])

#define MHD_itc_clear_(itc) do                                 \
  { long __b;                                                  \
    while (0 < read ((itc).fd[0], (void*) &__b, sizeof(__b)))  \
    {(void)0;} } while (0)

#define MHD_itc_destroy_(itc)     \
  ( (0 == close ((itc).fd[0])) ?  \
    (0 == close ((itc).fd[1])) :  \
    ((close ((itc).fd[1])), 0) )

#define MHD_ITC_IS_VALID_(itc)  (-1 != (itc).fd[0])

#define MHD_itc_set_invalid_(itc) ((itc).fd[0] = (itc).fd[1] = -1)

#ifndef HAVE_PIPE2_FUNC

int
MHD_itc_nonblocking_ (struct MHD_itc_ itc);

#endif /* ! HAVE_PIPE2_FUNC */


#elif defined(_MHD_ITC_SOCKETPAIR)

/* **************** ITC implementation by socket pair ********** */

#include "mhd_sockets.h"


#define MHD_ITC_NUM_FDS_ (2)

#ifdef MHD_socket_pair_nblk_
#  define MHD_itc_init_(itc) MHD_socket_pair_nblk_ ((itc).sk)
#else  /* ! MHD_socket_pair_nblk_ */
#  define MHD_itc_init_(itc)         \
  (MHD_socket_pair_ ((itc).sk) ?     \
   (MHD_itc_nonblocking_ ((itc)) ?   \
    (! 0) :                          \
    (MHD_itc_destroy_ ((itc)), 0) )  \
   : (0))
#endif /* ! MHD_socket_pair_nblk_ */

#define MHD_itc_last_strerror_() MHD_socket_last_strerr_ ()

#define MHD_itc_activate_(itc, str)            \
  ((MHD_send_ ((itc).sk[1], (str), 1) > 0) ||  \
   (MHD_SCKT_ERR_IS_EAGAIN_ (MHD_socket_get_error_ ())))

#define MHD_itc_r_fd_(itc) ((itc).sk[0])

#define MHD_itc_w_fd_(itc) ((itc).sk[1])

#define MHD_itc_clear_(itc) do                                    \
  { long __b;                                                     \
    while (0 < recv ((itc).sk[0], (void*) &__b, sizeof(__b), 0))  \
    {(void)0;} } while (0)

#define MHD_itc_destroy_(itc)         \
  (MHD_socket_close_ ((itc).sk[0]) ?  \
   MHD_socket_close_ ((itc).sk[1]) :  \
   ((void) MHD_socket_close_ ((itc).sk[1]), 0) )


#define MHD_ITC_IS_VALID_(itc)  (MHD_INVALID_SOCKET != (itc).sk[0])

#define MHD_itc_set_invalid_(itc) \
  ((itc).sk[0] = (itc).sk[1] = MHD_INVALID_SOCKET)

#ifndef MHD_socket_pair_nblk_
#  define MHD_itc_nonblocking_(pip)          \
  (MHD_socket_nonblocking_ ((pip).sk[0]) &&  \
   MHD_socket_nonblocking_ ((pip).sk[1]))
#endif /* ! MHD_socket_pair_nblk_ */

#endif /* _MHD_ITC_SOCKETPAIR */

#define MHD_itc_destroy_chk_(itc) do {             \
    if (! MHD_itc_destroy_ (itc))                  \
      MHD_PANIC (_ ("Failed to destroy ITC.\n"));  \
} while (0)

#define MHD_ITC_IS_INVALID_(itc)  (! MHD_ITC_IS_VALID_ (itc))

#endif /* MHD_ITC_H */