technocloud-public/nginx-unit
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fixed #define style.

Browse Source 
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/        //}'
This commit is contained in:
Alejandro Colomar
2022-04-30 19:20:23 +02:00
parent d929fbe1a4
commit 952bcc50bf
41 changed files with 259 additions and 518 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/nxt_atomic.h
View File

@@ -26,28 +26,23 @@ typedef volatile nxt_atomic_uint_t nxt_atomic_t;
* __sync_lock_release() is a release barrier.
*/
#define \
nxt_atomic_cmp_set(lock, cmp, set) \
#define nxt_atomic_cmp_set(lock, cmp, set) \
__sync_bool_compare_and_swap(lock, cmp, set)
#define \
nxt_atomic_xchg(lock, set) \
#define nxt_atomic_xchg(lock, set) \
__sync_lock_test_and_set(lock, set)
#define \
nxt_atomic_fetch_add(value, add) \
#define nxt_atomic_fetch_add(value, add) \
__sync_fetch_and_add(value, add)
#define \
nxt_atomic_try_lock(lock) \
#define nxt_atomic_try_lock(lock) \
nxt_atomic_cmp_set(lock, 0, 1)
#define \
nxt_atomic_release(lock) \
#define nxt_atomic_release(lock) \
__sync_lock_release(lock)
@@ -60,13 +55,11 @@ nxt_atomic_release(lock) \
#if (__i386__ || __i386 || __amd64__ || __amd64)
#define \
nxt_cpu_pause() \
#define nxt_cpu_pause() \
__asm__ ("pause")
#else
#define \
nxt_cpu_pause()
#define nxt_cpu_pause()
#endif
@@ -79,18 +72,15 @@ typedef ulong_t nxt_atomic_uint_t;
typedef volatile nxt_atomic_uint_t nxt_atomic_t;
#define \
nxt_atomic_cmp_set(lock, cmp, set) \
#define nxt_atomic_cmp_set(lock, cmp, set) \
(atomic_cas_ulong(lock, cmp, set) == (ulong_t) cmp)
#define \
nxt_atomic_xchg(lock, set) \
#define nxt_atomic_xchg(lock, set) \
atomic_add_swap(lock, set)
#define \
nxt_atomic_fetch_add(value, add) \
#define nxt_atomic_fetch_add(value, add) \
(atomic_add_long_nv(value, add) - add)
@@ -124,13 +114,11 @@ nxt_atomic_fetch_add(value, add) \
* barrier.
*/
#define \
nxt_atomic_try_lock(lock) \
#define nxt_atomic_try_lock(lock) \
nxt_atomic_cmp_set(lock, 0, 1)
#define \
nxt_atomic_release(lock) \
#define nxt_atomic_release(lock) \
*lock = 0;
@@ -142,13 +130,11 @@ nxt_atomic_release(lock) \
*/
#if (__i386__ || __i386 || __amd64__ || __amd64)
#define \
nxt_cpu_pause() \
#define nxt_cpu_pause() \
__asm__ ("rep; nop")
#else
#define \
nxt_cpu_pause()
#define nxt_cpu_pause()
#endif
@@ -192,13 +178,11 @@ nxt_atomic_cmp_set(nxt_atomic_t *lock, nxt_atomic_int_t cmp,
}
#define \
nxt_atomic_xchg(lock, set) \
#define nxt_atomic_xchg(lock, set) \
__fetch_and_swaplp(lock, set)
#define \
nxt_atomic_fetch_add(value, add) \
#define nxt_atomic_fetch_add(value, add) \
__fetch_and_addlp(value, add)
@@ -221,13 +205,11 @@ nxt_atomic_cmp_set(nxt_atomic_t *lock, nxt_atomic_int_t cmp,
}
#define \
nxt_atomic_xchg(lock, set) \
#define nxt_atomic_xchg(lock, set) \
__fetch_and_swap(lock, set)
#define \
nxt_atomic_fetch_add(value, add) \
#define nxt_atomic_fetch_add(value, add) \
__fetch_and_add(value, add)
@@ -270,13 +252,11 @@ nxt_atomic_try_lock(nxt_atomic_t *lock)
}
#define \
nxt_atomic_release(lock) \
#define nxt_atomic_release(lock) \
do { __lwsync(); *lock = 0; } while (0)
#define \
nxt_cpu_pause()
#define nxt_cpu_pause()
#endif /* NXT_HAVE_XLC_ATOMIC */