Skip to content

Commit

Permalink
[grpc][Gpr_To_Absl_Logging] Migrating from gpr to absl logging GPR_AS…
Browse files Browse the repository at this point in the history
…SERT (#36439)

[grpc][Gpr_To_Absl_Logging] Migrating from gpr to absl logging GPR_ASSERT
Replacing GPR_ASSERT with absl CHECK

These changes have been made using string replacement and regex.

Will not be replacing all instances of CHECK with CHECK_EQ , CHECK_NE etc because there are too many callsites. Only ones which are doable using very simple regex with least chance of failure will be replaced.

Given that we have 5000+ instances of GPR_ASSERT to edit, Doing it manually is too much work for both the author and reviewer.

<!--

If you know who should review your pull request, please assign it to that
person, otherwise the pull request would get assigned randomly.

If your pull request is for a specific language, please add the appropriate
lang label.

-->

Closes #36439

COPYBARA_INTEGRATE_REVIEW=#36439 from tanvi-jagtap:tjagtap_iomgr_large fd759fa
PiperOrigin-RevId: 628564520
  • Loading branch information
tanvi-jagtap authored and Copybara-Service committed Apr 27, 2024
1 parent 5f631c3 commit 82718c4
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 64 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions build_autogenerated.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion test/core/iomgr/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,10 @@ grpc_cc_test(
grpc_cc_test(
name = "tcp_posix_test",
srcs = ["tcp_posix_test.cc"],
external_deps = ["gtest"],
external_deps = [
"absl/log:check",
"gtest",
],
language = "C++",
tags = [
"endpoint_test",
Expand Down Expand Up @@ -343,6 +346,9 @@ grpc_cc_test(
grpc_cc_test(
name = "timer_list_test",
srcs = ["timer_list_test.cc"],
external_deps = [
"absl/log:check",
],
language = "C++",
uses_event_engine = False,
uses_polling = False,
Expand Down
64 changes: 33 additions & 31 deletions test/core/iomgr/tcp_posix_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@

#include <gtest/gtest.h>

#include "absl/log/check.h"

#include <grpc/grpc.h>
#include <grpc/support/alloc.h>
#include <grpc/support/log.h>
Expand Down Expand Up @@ -80,11 +82,11 @@ static constexpr int64_t kDeadlineMillis = 20000;

static void create_sockets(int sv[2]) {
int flags;
GPR_ASSERT(socketpair(AF_UNIX, SOCK_STREAM, 0, sv) == 0);
CHECK_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, sv), 0);
flags = fcntl(sv[0], F_GETFL, 0);
GPR_ASSERT(fcntl(sv[0], F_SETFL, flags | O_NONBLOCK) == 0);
CHECK_EQ(fcntl(sv[0], F_SETFL, flags | O_NONBLOCK), 0);
flags = fcntl(sv[1], F_GETFL, 0);
GPR_ASSERT(fcntl(sv[1], F_SETFL, flags | O_NONBLOCK) == 0);
CHECK_EQ(fcntl(sv[1], F_SETFL, flags | O_NONBLOCK), 0);
}

static ssize_t fill_socket(int fd) {
Expand All @@ -101,7 +103,7 @@ static ssize_t fill_socket(int fd) {
total_bytes += write_bytes;
}
} while (write_bytes >= 0 || errno == EINTR);
GPR_ASSERT(errno == EAGAIN);
CHECK(errno == EAGAIN);
return total_bytes;
}

Expand Down Expand Up @@ -143,7 +145,7 @@ static size_t count_slices(grpc_slice* slices, size_t nslices,
for (i = 0; i < nslices; ++i) {
buf = GRPC_SLICE_START_PTR(slices[i]);
for (j = 0; j < GRPC_SLICE_LENGTH(slices[i]); ++j) {
GPR_ASSERT(buf[j] == *current_data);
CHECK(buf[j] == *current_data);
*current_data = (*current_data + 1) % 256;
}
num_bytes += GRPC_SLICE_LENGTH(slices[i]);
Expand All @@ -157,23 +159,22 @@ static void read_cb(void* user_data, grpc_error_handle error) {
size_t read_bytes;
int current_data;

GPR_ASSERT(error.ok());
CHECK_OK(error);

gpr_mu_lock(g_mu);
current_data = state->read_bytes % 256;
// The number of bytes read each time this callback is invoked must be >=
// the min_progress_size.
if (grpc_core::IsTcpFrameSizeTuningEnabled()) {
GPR_ASSERT(state->min_progress_size <= state->incoming.length);
CHECK(state->min_progress_size <= state->incoming.length);
}
read_bytes = count_slices(state->incoming.slices, state->incoming.count,
&current_data);
state->read_bytes += read_bytes;
gpr_log(GPR_INFO, "Read %" PRIuPTR " bytes of %" PRIuPTR, read_bytes,
state->target_read_bytes);
if (state->read_bytes >= state->target_read_bytes) {
GPR_ASSERT(
GRPC_LOG_IF_ERROR("kick", grpc_pollset_kick(g_pollset, nullptr)));
CHECK(GRPC_LOG_IF_ERROR("kick", grpc_pollset_kick(g_pollset, nullptr)));
gpr_mu_unlock(g_mu);
} else {
gpr_mu_unlock(g_mu);
Expand Down Expand Up @@ -233,13 +234,13 @@ static void read_test(size_t num_bytes, size_t slice_size,
gpr_mu_lock(g_mu);
while (state.read_bytes < state.target_read_bytes) {
grpc_pollset_worker* worker = nullptr;
GPR_ASSERT(GRPC_LOG_IF_ERROR(
"pollset_work", grpc_pollset_work(g_pollset, &worker, deadline)));
CHECK(GRPC_LOG_IF_ERROR("pollset_work",
grpc_pollset_work(g_pollset, &worker, deadline)));
gpr_mu_unlock(g_mu);
grpc_core::ExecCtx::Get()->Flush();
gpr_mu_lock(g_mu);
}
GPR_ASSERT(state.read_bytes == state.target_read_bytes);
CHECK(state.read_bytes == state.target_read_bytes);
gpr_mu_unlock(g_mu);

grpc_slice_buffer_destroy(&state.incoming);
Expand Down Expand Up @@ -297,13 +298,13 @@ static void large_read_test(size_t slice_size, int min_progress_size) {
gpr_mu_lock(g_mu);
while (state.read_bytes < state.target_read_bytes) {
grpc_pollset_worker* worker = nullptr;
GPR_ASSERT(GRPC_LOG_IF_ERROR(
"pollset_work", grpc_pollset_work(g_pollset, &worker, deadline)));
CHECK(GRPC_LOG_IF_ERROR("pollset_work",
grpc_pollset_work(g_pollset, &worker, deadline)));
gpr_mu_unlock(g_mu);
grpc_core::ExecCtx::Get()->Flush();
gpr_mu_lock(g_mu);
}
GPR_ASSERT(state.read_bytes == state.target_read_bytes);
CHECK(state.read_bytes == state.target_read_bytes);
gpr_mu_unlock(g_mu);

grpc_slice_buffer_destroy(&state.incoming);
Expand Down Expand Up @@ -337,18 +338,18 @@ static grpc_slice* allocate_blocks(size_t num_bytes, size_t slice_size,
(*current_data)++;
}
}
GPR_ASSERT(num_bytes_left == 0);
CHECK_EQ(num_bytes_left, 0);
return slices;
}

static void write_done(void* user_data /* write_socket_state */,
grpc_error_handle error) {
GPR_ASSERT(error.ok());
CHECK_OK(error);
struct write_socket_state* state =
static_cast<struct write_socket_state*>(user_data);
gpr_mu_lock(g_mu);
state->write_done = 1;
GPR_ASSERT(
CHECK(
GRPC_LOG_IF_ERROR("pollset_kick", grpc_pollset_kick(g_pollset, nullptr)));
gpr_mu_unlock(g_mu);
}
Expand All @@ -363,12 +364,12 @@ void drain_socket_blocking(int fd, size_t num_bytes, size_t read_size) {
grpc_core::ExecCtx exec_ctx;

flags = fcntl(fd, F_GETFL, 0);
GPR_ASSERT(fcntl(fd, F_SETFL, flags & ~O_NONBLOCK) == 0);
CHECK_EQ(fcntl(fd, F_SETFL, flags & ~O_NONBLOCK), 0);

for (;;) {
grpc_pollset_worker* worker = nullptr;
gpr_mu_lock(g_mu);
GPR_ASSERT(GRPC_LOG_IF_ERROR(
CHECK(GRPC_LOG_IF_ERROR(
"pollset_work",
grpc_pollset_work(g_pollset, &worker,
grpc_core::Timestamp::FromTimespecRoundUp(
Expand All @@ -379,16 +380,16 @@ void drain_socket_blocking(int fd, size_t num_bytes, size_t read_size) {
bytes_read =
read(fd, buf, bytes_left > read_size ? read_size : bytes_left);
} while (bytes_read < 0 && errno == EINTR);
GPR_ASSERT(bytes_read >= 0);
CHECK_GE(bytes_read, 0);
for (i = 0; i < bytes_read; ++i) {
GPR_ASSERT(buf[i] == current);
CHECK(buf[i] == current);
current = (current + 1) % 256;
}
bytes_left -= static_cast<size_t>(bytes_read);
if (bytes_left == 0) break;
}
flags = fcntl(fd, F_GETFL, 0);
GPR_ASSERT(fcntl(fd, F_SETFL, flags | O_NONBLOCK) == 0);
CHECK_EQ(fcntl(fd, F_SETFL, flags | O_NONBLOCK), 0);

gpr_free(buf);
}
Expand Down Expand Up @@ -453,8 +454,8 @@ static void write_test(size_t num_bytes, size_t slice_size) {
if (state.write_done) {
break;
}
GPR_ASSERT(GRPC_LOG_IF_ERROR(
"pollset_work", grpc_pollset_work(g_pollset, &worker, deadline)));
CHECK(GRPC_LOG_IF_ERROR("pollset_work",
grpc_pollset_work(g_pollset, &worker, deadline)));
gpr_mu_unlock(g_mu);
exec_ctx.Flush();
gpr_mu_lock(g_mu);
Expand Down Expand Up @@ -531,7 +532,8 @@ static void release_fd_test(size_t num_bytes, size_t slice_size) {
grpc_event_engine::experimental::ChannelArgsEndpointConfig(
grpc_core::ChannelArgs::FromC(&args))),
"test");
GPR_ASSERT(grpc_tcp_fd(ep) == sv[1] && sv[1] >= 0);
CHECK(grpc_tcp_fd(ep) == sv[1]);
CHECK_GE(sv[1], 0);
}
grpc_endpoint_add_to_pollset(ep, g_pollset);

Expand All @@ -551,23 +553,23 @@ static void release_fd_test(size_t num_bytes, size_t slice_size) {
gpr_mu_lock(g_mu);
while (state.read_bytes < state.target_read_bytes) {
grpc_pollset_worker* worker = nullptr;
GPR_ASSERT(GRPC_LOG_IF_ERROR(
"pollset_work", grpc_pollset_work(g_pollset, &worker, deadline)));
CHECK(GRPC_LOG_IF_ERROR("pollset_work",
grpc_pollset_work(g_pollset, &worker, deadline)));
gpr_log(GPR_DEBUG, "wakeup: read=%" PRIdPTR " target=%" PRIdPTR,
state.read_bytes, state.target_read_bytes);
gpr_mu_unlock(g_mu);
grpc_core::ExecCtx::Get()->Flush();
gpr_mu_lock(g_mu);
}
GPR_ASSERT(state.read_bytes == state.target_read_bytes);
CHECK(state.read_bytes == state.target_read_bytes);
gpr_mu_unlock(g_mu);

grpc_slice_buffer_destroy(&state.incoming);
grpc_tcp_destroy_and_release_fd(ep, &fd, &fd_released_cb);
grpc_core::ExecCtx::Get()->Flush();
rel_fd.notify.WaitForNotificationWithTimeout(absl::Seconds(20));
GPR_ASSERT(rel_fd.fd_released_done == 1);
GPR_ASSERT(fd == sv[1]);
CHECK_EQ(rel_fd.fd_released_done, 1);
CHECK(fd == sv[1]);
written_bytes = fill_socket_partial(sv[0], num_bytes);
drain_socket_blocking(fd, written_bytes, written_bytes);
written_bytes = fill_socket_partial(fd, num_bytes);
Expand Down
66 changes: 34 additions & 32 deletions test/core/iomgr/timer_list_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#include <cstdint>
#include <limits>

#include "absl/log/check.h"

#include <grpc/grpc.h>
#include <grpc/support/log.h>

Expand Down Expand Up @@ -78,38 +80,38 @@ static void add_test(void) {
// collect timers. Only the first batch should be ready.
grpc_core::ExecCtx::Get()->TestOnlySetNow(
start + grpc_core::Duration::Milliseconds(500));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
grpc_core::ExecCtx::Get()->Flush();
for (i = 0; i < 20; i++) {
GPR_ASSERT(cb_called[i][1] == (i < 10));
GPR_ASSERT(cb_called[i][0] == 0);
CHECK(cb_called[i][1] == (i < 10));
CHECK_EQ(cb_called[i][0], 0);
}

grpc_core::ExecCtx::Get()->TestOnlySetNow(
start + grpc_core::Duration::Milliseconds(600));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_CHECKED_AND_EMPTY);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_CHECKED_AND_EMPTY);
grpc_core::ExecCtx::Get()->Flush();
for (i = 0; i < 30; i++) {
GPR_ASSERT(cb_called[i][1] == (i < 10));
GPR_ASSERT(cb_called[i][0] == 0);
CHECK(cb_called[i][1] == (i < 10));
CHECK_EQ(cb_called[i][0], 0);
}

// collect the rest of the timers
grpc_core::ExecCtx::Get()->TestOnlySetNow(
start + grpc_core::Duration::Milliseconds(1500));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
grpc_core::ExecCtx::Get()->Flush();
for (i = 0; i < 30; i++) {
GPR_ASSERT(cb_called[i][1] == (i < 20));
GPR_ASSERT(cb_called[i][0] == 0);
CHECK(cb_called[i][1] == (i < 20));
CHECK_EQ(cb_called[i][0], 0);
}

grpc_core::ExecCtx::Get()->TestOnlySetNow(
start + grpc_core::Duration::Milliseconds(1600));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_CHECKED_AND_EMPTY);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_CHECKED_AND_EMPTY);
for (i = 0; i < 30; i++) {
GPR_ASSERT(cb_called[i][1] == (i < 20));
GPR_ASSERT(cb_called[i][0] == 0);
CHECK(cb_called[i][1] == (i < 20));
CHECK_EQ(cb_called[i][0], 0);
}

grpc_timer_list_shutdown();
Expand Down Expand Up @@ -146,19 +148,19 @@ void destruction_test(void) {
GRPC_CLOSURE_CREATE(cb, (void*)(intptr_t)4, grpc_schedule_on_exec_ctx));
grpc_core::ExecCtx::Get()->TestOnlySetNow(
grpc_core::Timestamp::FromMillisecondsAfterProcessEpoch(2));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
grpc_core::ExecCtx::Get()->Flush();
GPR_ASSERT(1 == cb_called[4][1]);
CHECK_EQ(cb_called[4][1], 1);
grpc_timer_cancel(&timers[0]);
grpc_timer_cancel(&timers[3]);
grpc_core::ExecCtx::Get()->Flush();
GPR_ASSERT(1 == cb_called[0][0]);
GPR_ASSERT(1 == cb_called[3][0]);
CHECK_EQ(cb_called[0][0], 1);
CHECK_EQ(cb_called[3][0], 1);

grpc_timer_list_shutdown();
grpc_core::ExecCtx::Get()->Flush();
GPR_ASSERT(1 == cb_called[1][0]);
GPR_ASSERT(1 == cb_called[2][0]);
CHECK_EQ(cb_called[1][0], 1);
CHECK_EQ(cb_called[2][0], 1);
}

// Cleans up a list with pending timers that simulate long-running-services.
Expand All @@ -180,7 +182,7 @@ void long_running_service_cleanup_test(void) {
gpr_log(GPR_INFO, "long_running_service_cleanup_test");

grpc_core::Timestamp now = grpc_core::Timestamp::Now();
GPR_ASSERT(now.milliseconds_after_process_epoch() >= k25Days.millis());
CHECK(now.milliseconds_after_process_epoch() >= k25Days.millis());
grpc_timer_list_init();
grpc_core::testing::grpc_tracer_enable_flag(&grpc_timer_trace);
grpc_core::testing::grpc_tracer_enable_flag(&grpc_timer_check_trace);
Expand Down Expand Up @@ -209,24 +211,24 @@ void long_running_service_cleanup_test(void) {

grpc_core::ExecCtx::Get()->TestOnlySetNow(
now + grpc_core::Duration::Milliseconds(4));
GPR_ASSERT(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
CHECK(grpc_timer_check(nullptr) == GRPC_TIMERS_FIRED);
grpc_core::ExecCtx::Get()->Flush();
GPR_ASSERT(0 == cb_called[0][0]); // Timer 0 not called
GPR_ASSERT(0 == cb_called[0][1]);
GPR_ASSERT(0 == cb_called[1][0]);
GPR_ASSERT(1 == cb_called[1][1]); // Timer 1 fired
GPR_ASSERT(0 == cb_called[2][0]); // Timer 2 not called
GPR_ASSERT(0 == cb_called[2][1]);
GPR_ASSERT(0 == cb_called[3][0]); // Timer 3 not called
GPR_ASSERT(0 == cb_called[3][1]);
CHECK_EQ(cb_called[0][0], 0); // Timer 0 not called
CHECK_EQ(cb_called[0][1], 0);
CHECK_EQ(cb_called[1][0], 0);
CHECK_EQ(cb_called[1][1], 1); // Timer 1 fired
CHECK_EQ(cb_called[2][0], 0); // Timer 2 not called
CHECK_EQ(cb_called[2][1], 0);
CHECK_EQ(cb_called[3][0], 0); // Timer 3 not called
CHECK_EQ(cb_called[3][1], 0);

grpc_timer_list_shutdown();
grpc_core::ExecCtx::Get()->Flush();
// Timers 0, 2, and 3 were fired with an error during cleanup
GPR_ASSERT(1 == cb_called[0][0]);
GPR_ASSERT(0 == cb_called[1][0]);
GPR_ASSERT(1 == cb_called[2][0]);
GPR_ASSERT(1 == cb_called[3][0]);
CHECK_EQ(cb_called[0][0], 1);
CHECK_EQ(cb_called[1][0], 0);
CHECK_EQ(cb_called[2][0], 1);
CHECK_EQ(cb_called[3][0], 1);
}

int main(int argc, char** argv) {
Expand Down

0 comments on commit 82718c4

Please sign in to comment.