hv/hv_kvp_daemon: Enable debug logs for hv_kvp_daemon
Subsystems (2)
PATCH v4 1/1 hv/hv_kvp_daemon: Enable debug logs for hv_kvp_daemon
Allow the KVP daemon to log the KVP updates triggered in the VM with a new debug flag(-d).
When the daemon is started with this flag, it logs updates and debug information in syslog with loglevel LOG_DEBUG. This information comes in handy for debugging issues where the key-value pairs for certain pools show mismatch/incorrect values.
The distro-vendors can further consume these changes and modify the respective service files to redirect the logs to specific files as needed.
---
Changes in v4:
* renamed the debug option from "debug_enabled" to "debug"
* shorten a debug message by removing unnecessary strings
---
Changes in v3:
* remove timestamp from raw message
* use i+1 instead of i while printing record array
* add debug logs in delete operation
---
Changes in v2:
* log the debug logs in syslog(debug) instead of a seperate file that we will have to maintain.
* fix the commit message to indicate the same.
--- tools/hv/hv_kvp_daemon.c | 65 ++++++++++++++++++++++++++++++++++++---- 1 file changed, 60 insertions(+), 5 deletions(-)
tools/hv/hv_kvp_daemon.c +59 -5
@@ -83,6 +83,7 @@ enum { };static int in_hand_shake; +static int debug;static char *os_name ="" ;static char *os_major ="" ;
@@ -183,6 +184,20 @@ static void kvp_update_file(int pool)kvp_release_lock (pool); } +static void kvp_dump_initial_pools (int pool) +{ +int i; + +syslog (LOG_DEBUG ,"===Start dumping the contents of pool %d ===\n" , + pool); + +for (i =0 ; i < kvp_file_info[pool].num_records; i++) +syslog (LOG_DEBUG ,"pool: %d, %d/%d key=%s val=%s\n" , + pool, i +1 , kvp_file_info[pool].num_records, + kvp_file_info[pool].records[i].key, + kvp_file_info[pool].records[i].value); +} +static void kvp_update_mem_state (int pool) {FILE *filep;
@@ -270,6 +285,8 @@ static int kvp_file_init(void)return 1 ; kvp_file_info[i].num_records =0 ;kvp_update_mem_state (i); +if (debug) +kvp_dump_initial_pools (i); }return 0 ;
@@ -297,6 +314,9 @@ static int kvp_key_delete(int pool, const __u8 *key, int key_size)* Found a match; just move the remaining * entries up. */ +if (debug) +syslog (LOG_DEBUG ,"%s: deleting the KVP: pool=%d key=%s val=%s" , + __func__, pool, record[i].key, record[i].value);if (i == (num_records -1 )) { kvp_file_info[pool].num_records--;kvp_update_file (pool);
@@ -315,20 +335,36 @@ static int kvp_key_delete(int pool, const __u8 *key, int key_size)kvp_update_file (pool);return 0 ; } + +if (debug) +syslog (LOG_DEBUG ,"%s: could not delete KVP: pool=%d key=%s. Record not found" , + __func__, pool, key); +return 1 ; }static int kvp_key_add_or_modify (int pool,const __u8 *key,int key_size,const __u8 *value,int value_size) { -int i; -int num_records;struct kvp_record *record; +int num_records;int num_blocks; +int i; + +if (debug) +syslog (LOG_DEBUG ,"%s: got a KVP: pool=%d key=%s val=%s" , + __func__, pool, key, value);if ((key_size >HV_KVP_EXCHANGE_MAX_KEY_SIZE ) || - (value_size >HV_KVP_EXCHANGE_MAX_VALUE_SIZE )) + (value_size >HV_KVP_EXCHANGE_MAX_VALUE_SIZE )) { +syslog (LOG_ERR ,"%s: Too long key or value: key=%s, val=%s" , + __func__, key, value); + +if (debug) +syslog (LOG_DEBUG ,"%s: Too long key or value: pool=%d, key=%s, val=%s" , + __func__, pool, key, value);return 1 ; + }/* * First update the in-memory state.
@@ -348,6 +384,9 @@ static int kvp_key_add_or_modify(int pool, const __u8 *key, int key_size,*/ memcpy (record[i].value, value, value_size);kvp_update_file (pool); +if (debug) +syslog (LOG_DEBUG ,"%s: updated: pool=%d key=%s val=%s" , + __func__, pool, key, value);return 0 ; }
@@ -359,8 +398,10 @@ static int kvp_key_add_or_modify(int pool, const __u8 *key, int key_size, record =realloc (record,sizeof (struct kvp_record ) *ENTRIES_PER_BLOCK * (num_blocks +1 )); -if (record ==NULL ) +if (!record) { +syslog (LOG_ERR ,"%s: Memory alloc failure" , __func__);return 1 ; + } kvp_file_info[pool].num_blocks++; }
@@ -368,6 +409,11 @@ static int kvp_key_add_or_modify(int pool, const __u8 *key, int key_size,memcpy (record[i].key, key, key_size); kvp_file_info[pool].records = record; kvp_file_info[pool].num_records++; + +if (debug) +syslog (LOG_DEBUG ,"%s: added: pool=%d key=%s val=%s" , + __func__, pool, key, value); +kvp_update_file (pool);return 0 ; }
@@ -1662,6 +1708,7 @@ void print_usage(char *argv[])fprintf (stderr,"Usage: %s [options]\n" "Options are:\n" " -n, --no-daemon stay in foreground, don't daemonize\n" +" -d, --debug Enable debug logs(syslog debug by default)\n" " -h, --help print this help\n" , argv[0 ]); }
@@ -1683,10 +1730,11 @@ int main(int argc, char *argv[])static struct option long_options[] = { {"help" , no_argument,0 ,'h' }, {"no-daemon" , no_argument,0 ,'n' }, + {"debug" , no_argument,0 ,'d' }, {0 ,0 ,0 ,0 } }; -while ((opt =getopt_long (argc, argv,"hn" , long_options, +while ((opt =getopt_long (argc, argv,"hnd" , long_options, &long_index)) !=-1 ) {switch (opt) {case 'n' :
@@ -1695,6 +1743,9 @@ int main(int argc, char *argv[])case 'h' :print_usage (argv);exit (0 ); +case 'd' : + debug =1 ; +break ;default :print_usage (argv);exit (EXIT_FAILURE );
@@ -1717,6 +1768,9 @@ int main(int argc, char *argv[])*/ kvp_get_domain_name (full_domain_name,sizeof (full_domain_name)); +if (debug) +syslog (LOG_INFO ,"Logging debug info in syslog(debug)" ); +if (kvp_file_init ()) {syslog (LOG_ERR ,"Failed to initialize the pools" );exit (EXIT_FAILURE );
Signature · 1 line
2.34.1
Quoted 10 lines · Shradha Gupta
Allow the KVP daemon to log the KVP updates triggered in the VM with a new debug flag(-d).
When the daemon is started with this flag, it logs updates and debug information in syslog with loglevelLOG_DEBUG. This information comes in handy for debugging issues where the key-value pairs for certain pools show mismatch/incorrect values.
The distro-vendors can further consume these changes and modify the respective service files to redirect the logs to specific files as needed.
Quoted 3 lines
Signed-off-by Shradha Gupta <[email protected]>Reviewed-by Naman Jain <[email protected]>Reviewed-by Dexuan Cui <[email protected]>
Applied to hyperv-next. I change the prefix a bit to shorten the subject line.
Tue, 15 Apr 2025 04:19:38 -0700 Shradha Gupta <[email protected]>:
Quoted 6 lines
static int kvp_key_add_or_modify(int pool, const
__u8*key, intkey_size,tools/hv/hv_kvp_daemon.c +3
-0+if (debug) +syslog (LOG_DEBUG ,"%s: got a KVP: pool=%d key=%s val=%s" , + __func__, pool, key, value); if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||
tools/hv/hv_kvp_daemon.c static int kvp_key_delete(int pool, const __u8 *key, int key_size) · line 367
Quoted 10 lines
tools/hv/hv_kvp_daemon.c +8
-1- (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE)) + (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE)) { +syslog (LOG_ERR ,"%s: Too long key or value: key=%s, val=%s" , + __func__, key, value); + +if (debug) +syslog (LOG_DEBUG ,"%s: Too long key or value: pool=%d, key=%s, val=%s" , + __func__, pool, key, value);return 1 ; + }
I think this is logging three times in case of an error.
Maybe move the debug case after the size check, and change the LOG_ERR case to show all details just once?
Olaf
Quoted 23 lines · Olaf Hering
Tue, 15 Apr 2025 04:19:38 -0700 Shradha Gupta <[email protected]>:
Quoted 6 lines
static int kvp_key_add_or_modify(int pool, const
__u8*key, intkey_size,tools/hv/hv_kvp_daemon.c +3
-0+if (debug) +syslog (LOG_DEBUG ,"%s: got a KVP: pool=%d key=%s val=%s" , + __func__, pool, key, value); if ((key_size > HV_KVP_EXCHANGE_MAX_KEY_SIZE) ||tools/hv/hv_kvp_daemon.c static int kvp_key_delete(int pool, const __u8 *key, int key_size) · line 367
Quoted 10 lines
tools/hv/hv_kvp_daemon.c +8
-1- (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE)) + (value_size > HV_KVP_EXCHANGE_MAX_VALUE_SIZE)) { +syslog (LOG_ERR ,"%s: Too long key or value: key=%s, val=%s" , + __func__, key, value); + +if (debug) +syslog (LOG_DEBUG ,"%s: Too long key or value: pool=%d, key=%s, val=%s" , + __func__, pool, key, value);return 1 ; + }I think this is logging three times in case of an error.
Maybe move the debug case after the size check, and change theLOG_ERRcase to show all details just once?
Quoted 1 line
Olaf
Thanks Olaf. That makes sense. Let me send out another patch to address this.