952bcc50bf
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/ //}'
128 lines
3.8 KiB
C
128 lines
3.8 KiB
C
|
|
/*
|
|
* Copyright (C) Igor Sysoev
|
|
* Copyright (C) NGINX, Inc.
|
|
*/
|
|
|
|
#ifndef _NXT_WORK_QUEUE_H_INCLUDED_
|
|
#define _NXT_WORK_QUEUE_H_INCLUDED_
|
|
|
|
|
|
typedef struct nxt_work_s nxt_work_t;
|
|
|
|
struct nxt_task_s {
|
|
nxt_thread_t *thread;
|
|
nxt_log_t *log;
|
|
uint32_t ident;
|
|
nxt_work_t *next_work;
|
|
|
|
/* TODO: exception_handler, prev/next task, subtasks. */
|
|
};
|
|
|
|
|
|
#define nxt_task_next_ident() \
|
|
((uint32_t) nxt_atomic_fetch_add(&nxt_task_ident, 1) & 0x3FFFFFFF)
|
|
|
|
|
|
/*
|
|
* A work handler with just the obj and data arguments instead
|
|
* of pointer to a possibly large a work struct allows to call
|
|
* the handler not only via a work queue but also directly.
|
|
* The only obj argument is enough for the most cases except the
|
|
* source filters, so the data argument has been introduced and
|
|
* is used where appropriate.
|
|
*/
|
|
//typedef void (*nxt_work_handler_t)(nxt_task_t *task, void *obj, void *data);
|
|
|
|
|
|
struct nxt_work_s {
|
|
nxt_work_t *next;
|
|
nxt_work_handler_t handler;
|
|
nxt_task_t *task;
|
|
void *obj;
|
|
void *data;
|
|
};
|
|
|
|
|
|
typedef struct nxt_work_queue_chunk_s nxt_work_queue_chunk_t;
|
|
|
|
struct nxt_work_queue_chunk_s {
|
|
nxt_work_queue_chunk_t *next;
|
|
nxt_work_t work;
|
|
};
|
|
|
|
|
|
typedef struct {
|
|
nxt_work_t *next;
|
|
nxt_work_t *spare;
|
|
nxt_work_queue_chunk_t *chunk;
|
|
size_t chunk_size;
|
|
} nxt_work_queue_cache_t;
|
|
|
|
|
|
typedef struct nxt_work_queue_s nxt_work_queue_t;
|
|
|
|
struct nxt_work_queue_s {
|
|
nxt_work_t *head;
|
|
nxt_work_t *tail;
|
|
nxt_work_queue_cache_t *cache;
|
|
#if (NXT_DEBUG)
|
|
const char *name;
|
|
int32_t pid;
|
|
nxt_tid_t tid;
|
|
#endif
|
|
};
|
|
|
|
|
|
typedef struct {
|
|
nxt_thread_spinlock_t lock;
|
|
nxt_work_t *head;
|
|
nxt_work_t *tail;
|
|
nxt_work_queue_cache_t cache;
|
|
} nxt_locked_work_queue_t;
|
|
|
|
|
|
NXT_EXPORT void nxt_work_queue_cache_create(nxt_work_queue_cache_t *cache,
|
|
size_t chunk_size);
|
|
NXT_EXPORT void nxt_work_queue_cache_destroy(nxt_work_queue_cache_t *cache);
|
|
|
|
NXT_EXPORT void nxt_work_queue_add(nxt_work_queue_t *wq,
|
|
nxt_work_handler_t handler, nxt_task_t *task, void *obj, void *data);
|
|
NXT_EXPORT nxt_work_handler_t nxt_work_queue_pop(nxt_work_queue_t *wq,
|
|
nxt_task_t **task, void **obj, void **data);
|
|
|
|
|
|
#define nxt_work_set(_work, _handler, _task, _obj, _data) \
|
|
do { \
|
|
nxt_work_t *work = _work; \
|
|
\
|
|
work->handler = _handler; \
|
|
work->task = _task; \
|
|
work->obj = _obj; \
|
|
work->data = _data; \
|
|
} while (0)
|
|
|
|
#if (NXT_DEBUG)
|
|
|
|
NXT_EXPORT void nxt_work_queue_name(nxt_work_queue_t *wq, const char *name);
|
|
NXT_EXPORT void nxt_work_queue_thread_adopt(nxt_work_queue_t *wq);
|
|
|
|
#else
|
|
|
|
#define nxt_work_queue_name(_wq, _name)
|
|
|
|
#define nxt_work_queue_thread_adopt(_wq)
|
|
|
|
#endif
|
|
|
|
|
|
NXT_EXPORT void nxt_locked_work_queue_add(nxt_locked_work_queue_t *lwq,
|
|
nxt_work_t *work);
|
|
NXT_EXPORT nxt_work_handler_t nxt_locked_work_queue_pop(
|
|
nxt_locked_work_queue_t *lwq, nxt_task_t **task, void **obj, void **data);
|
|
NXT_EXPORT void nxt_locked_work_queue_move(nxt_thread_t *thr,
|
|
nxt_locked_work_queue_t *lwq, nxt_work_queue_t *wq);
|
|
|
|
|
|
#endif /* _NXT_WORK_QUEUE_H_INCLUDED_ */
|