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/ //}'
273 lines
5.9 KiB
C
273 lines
5.9 KiB
C
|
|
/*
|
|
* Copyright (C) Igor Sysoev
|
|
* Copyright (C) NGINX, Inc.
|
|
*/
|
|
|
|
#include <nxt_main.h>
|
|
|
|
|
|
#define NXT_HTTP_CHUNK_MIDDLE 0
|
|
#define NXT_HTTP_CHUNK_END_ON_BORDER 1
|
|
#define NXT_HTTP_CHUNK_END 2
|
|
|
|
|
|
#define nxt_size_is_sufficient(cs) \
|
|
(cs < ((__typeof__(cs)) 1 << (sizeof(cs) * 8 - 4)))
|
|
|
|
|
|
static nxt_int_t nxt_http_chunk_buffer(nxt_http_chunk_parse_t *hcp,
|
|
nxt_buf_t ***tail, nxt_buf_t *in);
|
|
|
|
|
|
static void nxt_http_chunk_buf_completion(nxt_task_t *task, void *obj,
|
|
void *data);
|
|
|
|
|
|
nxt_buf_t *
|
|
nxt_http_chunk_parse(nxt_task_t *task, nxt_http_chunk_parse_t *hcp,
|
|
nxt_buf_t *in)
|
|
{
|
|
u_char c, ch;
|
|
nxt_int_t ret;
|
|
nxt_buf_t *b, *out, *next, **tail;
|
|
enum {
|
|
sw_start = 0,
|
|
sw_chunk_size,
|
|
sw_chunk_size_linefeed,
|
|
sw_chunk_end_newline,
|
|
sw_chunk_end_linefeed,
|
|
sw_chunk,
|
|
} state;
|
|
|
|
next = NULL;
|
|
out = NULL;
|
|
tail = &out;
|
|
|
|
state = hcp->state;
|
|
|
|
for (b = in; b != NULL; b = next) {
|
|
|
|
hcp->pos = b->mem.pos;
|
|
|
|
while (hcp->pos < b->mem.free) {
|
|
/*
|
|
* The sw_chunk state is tested outside the switch
|
|
* to preserve hcp->pos and to not touch memory.
|
|
*/
|
|
if (state == sw_chunk) {
|
|
ret = nxt_http_chunk_buffer(hcp, &tail, b);
|
|
|
|
if (ret == NXT_HTTP_CHUNK_MIDDLE) {
|
|
goto next;
|
|
}
|
|
|
|
if (nxt_slow_path(ret == NXT_ERROR)) {
|
|
hcp->error = 1;
|
|
return out;
|
|
}
|
|
|
|
state = sw_chunk_end_newline;
|
|
|
|
if (ret == NXT_HTTP_CHUNK_END_ON_BORDER) {
|
|
goto next;
|
|
}
|
|
|
|
/* ret == NXT_HTTP_CHUNK_END */
|
|
}
|
|
|
|
ch = *hcp->pos++;
|
|
|
|
switch (state) {
|
|
|
|
case sw_start:
|
|
state = sw_chunk_size;
|
|
|
|
c = ch - '0';
|
|
|
|
if (c <= 9) {
|
|
hcp->chunk_size = c;
|
|
continue;
|
|
}
|
|
|
|
c = (ch | 0x20) - 'a';
|
|
|
|
if (c <= 5) {
|
|
hcp->chunk_size = 0x0A + c;
|
|
continue;
|
|
}
|
|
|
|
goto chunk_error;
|
|
|
|
case sw_chunk_size:
|
|
|
|
c = ch - '0';
|
|
|
|
if (c > 9) {
|
|
c = (ch | 0x20) - 'a';
|
|
|
|
if (nxt_fast_path(c <= 5)) {
|
|
c += 0x0A;
|
|
|
|
} else if (nxt_fast_path(ch == '\r')) {
|
|
state = sw_chunk_size_linefeed;
|
|
continue;
|
|
|
|
} else {
|
|
goto chunk_error;
|
|
}
|
|
}
|
|
|
|
if (nxt_fast_path(nxt_size_is_sufficient(hcp->chunk_size))) {
|
|
hcp->chunk_size = (hcp->chunk_size << 4) + c;
|
|
continue;
|
|
}
|
|
|
|
goto chunk_error;
|
|
|
|
case sw_chunk_size_linefeed:
|
|
if (nxt_fast_path(ch == '\n')) {
|
|
|
|
if (hcp->chunk_size != 0) {
|
|
state = sw_chunk;
|
|
continue;
|
|
}
|
|
|
|
hcp->last = 1;
|
|
state = sw_chunk_end_newline;
|
|
continue;
|
|
}
|
|
|
|
goto chunk_error;
|
|
|
|
case sw_chunk_end_newline:
|
|
if (nxt_fast_path(ch == '\r')) {
|
|
state = sw_chunk_end_linefeed;
|
|
continue;
|
|
}
|
|
|
|
goto chunk_error;
|
|
|
|
case sw_chunk_end_linefeed:
|
|
if (nxt_fast_path(ch == '\n')) {
|
|
|
|
if (!hcp->last) {
|
|
state = sw_start;
|
|
continue;
|
|
}
|
|
|
|
return out;
|
|
}
|
|
|
|
goto chunk_error;
|
|
|
|
case sw_chunk:
|
|
/*
|
|
* This state is processed before the switch.
|
|
* It added here just to suppress a warning.
|
|
*/
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if (b->retain == 0) {
|
|
/* No chunk data was found in a buffer. */
|
|
nxt_work_queue_add(&task->thread->engine->fast_work_queue,
|
|
b->completion_handler, task, b, b->parent);
|
|
|
|
}
|
|
|
|
next:
|
|
|
|
next = b->next;
|
|
b->next = NULL;
|
|
}
|
|
|
|
hcp->state = state;
|
|
|
|
return out;
|
|
|
|
chunk_error:
|
|
|
|
hcp->chunk_error = 1;
|
|
|
|
return out;
|
|
}
|
|
|
|
|
|
static nxt_int_t
|
|
nxt_http_chunk_buffer(nxt_http_chunk_parse_t *hcp, nxt_buf_t ***tail,
|
|
nxt_buf_t *in)
|
|
{
|
|
u_char *p;
|
|
size_t size;
|
|
nxt_buf_t *b;
|
|
|
|
p = hcp->pos;
|
|
size = in->mem.free - p;
|
|
|
|
b = nxt_buf_mem_alloc(hcp->mem_pool, 0, 0);
|
|
if (nxt_slow_path(b == NULL)) {
|
|
return NXT_ERROR;
|
|
}
|
|
|
|
**tail = b;
|
|
*tail = &b->next;
|
|
|
|
nxt_mp_retain(hcp->mem_pool);
|
|
b->completion_handler = nxt_http_chunk_buf_completion;
|
|
|
|
b->parent = in;
|
|
in->retain++;
|
|
b->mem.pos = p;
|
|
b->mem.start = p;
|
|
|
|
if (hcp->chunk_size < size) {
|
|
p += hcp->chunk_size;
|
|
hcp->pos = p;
|
|
|
|
b->mem.free = p;
|
|
b->mem.end = p;
|
|
|
|
return NXT_HTTP_CHUNK_END;
|
|
}
|
|
|
|
b->mem.free = in->mem.free;
|
|
b->mem.end = in->mem.free;
|
|
|
|
hcp->chunk_size -= size;
|
|
|
|
if (hcp->chunk_size == 0) {
|
|
return NXT_HTTP_CHUNK_END_ON_BORDER;
|
|
}
|
|
|
|
return NXT_HTTP_CHUNK_MIDDLE;
|
|
}
|
|
|
|
|
|
static void
|
|
nxt_http_chunk_buf_completion(nxt_task_t *task, void *obj, void *data)
|
|
{
|
|
nxt_mp_t *mp;
|
|
nxt_buf_t *b, *next, *parent;
|
|
|
|
b = obj;
|
|
|
|
nxt_debug(task, "buf completion: %p %p", b, b->mem.start);
|
|
|
|
nxt_assert(data == b->parent);
|
|
|
|
do {
|
|
next = b->next;
|
|
parent = b->parent;
|
|
mp = b->data;
|
|
|
|
nxt_mp_free(mp, b);
|
|
nxt_mp_release(mp);
|
|
|
|
nxt_buf_parent_completion(task, parent);
|
|
|
|
b = next;
|
|
} while (b != NULL);
|
|
}
|