Files
nginx-unit/src/nxt_fd_event.h
Alejandro Colomar 952bcc50bf Fixed #define style.
We had a mix of styles for declaring function-like macros:

Style A:
 #define                    \
 foo()                      \
     do {                   \
         ...                \
     } while (0)

Style B:
 #define foo()              \
     do {                   \
         ...                \
     } while (0)

We had a similar number of occurences of each style:

 $ grep -rnI '^\w*(.*\\' | wc -l
 244
 $ grep -rn 'define.*(.*)' | wc -l
 239

(Those regexes aren't perfect, but a very decent approximation.)

Real examples:

 $ find src -type f | xargs sed -n '/^nxt_double_is_zero/,/^$/p'
 nxt_double_is_zero(f)                                                         \
     (fabs(f) <= FLT_EPSILON)

 $ find src -type f | xargs sed -n '/define nxt_http_field_set/,/^$/p'
 #define nxt_http_field_set(_field, _name, _value)                             \
     do {                                                                      \
         (_field)->name_length = nxt_length(_name);                            \
         (_field)->value_length = nxt_length(_value);                          \
         (_field)->name = (u_char *) _name;                                    \
         (_field)->value = (u_char *) _value;                                  \
     } while (0)

I'd like to standardize on a single style for them, and IMO,
having the identifier in the same line as #define is a better
option for the following reasons:

- Programmers are used to `#define foo() ...` (readability).
- One less line of code.
- The program for finding them is really simple (see below).

 function grep_ngx_func()
 {
     if (($# != 1)); then
         >&2 echo "Usage: ${FUNCNAME[0]} <func>";
         return 1;
     fi;

     find src -type f \
     | grep '\.[ch]$' \
     | xargs grep -l "$1" \
     | sort \
     | xargs pcregrep -Mn "(?s)^\$[\w\s*]+?^$1\(.*?^}";

     find src -type f \
     | grep '\.[ch]$' \
     | xargs grep -l "$1" \
     | sort \
     | xargs pcregrep -Mn "(?s)define $1\(.*?^$" \
     | sed -E '1s/^[^:]+:[0-9]+:/&\n\n/';
 }

 $ grep_ngx_func
 Usage: grep_ngx_func <func>

 $ grep_ngx_func nxt_http_field_set
 src/nxt_http.h:98:

 #define nxt_http_field_set(_field, _name, _value)                             \
     do {                                                                      \
         (_field)->name_length = nxt_length(_name);                            \
         (_field)->value_length = nxt_length(_value);                          \
         (_field)->name = (u_char *) _name;                                    \
         (_field)->value = (u_char *) _value;                                  \
     } while (0)

 $ grep_ngx_func nxt_sprintf
 src/nxt_sprintf.c:56:

 u_char * nxt_cdecl
 nxt_sprintf(u_char *buf, u_char *end, const char *fmt, ...)
 {
     u_char   *p;
     va_list  args;

     va_start(args, fmt);
     p = nxt_vsprintf(buf, end, fmt, args);
     va_end(args);

     return p;
 }

................
Scripted change:
................

$ find src -type f \
  | grep '\.[ch]$' \
  | xargs sed -i '/define *\\$/{N;s/ *\\\n/ /;s/        //}'
2022-05-03 12:11:14 +02:00

119 lines
3.1 KiB
C

/*
* Copyright (C) Igor Sysoev
* Copyright (C) NGINX, Inc.
*/
#ifndef _NXT_FD_EVENT_H_INCLUDED_
#define _NXT_FD_EVENT_H_INCLUDED_
typedef enum {
/* A completely inactive event. */
NXT_EVENT_INACTIVE = 0,
/*
* An event presents in the kernel but disabled after oneshot.
* Used by epoll.
*/
NXT_EVENT_DISABLED,
/*
* An event is active in the kernel but blocked by application.
* Used by kqueue, epoll, eventport, devpoll, and pollset.
*/
NXT_EVENT_BLOCKED,
/*
* An active oneshot event.
* Used by epoll, devpoll, pollset, poll, and select.
*/
NXT_EVENT_ONESHOT,
/* An active level-triggered event. Used by eventport. */
NXT_EVENT_LEVEL,
/*
* An active default event. The event type depends on interface:
* edge-triggered for kqueue, and modern epoll;
* level-triggered for old epoll, devpoll, pollset, poll, and select;
* oneshot for kqueue and eventport.
*/
NXT_EVENT_DEFAULT,
NXT_EVENT_ACTIVE = NXT_EVENT_DEFAULT,
} nxt_fd_event_state_t;
#define nxt_fd_event_is_disabled(state) \
((state) < NXT_EVENT_ONESHOT)
#define nxt_fd_event_is_active(state) \
((state) >= NXT_EVENT_ONESHOT)
struct nxt_fd_event_s {
void *data;
/* Both are int's. */
nxt_socket_t fd;
nxt_err_t error;
/* The flags should also be prefetched by nxt_work_queue_pop(). */
#if (NXT_64BIT)
nxt_fd_event_state_t read:8; /* 3 bits. */
nxt_fd_event_state_t write:8; /* 3 bits. */
uint8_t read_ready;
uint8_t write_ready;
uint8_t changing;
uint8_t closed;
uint8_t timedout;
uint8_t shutdown:1;
#if (NXT_HAVE_EPOLL)
uint8_t epoll_eof:1;
uint8_t epoll_error:1;
#endif
#if (NXT_HAVE_KQUEUE)
uint8_t kq_eof:1;
#endif
#else /* NXT_32BIT */
nxt_fd_event_state_t read:3;
nxt_fd_event_state_t write:3;
uint8_t read_ready:1;
uint8_t write_ready:1;
uint8_t changing:1;
uint8_t closed:1;
uint8_t timedout:1;
uint8_t shutdown:1;
#if (NXT_HAVE_EPOLL)
uint8_t epoll_eof:1;
uint8_t epoll_error:1;
#endif
#if (NXT_HAVE_KQUEUE)
uint8_t kq_eof:1;
#endif
#endif /* NXT_64BIT */
#if (NXT_HAVE_KQUEUE)
/* nxt_err_t is int. */
nxt_err_t kq_errno;
/* struct kevent.data is intptr_t, however int32_t is enough. */
int32_t kq_available;
#endif
nxt_task_t *task;
nxt_work_queue_t *read_work_queue;
nxt_work_handler_t read_handler;
nxt_work_queue_t *write_work_queue;
nxt_work_handler_t write_handler;
nxt_work_handler_t error_handler;
nxt_log_t *log;
};
#endif /* _NXT_FD_EVENT_H_INCLUDED_ */