[CBRD-25312] Modify diagdb utility to accept a class-name parameter

msg/en_US/utils.msg

@@ -837,6 +837,7 @@ valid options:\n\
                                 9 dump heap\n
 
 
+
 $set 25 MSGCAT_UTIL_SET_LOCKDB
 15 Couldn't open output file '%1$s'\n
 59 lockdb cannot run as standalone mode.\n

src/executables/util_admin.c

@@ -319,6 +319,7 @@ static UTIL_ARG_MAP ua_Diag_Option_Map[] = {
   {DIAG_DUMP_RECORDS_S, {ARG_BOOLEAN}, {0}},
   {DIAG_OUTPUT_FILE_S, {ARG_STRING}, {0}},
   {DIAG_EMERGENCY_S, {ARG_BOOLEAN}, {0}},
+  {DIAG_CLASS_NAME_S, {ARG_STRING}, {0}},
   {0, {0}, {0}}
 };
 
@@ -327,6 +328,7 @@ static GETOPT_LONG ua_Diag_Option[] = {
   {DIAG_DUMP_RECORDS_L, 0, 0, DIAG_DUMP_RECORDS_S},
   {DIAG_OUTPUT_FILE_L, 1, 0, DIAG_OUTPUT_FILE_S},
   {DIAG_EMERGENCY_L, 0, 0, DIAG_EMERGENCY_S},
+  {DIAG_CLASS_NAME_L, 1, 0, DIAG_CLASS_NAME_S},
   {0, 0, 0, 0}
 };
 

src/executables/util_sa.c

@@ -1531,6 +1531,7 @@ diagdb (UTIL_FUNCTION_ARG * arg)
   char er_msg_file[PATH_MAX];
   const char *db_name;
   const char *output_file = NULL;
+  const char *class_name;
   FILE *outfp = NULL;
   bool is_emergency = false;
   DIAGDUMP_TYPE diag;
@@ -1565,13 +1566,17 @@ diagdb (UTIL_FUNCTION_ARG * arg)
 	}
     }
 
+  class_name = utility_get_option_string_value (arg_map, DIAG_CLASS_NAME_S, 0);
   diag = (DIAGDUMP_TYPE) utility_get_option_int_value (arg_map, DIAG_DUMP_TYPE_S);
 
   if (diag != DIAGDUMP_LOG && utility_get_option_string_table_size (arg_map) != 1)
     {
       goto print_diag_usage;
     }
-
+  if (diag == DIAGDUMP_ALL && class_name != NULL)
+    {
+      goto print_diag_usage;
+    }
   if (check_database_name (db_name))
     {
       goto error_exit;
@@ -1716,10 +1721,26 @@ diagdb (UTIL_FUNCTION_ARG * arg)
   if (diag == DIAGDUMP_ALL || diag == DIAGDUMP_HEAP)
     {
       bool dump_records;
-      /* this dumps the contents of all heaps */
       dump_records = utility_get_option_bool_value (arg_map, DIAG_DUMP_RECORDS_S);
-      fprintf (outfp, "\n*** DUMP OF ALL HEAPS ***\n");
-      (void) file_tracker_dump_all_heap (thread_p, outfp, dump_records);
+
+      if (class_name == NULL)
+	{
+	  fprintf (outfp, "\n*** DUMP OF ALL HEAPS ***\n");
+	  (void) file_tracker_dump_all_heap (thread_p, outfp, dump_records);
+	}
+      else
+	{
+	  assert (diag != DIAGDUMP_ALL);
+	  if (!sm_check_system_class_by_name (class_name))
+	    {
+	      if (utility_check_class_name (class_name) != NO_ERROR)
+		{
+		  goto error_exit;
+		}
+	    }
+	  fprintf (outfp, "\n*** DUMP HEAP OF %s ***\n", class_name);
+	  heap_dump_specific_file (thread_p, outfp, dump_records, class_name);
+	}
     }
 
   db_shutdown ();

src/executables/utility.h

@@ -1197,6 +1197,8 @@ typedef struct _ha_config
 #define DIAG_OUTPUT_FILE_L                      "output-file"
 #define DIAG_EMERGENCY_S                        11202
 #define DIAG_EMERGENCY_L                        "emergency"
+#define DIAG_CLASS_NAME_S                       'c'
+#define DIAG_CLASS_NAME_L                       "class-name"
 
 /* patch option list */
 #define PATCH_RECREATE_LOG_S                    'r'

src/storage/heap_file.c

@@ -14507,6 +14507,22 @@ heap_dump (THREAD_ENTRY * thread_p, FILE * fp, HFID * hfid, bool dump_records)
   fprintf (fp, "\n\n*** END OF DUMP FOR HEAP FILE ***\n\n");
 }
 
+/*
+ * heap_dump_specific_file () - dump a specific heap file with class name
+ *
+ * return            :
+ * thread_p (in)     : thread entry
+ * fp (in)           : output file
+ * dump_records (in) : true to dump records
+ * class_name (in)   : name of class to dump
+ */
+void
+heap_dump_specific_file (THREAD_ENTRY * thread_p, FILE * fp, bool dump_records, const char *class_name)
+{
+  /* todo: Fetch HFID of class which corresponds to class_name, and dump heap file by HFID. Will be handled at CBRD-25313 and CBRD-25314. */
+  fprintf (fp, "\n\n*** DUMP A CLASS NAMED %s ***\n\n", class_name);
+}
+
 /*
  * heap_dump_capacity () - dump heap file capacity
  *

src/storage/heap_file.h

@@ -554,6 +554,7 @@ extern int heap_set_autoincrement_value (THREAD_ENTRY * thread_p, HEAP_CACHE_ATT
 					 HEAP_SCANCACHE * scan_cache, int *is_set);
 
 extern void heap_dump (THREAD_ENTRY * thread_p, FILE * fp, HFID * hfid, bool dump_records);
+extern void heap_dump_specific_file (THREAD_ENTRY * thread_p, FILE * fp, bool dump_records, const char *class_name);
 extern void heap_attrinfo_dump (THREAD_ENTRY * thread_p, FILE * fp, HEAP_CACHE_ATTRINFO * attr_info, bool dump_schema);
 #if defined (CUBRID_DEBUG)
 extern void heap_chnguess_dump (FILE * fp);