Give guidance on prefixing struct/enum/#define names

pull/12519/head
Vijay Pai 7 years ago
parent ce286cb3a8
commit 4a7fca5b65
  1. 14
      doc/c-style-guide.md
  2. 6
      src/core/lib/iomgr/ev_poll_posix.c
  3. 14
      src/core/lib/iomgr/wakeup_fd_cv.c
  4. 4
      src/core/lib/iomgr/wakeup_fd_cv.h

@ -32,14 +32,14 @@ Header Files
# endif # endif
``` ```
- Header files should be self-contained and end in .h. - Header files should be self-contained and end in .h.
- All header files should have a #define guard to prevent multiple inclusion. - All header files should have a `#define` guard to prevent multiple inclusion.
To guarantee uniqueness they should be based on the file's path. To guarantee uniqueness they should be based on the file's path.
For public headers: `include/grpc/grpc.h``GRPC_GRPC_H` For public headers: `include/grpc/grpc.h``GRPC_GRPC_H`
For private headers: For private headers:
`src/core/channel/channel_stack.h` `src/core/lib/channel/channel_stack.h`
`GRPC_INTERNAL_CORE_CHANNEL_CHANNEL_STACK_H` `GRPC_CORE_LIB_CHANNEL_CHANNEL_STACK_H`
Variable Initialization Variable Initialization
----------------------- -----------------------
@ -72,8 +72,16 @@ Symbol Names
- Non-static functions must be prefixed by `grpc_` - Non-static functions must be prefixed by `grpc_`
- Static functions must *not* be prefixed by `grpc_` - Static functions must *not* be prefixed by `grpc_`
- Typenames of `struct`s , `union`s, and `enum`s must be prefixed by `grpc_` if
they are declared in a header file. They must not be prefixed by `grpc_` if
they are declared in a source file.
- Enumeration values and `#define` names must be uppercase. All other values - Enumeration values and `#define` names must be uppercase. All other values
must be lowercase. must be lowercase.
- Enumeration values or `#define` names defined in a header file must be
prefixed with `GRPC_` (except for `#define` macros that are being used to
substitute functions; those should follow the general rules for
functions). Enumeration values or `#define`s defined in source files must not
be prefixed with `GRPC_`.
- Multiple word identifiers use underscore as a delimiter, *never* camel - Multiple word identifiers use underscore as a delimiter, *never* camel
case. E.g. `variable_name`. case. E.g. `variable_name`.

