Skip to content

Commit

Permalink
HG core: enable diagnostic counters without debug
Browse files Browse the repository at this point in the history 
In some cases, it may be useful to enable the counters without
enabling the full debugging configuration.
  • Loading branch information
@mjmac @soumagne
mjmac authored and soumagne committed Feb 11, 2025
1 parent 82f684e commit d2e5de9
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 20 deletions.
13 changes: 13 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,23 @@ endif()
option(MERCURY_ENABLE_DEBUG "Enable debug statements." OFF)
if(MERCURY_ENABLE_DEBUG)
set(HG_HAS_DEBUG 1)
# Always enable counters if debug is turned ON
set(MERCURY_ENABLE_COUNTERS "ON" CACHE BOOL "Enable diagnostics counters (enabled with debug)." FORCE)
else()
set(HG_HAS_DEBUG 0)
endif()

#------------------------------------------------------------------------------
# Enable diagnostics counters separately from debug.
#------------------------------------------------------------------------------
option(MERCURY_ENABLE_COUNTERS "Enable diagnostics counters." OFF)
if(MERCURY_ENABLE_COUNTERS)
set(HG_HAS_DIAG 1)
else()
set(HG_HAS_DIAG 0)
endif()


#-------------------------------------------------------------------------------
if(${CMAKE_VERSION} VERSION_GREATER 3.14)
include(CheckPIESupported)
Expand Down
1 change: 1 addition & 0 deletions src/mercury_config.h.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ typedef hg_uint8_t hg_bool_t;

/* Build Options */
#cmakedefine HG_HAS_DEBUG
#cmakedefine HG_HAS_DIAG

