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/ //}'
87 lines
2.3 KiB
C
87 lines
2.3 KiB
C
|
|
/*
|
|
* Copyright (C) Igor Sysoev
|
|
* Copyright (C) NGINX, Inc.
|
|
*/
|
|
|
|
#ifndef _NXT_JOB_H_INCLUDED_
|
|
#define _NXT_JOB_H_INCLUDED_
|
|
|
|
|
|
/*
|
|
* A job may run by separate thread, so each job should have its
|
|
* its own mem_pool. A job itself is allocated from this mem_pool.
|
|
* On job completion a job initiator can destroy the job at once
|
|
* with nxt_job_destroy() or can postpone the destruction with
|
|
* nxt_job_cleanup_add(), if the initiator uses data from the job's
|
|
* mem_pool.
|
|
*
|
|
* Several child jobs may run in context of another job in the same
|
|
* thread. In this case the child job may use a mem_pool of the
|
|
* parent job and the child job is allocated using the mem_pool's cache.
|
|
* nxt_job_destroy() just returns the job to the cache. All job
|
|
* allocations however still remain in the parent mem_pool.
|
|
*
|
|
* The first thread in job thread pool is created on demand. If this
|
|
* operation fails the job abort handler is called. It also is called
|
|
* if the job is canceled. To avoid race condition the abort handler
|
|
* always runs in context of a thread initiated the job. The abort
|
|
* handler may be as simple as nxt_job_destroy().
|
|
*/
|
|
|
|
|
|
typedef struct {
|
|
void *data;
|
|
|
|
nxt_task_t *task;
|
|
|
|
nxt_work_handler_t abort_handler;
|
|
|
|
uint16_t cache_size;
|
|
uint8_t cancel; /* 1 bit */
|
|
|
|
nxt_mp_t *mem_pool;
|
|
nxt_queue_link_t link;
|
|
|
|
nxt_thread_pool_t *thread_pool;
|
|
nxt_event_engine_t *engine;
|
|
nxt_log_t *log;
|
|
|
|
nxt_work_t work;
|
|
|
|
#if (NXT_DEBUG)
|
|
const char *name;
|
|
#endif
|
|
|
|
} nxt_job_t;
|
|
|
|
|
|
NXT_EXPORT void *nxt_job_create(nxt_mp_t *mp, size_t size);
|
|
NXT_EXPORT void nxt_job_init(nxt_job_t *job, size_t size);
|
|
NXT_EXPORT void nxt_job_destroy(nxt_task_t *task, void *data);
|
|
NXT_EXPORT nxt_int_t nxt_job_cleanup_add(nxt_mp_t *mp, nxt_job_t *job);
|
|
|
|
NXT_EXPORT void nxt_job_start(nxt_task_t *task, nxt_job_t *job,
|
|
nxt_work_handler_t handler);
|
|
NXT_EXPORT void nxt_job_return(nxt_task_t *task, nxt_job_t *job,
|
|
nxt_work_handler_t handler);
|
|
|
|
|
|
#define nxt_job_cancel(job) \
|
|
(job)->cancel = 1
|
|
|
|
|
|
#if (NXT_DEBUG)
|
|
|
|
#define nxt_job_set_name(job, text) \
|
|
(job)->name = text
|
|
|
|
#else
|
|
|
|
#define nxt_job_set_name(job, text)
|
|
|
|
#endif
|
|
|
|
|
|
#endif /* _NXT_JOB_H_INCLUDED_ */
|