@ -1539,7 +1539,7 @@ static int cvfd_poll(struct pollfd *fds, nfds_t nfds, int timeout) {
for (i = 0; i < nfds; i++) { for (i = 0; i < nfds; i++) {
fds[i].revents = 0; fds[i].revents = 0;
if (fds[i].fd < 0 && (fds[i].events & POLLIN)) { if (fds[i].fd < 0 && (fds[i].events & POLLIN)) {
idx = FD_TO_IDX(fds[i].fd); idx = GRPC_FD_TO_IDX(fds[i].fd);
fd_cvs[i].cv = &pollcv_cv; fd_cvs[i].cv = &pollcv_cv;
fd_cvs[i].prev = NULL; fd_cvs[i].prev = NULL;
fd_cvs[i].next = g_cvfds.cvfds[idx].cvs; fd_cvs[i].next = g_cvfds.cvfds[idx].cvs;
@ -1602,8 +1602,8 @@ static int cvfd_poll(struct pollfd *fds, nfds_t nfds, int timeout) {
idx = 0; idx = 0;
for (i = 0; i < nfds; i++) { for (i = 0; i < nfds; i++) {
if (fds[i].fd < 0 && (fds[i].events & POLLIN)) { if (fds[i].fd < 0 && (fds[i].events & POLLIN)) {
remove_cvn(&g_cvfds.cvfds[FD_TO_IDX(fds[i].fd)].cvs, &(fd_cvs[i])); remove_cvn(&g_cvfds.cvfds[GRPC_FD_TO_IDX(fds[i].fd)].cvs, &(fd_cvs[i]));
if (g_cvfds.cvfds[FD_TO_IDX(fds[i].fd)].is_set) { if (g_cvfds.cvfds[GRPC_FD_TO_IDX(fds[i].fd)].is_set) {
fds[i].revents = POLLIN; fds[i].revents = POLLIN;
if (res >= 0) res++; if (res >= 0) res++;
} }

@ -57,7 +57,7 @@ static grpc_error* cv_fd_init(grpc_wakeup_fd* fd_info) {
g_cvfds.free_fds = g_cvfds.free_fds->next_free; g_cvfds.free_fds = g_cvfds.free_fds->next_free;
g_cvfds.cvfds[idx].cvs = NULL; g_cvfds.cvfds[idx].cvs = NULL;
g_cvfds.cvfds[idx].is_set = 0; g_cvfds.cvfds[idx].is_set = 0;
fd_info->read_fd = IDX_TO_FD(idx); fd_info->read_fd = GRPC_IDX_TO_FD(idx);
fd_info->write_fd = -1; fd_info->write_fd = -1;
gpr_mu_unlock(&g_cvfds.mu); gpr_mu_unlock(&g_cvfds.mu);
return GRPC_ERROR_NONE; return GRPC_ERROR_NONE;
@ -66,8 +66,8 @@ static grpc_error* cv_fd_init(grpc_wakeup_fd* fd_info) {
static grpc_error* cv_fd_wakeup(grpc_wakeup_fd* fd_info) { static grpc_error* cv_fd_wakeup(grpc_wakeup_fd* fd_info) {
cv_node* cvn; cv_node* cvn;
gpr_mu_lock(&g_cvfds.mu); gpr_mu_lock(&g_cvfds.mu);
g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)].is_set = 1; g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)].is_set = 1;
cvn = g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)].cvs; cvn = g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)].cvs;
while (cvn) { while (cvn) {
gpr_cv_signal(cvn->cv); gpr_cv_signal(cvn->cv);
cvn = cvn->next; cvn = cvn->next;
@ -78,7 +78,7 @@ static grpc_error* cv_fd_wakeup(grpc_wakeup_fd* fd_info) {
static grpc_error* cv_fd_consume(grpc_wakeup_fd* fd_info) { static grpc_error* cv_fd_consume(grpc_wakeup_fd* fd_info) {
gpr_mu_lock(&g_cvfds.mu); gpr_mu_lock(&g_cvfds.mu);
g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)].is_set = 0; g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)].is_set = 0;
gpr_mu_unlock(&g_cvfds.mu); gpr_mu_unlock(&g_cvfds.mu);
return GRPC_ERROR_NONE; return GRPC_ERROR_NONE;
} }
@ -89,9 +89,9 @@ static void cv_fd_destroy(grpc_wakeup_fd* fd_info) {
} }
gpr_mu_lock(&g_cvfds.mu); gpr_mu_lock(&g_cvfds.mu);
// Assert that there are no active pollers // Assert that there are no active pollers
GPR_ASSERT(!g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)].cvs); GPR_ASSERT(!g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)].cvs);
g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)].next_free = g_cvfds.free_fds; g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)].next_free = g_cvfds.free_fds;
g_cvfds.free_fds = &g_cvfds.cvfds[FD_TO_IDX(fd_info->read_fd)]; g_cvfds.free_fds = &g_cvfds.cvfds[GRPC_FD_TO_IDX(fd_info->read_fd)];
gpr_mu_unlock(&g_cvfds.mu); gpr_mu_unlock(&g_cvfds.mu);
} }

@ -37,8 +37,8 @@
#include "src/core/lib/iomgr/ev_posix.h" #include "src/core/lib/iomgr/ev_posix.h"
#define FD_TO_IDX(fd) (-(fd)-1) #define GRPC_FD_TO_IDX(fd) (-(fd)-1)
#define IDX_TO_FD(idx) (-(idx)-1) #define GRPC_IDX_TO_FD(idx) (-(idx)-1)
typedef struct cv_node { typedef struct cv_node {
gpr_cv* cv; gpr_cv* cv;

Loading…
Cancel
Save