/* Boost */
#cmakedefine HG_HAS_BOOST
Expand Down
40 changes: 20 additions & 20 deletions src/mercury_core.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ struct hg_core_private_class {
struct hg_core_map rpc_map; /* RPC Map */
struct hg_core_more_data_cb more_data_cb; /* More data callbacks */
na_tag_t request_max_tag; /* Max value for tag */
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
struct hg_core_counters counters; /* Diag counters */
#endif
hg_atomic_int32_t n_contexts; /* Total number of contexts */
Expand Down Expand Up @@ -365,7 +365,7 @@ struct hg_core_private_handle {
uint8_t cookie; /* Cookie */
bool multi_recv_copy; /* Copy on multi-recv */
bool reuse; /* Re-use handle once ref_count is 0 */
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
bool active;
#endif
};
Expand Down Expand Up @@ -401,7 +401,7 @@ hg_core_op_type_to_string(enum hg_core_op_type op_type);
/**
* Init counters.
*/
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
static void
hg_core_counters_init(struct hg_core_counters *hg_core_counters);
#endif
Expand Down Expand Up @@ -443,7 +443,7 @@ hg_core_finalize(struct hg_core_private_class *hg_core_class);
/**
* Get counters.
*/
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
static void
hg_core_class_get_counters(const struct hg_core_counters *counters,
struct hg_diag_counters *diag_counters);
Expand Down Expand Up @@ -1084,7 +1084,7 @@ hg_core_op_type_to_string(enum hg_core_op_type op_type)
#endif

/*---------------------------------------------------------------------------*/
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
static void
hg_core_counters_init(struct hg_core_counters *hg_core_counters)
{
Expand Down Expand Up @@ -1320,7 +1320,7 @@ hg_core_init(const char *na_info_string, bool na_listen, unsigned int version,
hg_core_class->init_info.listen = na_listen;

/* Stats / counters */
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
hg_core_counters_init(&hg_core_class->counters);
#endif

Expand Down Expand Up @@ -1516,7 +1516,7 @@ hg_core_finalize(struct hg_core_private_class *hg_core_class)
}

/*---------------------------------------------------------------------------*/
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
static void
hg_core_class_get_counters(const struct hg_core_counters *counters,
struct hg_diag_counters *diag_counters)
Expand Down Expand Up @@ -3435,7 +3435,7 @@ hg_core_destroy(struct hg_core_private_handle *hg_core_handle)
return HG_SUCCESS; /* Cannot free yet */
}

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
if (hg_core_handle->active) {
hg_atomic_decr64(HG_CORE_HANDLE_CLASS(hg_core_handle)
->counters.rpc_req_recv_active_count);
Expand Down Expand Up @@ -4050,7 +4050,7 @@ hg_core_forward(struct hg_core_private_handle *hg_core_handle,
hg_core_handle->request_callback = callback;
hg_core_handle->request_arg = arg;

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(
HG_CORE_HANDLE_CLASS(hg_core_handle)->counters.rpc_req_sent_count);
Expand Down Expand Up @@ -4254,7 +4254,7 @@ hg_core_respond(struct hg_core_private_handle *hg_core_handle,
hg_core_handle->response_callback = callback;
hg_core_handle->response_arg = arg;

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(
HG_CORE_HANDLE_CLASS(hg_core_handle)->counters.rpc_resp_sent_count);
Expand Down Expand Up @@ -4520,7 +4520,7 @@ hg_core_recv_input_cb(const struct na_cb_info *callback_info)
hg_thread_spin_lock(&hg_core_handle_pool->pending_list.lock);
LIST_REMOVE(hg_core_handle, pending);
hg_thread_spin_unlock(&hg_core_handle_pool->pending_list.lock);
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(HG_CORE_HANDLE_CLASS(hg_core_handle)
->counters.rpc_req_recv_active_count);
Expand Down Expand Up @@ -4628,7 +4628,7 @@ hg_core_multi_recv_input_cb(const struct na_cb_info *callback_info)
ret = hg_core_handle_pool_get(context->handle_pool, &hg_core_handle);
HG_CHECK_SUBSYS_HG_ERROR(
rpc, error, ret, "Could not get handle from pool");
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(HG_CORE_HANDLE_CLASS(hg_core_handle)
->counters.rpc_req_recv_active_count);
Expand Down Expand Up @@ -4685,7 +4685,7 @@ hg_core_multi_recv_input_cb(const struct na_cb_info *callback_info)
"Copying multi-recv payload of size %zu for handle (%p)",
hg_core_handle->core_handle.in_buf_used,
(void *) hg_core_handle);
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(HG_CORE_CONTEXT_CLASS(context)
->counters.rpc_multi_recv_copy_count);
Expand Down Expand Up @@ -4758,7 +4758,7 @@ hg_core_process_input(struct hg_core_private_handle *hg_core_handle)
HG_CORE_HANDLE_CLASS(hg_core_handle);
hg_return_t ret;

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(hg_core_class->counters.rpc_req_recv_count);
#endif
Expand Down Expand Up @@ -4808,7 +4808,7 @@ hg_core_process_input(struct hg_core_private_handle *hg_core_handle)
"Handle (%p) expected_count incr to %" PRId32,
(void *) hg_core_handle, expected_count);

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(hg_core_class->counters.rpc_req_extra_count);
#endif
Expand Down Expand Up @@ -4925,7 +4925,7 @@ hg_core_process_output(struct hg_core_private_handle *hg_core_handle,
HG_CORE_HANDLE_CLASS(hg_core_handle);
hg_return_t ret;

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(hg_core_class->counters.rpc_resp_recv_count);
#endif
Expand Down Expand Up @@ -4968,7 +4968,7 @@ hg_core_process_output(struct hg_core_private_handle *hg_core_handle,
"Handle (%p) expected_count incr to %" PRId32,
(void *) hg_core_handle, expected_count);

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
hg_atomic_incr64(hg_core_class->counters.rpc_resp_extra_count);
#endif
Expand Down Expand Up @@ -5242,7 +5242,7 @@ hg_core_completion_add(struct hg_core_context *core_context,
struct hg_core_completion_queue *backfill_queue = &context->backfill_queue;
int rc;

#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
/* Increment counter */
if (hg_completion_entry->op_type == HG_BULK)
hg_atomic_incr64(HG_CORE_CONTEXT_CLASS(context)->counters.bulk_count);
Expand Down Expand Up @@ -6136,7 +6136,7 @@ hg_return_t
HG_Core_class_get_counters(const hg_core_class_t *hg_core_class,
struct hg_diag_counters *diag_counters)
{
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
const struct hg_core_private_class *private_class =
(const struct hg_core_private_class *) hg_core_class;
#endif
Expand All @@ -6146,7 +6146,7 @@ HG_Core_class_get_counters(const hg_core_class_t *hg_core_class,
HG_INVALID_ARG, "NULL HG core class");
HG_CHECK_SUBSYS_ERROR(cls, diag_counters == NULL, error, ret,
HG_INVALID_ARG, "NULL pointer to diag_counters");
#if defined(HG_HAS_DEBUG) && !defined(_WIN32)
#if defined(HG_HAS_DIAG) && !defined(_WIN32)
hg_core_class_get_counters(&private_class->counters, diag_counters);
#else
HG_LOG_SUBSYS_ERROR(cls, "Counters not supported in current build, please "
Expand Down

0 comments on commit d2e5de9

Please sign in to comment.