[#25746] DocDB: Support use of version_info.proto in RPC messages

Summary: Switch `version_info.proto` to use `YRPC_GENERATE` so that it can be used in RPC messages. Moving `version_info.proto`, `version_info.cc` and `init.cc` to `yb_common` lib since `YRPC_GENERATE` depends on `yb_util` lib. Fixes #25746 Jira: DB-15027 Test Plan: Jenkins Reviewers: sergei, asrivastava Reviewed By: sergei Subscribers: esheng, ybase, yql Differential Revision: https://phorge.dev.yugabyte.com/D41470
yugabyte · Jan 25, 2025 · 6281c17 · 6281c17
1 parent 69b5f97
commit 6281c17
Show file tree

Hide file tree

Showing 45 changed files with 64 additions and 98 deletions.
diff --git a/src/yb/client/client.cc b/src/yb/client/client.cc
@@ -64,18 +64,20 @@
 #include "yb/client/tablet_server.h"
 #include "yb/client/yb_table_name.h"
 
-#include "yb/common/common.pb.h"
 #include "yb/common/common_flags.h"
 #include "yb/common/common_util.h"
+#include "yb/common/common.pb.h"
 #include "yb/common/entity_ids.h"
-#include "yb/common/wire_protocol.h"
-#include "yb/dockv/partition.h"
+#include "yb/common/init.h"
 #include "yb/common/pg_types.h"
 #include "yb/common/ql_type.h"
 #include "yb/common/roles_permissions.h"
+#include "yb/common/schema_pbutil.h"
 #include "yb/common/schema.h"
 #include "yb/common/transaction.h"
-#include "yb/common/schema_pbutil.h"
+#include "yb/common/wire_protocol.h"
+
+#include "yb/dockv/partition.h"
 
 #include "yb/gutil/bind.h"
 #include "yb/gutil/map-util.h"
@@ -104,7 +106,6 @@
 #include "yb/util/debug-util.h"
 #include "yb/util/flags.h"
 #include "yb/util/format.h"
-#include "yb/util/init.h"
 #include "yb/util/logging.h"
 #include "yb/util/logging_callback.h"
 #include "yb/util/mem_tracker.h"

diff --git a/src/yb/client/client_pch.h b/src/yb/client/client_pch.h
@@ -242,7 +242,6 @@
 #include "yb/util/hash_util.h"
 #include "yb/util/hdr_histogram.h"
 #include "yb/util/high_water_mark.h"
-#include "yb/util/init.h"
 #include "yb/util/io.h"
 #include "yb/util/jsonreader.h"
 #include "yb/util/jsonwriter.h"
@@ -334,8 +333,6 @@
 #include "yb/util/unique_lock.h"
 #include "yb/util/uuid.h"
 #include "yb/util/varint.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
 #include "yb/util/version_tracker.h"
 #include "yb/util/web_callback_registry.h"
 #include "yb/util/write_buffer.h"

diff --git a/src/yb/common/CMakeLists.txt b/src/yb/common/CMakeLists.txt
@@ -47,6 +47,7 @@ YRPC_GENERATE(
       ql_protocol.proto
       transaction.proto
       value.proto
+      version_info.proto
       wire_protocol.proto
   )
 ADD_YB_LIBRARY(yb_common_proto
@@ -88,6 +89,7 @@ set(COMMON_SRCS
   hybrid_time.cc
   doc_hybrid_time.cc # must be after hybrid_time.cc
   id_mapping.cc
+  init.cc
   key_encoder.cc
   opid.cc
   pgsql_error.cc
@@ -107,6 +109,7 @@ set(COMMON_SRCS
   transaction_error.cc
   wire_protocol.cc
   llvm_profile_dumper.cc
+  version_info.cc
   xcluster_util.cc
   ysql_utils.cc
   )

diff --git a/src/yb/common/common_pch.h b/src/yb/common/common_pch.h
@@ -206,7 +206,6 @@
 #include "yb/util/format.h"
 #include "yb/util/hdr_histogram.h"
 #include "yb/util/high_water_mark.h"
-#include "yb/util/init.h"
 #include "yb/util/io.h"
 #include "yb/util/jsonwriter.h"
 #include "yb/util/kv_util.h"

diff --git a/src/yb/util/init.cc → src/yb/common/init.cc b/src/yb/util/init.cc → src/yb/common/init.cc
@@ -30,22 +30,20 @@
 // under the License.
 //
 
-#include "yb/util/init.h"
+#include "yb/common/init.h"
 
-#include <signal.h>
 #include <string>
 
 #include "yb/gutil/cpu.h"
 #include "yb/gutil/strings/split.h"
 #include "yb/gutil/strings/substitute.h"
 #include "yb/util/env.h"
 #include "yb/util/env_util.h"
-#include "yb/util/errno.h"
 #include "yb/util/flags.h"
 #include "yb/util/logging.h"
 #include "yb/util/path_util.h"
 #include "yb/util/status.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 #if defined(__linux__)
 #include <sys/prctl.h>
@@ -61,8 +59,26 @@ DEFINE_NON_RUNTIME_bool(stop_on_parent_termination, false,
     "When specified, this process will terminate when parent process terminates."
     "Linux-only.");
 
+DECLARE_bool(version);
+TAG_FLAG(version, stable);
+
 namespace yb {
 
+namespace {
+
+void ShowVersionAndExit() {
+  if (!FLAGS_version) {
+    return;
+  }
+  std::cout << VersionInfo::GetShortVersionString() << std::endl;
+  exit(0);
+}
+// REGISTER_CALLBACK cannot be used since this flag is defined in the gflags library.
+auto show_version_callback = flags_callback_internal::RegisterGlobalFlagUpdateCallback(
+    &FLAGS_version, "ShowVersionAndExit", &ShowVersionAndExit);
+
+}  // namespace
+
 const char* kTopLevelDataDirName = "yb-data";
 
 Status BadCPUStatus(const base::CPU& cpu, const char* instruction_set) {
@@ -127,14 +143,6 @@ void SetGLogHeader(const std::string& server_info) {
   google::SetApplicationFingerprint(VersionInfo::GetShortVersionString() + server_info);
 }
 
-Status InstallSignalHandler(int signum, void (*handler)(int)) {
-  struct sigaction sig_action{};
-  sig_action.sa_handler = handler;
-  return STATUS_FROM_ERRNO_IF_NONZERO_RV(
-      Format("InstallSignalHandler failed for signal $0 ($1)", signum, strsignal(signum)),
-      sigaction(signum, &sig_action, nullptr));
-}
-
 Status InitYB(const std::string &server_type, const char* argv0) {
 #if defined(__linux__)
   if (FLAGS_stop_on_parent_termination) {

diff --git a/src/yb/util/init.h → src/yb/common/init.h b/src/yb/util/init.h → src/yb/common/init.h
@@ -48,9 +48,6 @@ Status SetupLogDir(const std::string& server_type);
 
 void SetGLogHeader(const std::string& server_info = "");
 
-// Installs signal handler. Safe to call before glog is initialized. This is not thread safe.
-Status InstallSignalHandler(int signum, void (*handler)(int));
-
 // Initialize YB, checking that the platform we are running on is supported, etc.
 // Issues a FATAL log message if we fail to init.
 // argv0 is passed to InitGoogleLoggingSafe.

diff --git a/src/yb/common/termination_monitor.cc b/src/yb/common/termination_monitor.cc
@@ -16,7 +16,7 @@
 
 #include "yb/util/callsite_profiling.h"
 #include "yb/util/flags.h"
-#include "yb/util/init.h"
+#include "yb/util/signal_util.h"
 #include "yb/util/thread.h"
 
 DECLARE_bool(TEST_running_test);

diff --git a/src/yb/util/version_info.cc → src/yb/common/version_info.cc b/src/yb/util/version_info.cc → src/yb/common/version_info.cc
@@ -30,7 +30,7 @@
 // under the License.
 //
 
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 #include <fstream>
 #include <string>

diff --git a/src/yb/util/version_info.h → src/yb/common/version_info.h b/src/yb/util/version_info.h → src/yb/common/version_info.h
@@ -37,7 +37,7 @@
 #include "yb/gutil/macros.h"
 
 #include "yb/util/status_fwd.h"
-#include "yb/util/version_info.pb.h"
+#include "yb/common/version_info.pb.h"
 
 namespace yb {
 

diff --git a/src/yb/util/version_info.proto → src/yb/common/version_info.proto b/src/yb/util/version_info.proto → src/yb/common/version_info.proto
diff --git a/src/yb/integration-tests/auto_flags-itest.cc b/src/yb/integration-tests/auto_flags-itest.cc
@@ -36,7 +36,7 @@
 
 #include "yb/util/flags.h"
 #include "yb/util/backoff_waiter.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 DECLARE_bool(TEST_auto_flags_initialized);
 DECLARE_bool(TEST_auto_flags_new_install);

diff --git a/src/yb/integration-tests/integration-tests_pch.h b/src/yb/integration-tests/integration-tests_pch.h
@@ -362,8 +362,6 @@
 #include "yb/util/unique_lock.h"
 #include "yb/util/uuid.h"
 #include "yb/util/varint.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
 #include "yb/util/version_tracker.h"
 #include "yb/util/web_callback_registry.h"
 #include "yb/util/write_buffer.h"

diff --git a/src/yb/integration-tests/upgrade-tests/upgrade_test_base.cc b/src/yb/integration-tests/upgrade-tests/upgrade_test_base.cc
@@ -23,7 +23,7 @@
 #include "yb/util/debug.h"
 #include "yb/util/env_util.h"
 #include "yb/util/scope_exit.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 #include "yb/yql/pgwrapper/libpq_utils.h"
 
 #include "yb/server/server_base.pb.h"

diff --git a/src/yb/integration-tests/upgrade-tests/upgrade_test_base.h b/src/yb/integration-tests/upgrade-tests/upgrade_test_base.h
@@ -15,7 +15,7 @@
 
 #include "yb/integration-tests/external_mini_cluster-itest-base.h"
 #include "yb/util/test_thread_holder.h"
-#include "yb/util/version_info.pb.h"
+#include "yb/common/version_info.pb.h"
 
 namespace yb {
 

diff --git a/src/yb/master/CMakeLists.txt b/src/yb/master/CMakeLists.txt
@@ -199,7 +199,6 @@ set(MASTER_DEPS
   ${MASTER_PROTO_LIBS}
   rpc_header_proto
   master_util
-  version_info_proto
   yb_pggate_flags
   yb_pggate
   cdc_util

diff --git a/src/yb/master/master-path-handlers.cc b/src/yb/master/master-path-handlers.cc
@@ -94,8 +94,7 @@
 #include "yb/util/string_case.h"
 #include "yb/util/timestamp.h"
 #include "yb/util/url-coding.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
+#include "yb/common/version_info.h"
 
 DEFINE_RUNTIME_int32(
     hide_dead_node_threshold_mins, 60 * 24,

diff --git a/src/yb/master/master_main.cc b/src/yb/master/master_main.cc
@@ -46,7 +46,6 @@
 #include "yb/server/total_mem_watcher.h"
 
 #include "yb/util/flags.h"
-#include "yb/util/init.h"
 #include "yb/util/logging.h"
 #include "yb/util/main_util.h"
 #include "yb/util/mem_tracker.h"

diff --git a/src/yb/master/master_pch.h b/src/yb/master/master_pch.h
@@ -364,8 +364,6 @@
 #include "yb/util/user.h"
 #include "yb/util/uuid.h"
 #include "yb/util/varint.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
 #include "yb/util/version_tracker.h"
 #include "yb/util/web_callback_registry.h"
 #include "yb/util/write_buffer.h"

diff --git a/src/yb/master/sys_catalog-test.cc b/src/yb/master/sys_catalog-test.cc
@@ -51,7 +51,7 @@
 #include "yb/util/backoff_waiter.h"
 #include "yb/util/net/sockaddr.h"
 #include "yb/util/status.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 using namespace std::literals;
 

diff --git a/src/yb/master/ysql/ysql_catalog_config.cc b/src/yb/master/ysql/ysql_catalog_config.cc
@@ -19,7 +19,7 @@
 
 #include "yb/master/catalog_entity_info.h"
 #include "yb/util/is_operation_done_result.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 DECLARE_bool(log_ysql_catalog_versions);
 

diff --git a/src/yb/master/ysql/ysql_initdb_major_upgrade_handler.cc b/src/yb/master/ysql/ysql_initdb_major_upgrade_handler.cc
@@ -26,7 +26,7 @@
 #include "yb/util/pg_util.h"
 #include "yb/util/scope_exit.h"
 #include "yb/util/status.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 #include "yb/yql/pgwrapper/pg_wrapper.h"
 

diff --git a/src/yb/rocksdb/rocksdb_pch.h b/src/yb/rocksdb/rocksdb_pch.h
@@ -224,5 +224,3 @@
 #include "yb/util/tsan_util.h"
 #include "yb/util/type_traits.h"
 #include "yb/util/ulimit.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
diff --git a/src/yb/rocksdb/util/options_parser.cc b/src/yb/rocksdb/util/options_parser.cc
@@ -34,7 +34,7 @@
 #include "yb/util/status_log.h"
 #include "yb/util/string_util.h"
 #include "yb/util/sync_point.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 namespace rocksdb {
 

diff --git a/src/yb/server/CMakeLists.txt b/src/yb/server/CMakeLists.txt
@@ -77,8 +77,7 @@ target_link_libraries(server_base_proto
   yrpc
   yb_common_proto
   protobuf
-  rpc_header_proto
-  version_info_proto)
+  rpc_header_proto)
 
 #########################################
 # server_process

diff --git a/src/yb/server/auto_flags_manager_base.cc b/src/yb/server/auto_flags_manager_base.cc
@@ -27,7 +27,7 @@
 #include "yb/util/logging.h"
 #include "yb/util/source_location.h"
 #include "yb/util/thread_restrictions.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 DEFINE_NON_RUNTIME_bool(disable_auto_flags_management, false,
     "Disables AutoFlags management. A safety switch to turn off automatic promotion of AutoFlags. "

diff --git a/src/yb/server/call_home.cc b/src/yb/server/call_home.cc
@@ -31,7 +31,7 @@
 #include "yb/util/metrics.h"
 #include "yb/util/result.h"
 #include "yb/util/user.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 using std::string;
 using std::vector;

diff --git a/src/yb/server/default-path-handlers.cc b/src/yb/server/default-path-handlers.cc
@@ -86,8 +86,7 @@
 #include "yb/util/status_log.h"
 #include "yb/util/stack_trace_tracker.h"
 #include "yb/util/url-coding.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
+#include "yb/common/version_info.h"
 
 DEFINE_RUNTIME_uint64(web_log_bytes, 1024 * 1024,
     "The maximum number of bytes to display on the debug webserver's log page");

diff --git a/src/yb/server/server_base.cc b/src/yb/server/server_base.cc
@@ -85,7 +85,7 @@
 #include "yb/util/status_log.h"
 #include "yb/util/timestamp.h"
 #include "yb/util/thread.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 #include "yb/util/tcmalloc_util.h"
 
 DEFINE_UNKNOWN_int32(num_reactor_threads, -1,

diff --git a/src/yb/server/server_base.proto b/src/yb/server/server_base.proto
@@ -37,7 +37,7 @@ option java_package = "org.yb.server";
 
 import "yb/common/common_net.proto";
 import "yb/common/wire_protocol.proto";
-import "yb/util/version_info.proto";
+import "yb/common/version_info.proto";
 
 // The status information dumped by a server after it starts.
 //

diff --git a/src/yb/server/server_pch.h b/src/yb/server/server_pch.h
@@ -274,7 +274,5 @@
 #include "yb/util/user.h"
 #include "yb/util/uuid.h"
 #include "yb/util/varint.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
 #include "yb/util/web_callback_registry.h"
 #include "yb/util/zlib.h"
diff --git a/src/yb/tools/sys-catalog-tool.cc b/src/yb/tools/sys-catalog-tool.cc
@@ -42,7 +42,7 @@
 #include "yb/util/pb_util.h"
 #include "yb/util/string_trim.h"
 #include "yb/util/string_util.h"
-#include "yb/util/version_info.h"
+#include "yb/common/version_info.h"
 
 DEFINE_RUNTIME_bool(show_raw_id, false, "Print binary id in raw format also");
 

diff --git a/src/yb/tools/tools_pch.h b/src/yb/tools/tools_pch.h
@@ -336,8 +336,6 @@
 #include "yb/util/ulimit.h"
 #include "yb/util/uuid.h"
 #include "yb/util/varint.h"
-#include "yb/util/version_info.h"
-#include "yb/util/version_info.pb.h"
 #include "yb/util/web_callback_registry.h"
 #include "yb/util/write_buffer.h"
 #include "yb/util/yb_partition.h"
diff --git a/src/yb/tserver/db_server_base.cc b/src/yb/tserver/db_server_base.cc
@@ -17,15 +17,15 @@
 #include "yb/client/transaction_manager.h"
 #include "yb/client/transaction_pool.h"
 
+#include "yb/common/init.h"
+
 #include "yb/server/async_client_initializer.h"
 #include "yb/server/clock.h"
 
 #include "yb/tserver/tserver_util_fwd.h"
 #include "yb/tserver/tserver_shared_mem.h"
 
-#include "yb/util/init.h"
 #include "yb/util/mem_tracker.h"
-#include "yb/util/scope_exit.h"
 #include "yb/util/shared_mem.h"
 #include "yb/util/status_log.h"