libmicrohttpd2

HTTP server C library (MHD 2.x, alpha)
Log | Files | Refs | README | LICENSE

mhd_dbg_print.h (4276B)


      1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */
      2 /*
      3   This file is part of GNU libmicrohttpd.
      4   Copyright (C) 2025-2026 Evgeny Grin (Karlson2k)
      5 
      6   GNU libmicrohttpd is free software; you can redistribute it and/or
      7   modify it under the terms of the GNU Lesser General Public
      8   License as published by the Free Software Foundation; either
      9   version 2.1 of the License, or (at your option) any later version.
     10 
     11   GNU libmicrohttpd is distributed in the hope that it will be useful,
     12   but WITHOUT ANY WARRANTY; without even the implied warranty of
     13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     14   Lesser General Public License for more details.
     15 
     16   Alternatively, you can redistribute GNU libmicrohttpd and/or
     17   modify it under the terms of the GNU General Public License as
     18   published by the Free Software Foundation; either version 2 of
     19   the License, or (at your option) any later version, together
     20   with the eCos exception, as follows:
     21 
     22     As a special exception, if other files instantiate templates or
     23     use macros or inline functions from this file, or you compile this
     24     file and link it with other works to produce a work based on this
     25     file, this file does not by itself cause the resulting work to be
     26     covered by the GNU General Public License. However the source code
     27     for this file must still be made available in accordance with
     28     section (3) of the GNU General Public License v2.
     29 
     30     This exception does not invalidate any other reasons why a work
     31     based on this file might be covered by the GNU General Public
     32     License.
     33 
     34   You should have received copies of the GNU Lesser General Public
     35   License and the GNU General Public License along with this library;
     36   if not, see <https://www.gnu.org/licenses/>.
     37 */
     38 
     39 /**
     40  * @file src/mhd2/mhd_dbg_print.h
     41  * @brief  The declarations of internal debug-print/trace helpers
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_DBG_PRINT_H
     46 #define MHD_DBG_PRINT_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #ifdef MHD_USE_TRACE_POLLING_FDS
     51 #  include "sys_bool_type.h"
     52 #  include "mhd_socket_type.h"
     53 #  include "sys_kqueue.h"
     54 #endif /* MHD_USE_TRACE_POLLING_FDS */
     55 
     56 
     57 #ifdef MHD_USE_TRACE_POLLING_FDS
     58 /**
     59  * Debug-printf request of FD polling/monitoring
     60  * @param fd_name the name of FD ("ITC", "lstn" or "conn")
     61  * @param fd the FD value
     62  * @param r_ready the request for read (or receive) readiness
     63  * @param w_ready the request for write (or send) readiness
     64  * @param e_ready the request for exception (or error) readiness
     65  * @note Implemented in src/mhd2/events_process.c
     66  */
     67 MHD_INTERNAL void
     68 mhd_dbg_print_fd_mon_req (const char *fd_name,
     69                           MHD_Socket fd,
     70                           bool r_ready,
     71                           bool w_ready,
     72                           bool e_ready)
     73 MHD_FN_PAR_NONNULL_ALL_;
     74 
     75 #  ifdef MHD_SUPPORT_KQUEUE
     76 /**
     77  * Debug print kqueue event request update or event report
     78  * @param fd_name the name of FD ("ITC", "lstn" or "conn")
     79  * @param ke the pointer to kevent
     80  * @param update_req set to 'true' if @a ke is in the change list,
     81  *                   set to 'false' if @a ke is in the reported events list
     82  */
     83 MHD_INTERNAL void
     84 mhd_dbg_print_kevent (const char *fd_name,
     85                       const struct kevent *ke,
     86                       bool update_req)
     87 MHD_FN_PAR_NONNULL_ALL_;
     88 
     89 #  endif /* MHD_SUPPORT_KQUEUE */
     90 
     91 #else  /* ! MHD_USE_TRACE_POLLING_FDS */
     92 #  define mhd_dbg_print_fd_mon_req(fd_n,fd,r_ready,w_ready,e_ready) ((void) 0)
     93 #  ifdef MHD_SUPPORT_KQUEUE
     94 #    define mhd_dbg_print_kevent(fd_name,ke,update_req)     ((void) 0)
     95 #  endif /* MHD_SUPPORT_KQUEUE */
     96 #endif /* ! MHD_USE_TRACE_POLLING_FDS */
     97 
     98 #ifdef MHD_SUPPORT_KQUEUE
     99 /**
    100  * Debug print kqueue event request update
    101  * @param fd_name the name of FD ("ITC", "lstn" or "conn")
    102  * @param ke the pointer to kevent
    103  */
    104 #  define mhd_dbg_print_kevent_change(fd_name,ke) \
    105         mhd_dbg_print_kevent ((fd_name),(ke),true)
    106 
    107 /**
    108  * Debug print kqueue event report
    109  * @param fd_name the name of FD ("ITC", "lstn" or "conn")
    110  * @param ke the pointer to kevent
    111  */
    112 #  define mhd_dbg_print_kevent_report(fd_name,ke) \
    113         mhd_dbg_print_kevent ((fd_name),(ke),false)
    114 #endif /* MHD_SUPPORT_KQUEUE */
    115 
    116 #endif /* ! MHD_DBG_PRINT_H */