Skip to contentSkip to conversation

cmd logging

PATCH New Thomas Woerner 1 participant 2 messages Jul 15, 2009

lore
Share & tools
lore
#0 lore raw

cover cmd logging

This patch series add functions to add an error message and the error code to the command context. This is needed for liblvm to be able to have handle specific error reporting.

The first patch add the needed functions and corrects some code to use a script to add the error code to all log_error and log_err functions. It replaces all log_err calls with log_error. The result is the second patch.

The script:

	find . -name "*.[hc]" -exec perl -pi -e "s/log_error\(\"/log_error\(LVM_GEN_ERR, \"/g" {} \;
	find . -name "*.[hc]" -exec perl -pi -e "s/log_err\(\"/log_error\(LVM_GEN_ERR, \"/g" {} \;
	find . -name "*.[hc]" -exec perl -pi -e "s/log_error\(no_space\)/log_error\(LVM_GEN_ERR, no_space\)/g" {} \;
	perl -pi -e "s/log_error\(bad,/log_error\(LVM_GEN_ERR, bad,/g" lib/format_text/import_vsn1.c

Thomas Woerner (2):
Add cmd logging for liblvm error reporting: All logging functions
have an additional argument: The error code
Add error code for all log_err and log_error calls.

 daemons/clvmd/clvmd-cman.c            |    8 +-
 daemons/clvmd/clvmd-command.c         |    2 +-
 daemons/clvmd/clvmd-gulm.c            |    4 +-
 daemons/clvmd/clvmd.c                 |   26 ++--
 daemons/clvmd/lvm-functions.c         |   15 ++-
 daemons/dmeventd/libdevmapper-event.c |   50 +++---
 lib/activate/activate.c               |   26 ++--
 lib/activate/dev_manager.c            |   64 ++++----
 lib/activate/fs.c                     |   24 ++--
 lib/cache/lvmcache.c                  |   70 +++++-----
 lib/commands/toolcontext.c            |  114 +++++++-------
 lib/commands/toolcontext.h            |    6 +
 lib/config/config.c                   |   38 +++---
 lib/device/dev-cache.c                |   50 +++---
 lib/device/dev-io.c                   |   22 ++--
 lib/device/dev-md.c                   |    8 +-
 lib/device/device.c                   |   12 +-
 lib/display/display.c                 |    4 +-
 lib/error/errseg.c                    |    2 +-
 lib/filters/filter-composite.c        |    4 +-
 lib/filters/filter-md.c               |    2 +-
 lib/filters/filter-persistent.c       |    6 +-
 lib/filters/filter-regex.c            |    4 +-
 lib/filters/filter-sysfs.c            |   10 +-
 lib/filters/filter.c                  |   10 +-
 lib/format1/disk-rep.c                |   30 ++--
 lib/format1/format1.c                 |   22 ++--
 lib/format1/import-export.c           |   22 ++--
 lib/format1/import-extents.c          |   24 ++--
 lib/format1/layout.c                  |   10 +-
 lib/format1/lvm1-label.c              |    4 +-
 lib/format_pool/disk_rep.c            |    4 +-
 lib/format_pool/format_pool.c         |   20 ++--
 lib/format_pool/import_export.c       |   14 +-
 lib/format_pool/pool_label.c          |    4 +-
 lib/format_text/archive.c             |   16 +-
 lib/format_text/archiver.c            |   32 ++--
 lib/format_text/export.c              |   12 +-
 lib/format_text/flags.c               |    8 +-
 lib/format_text/format-text.c         |   96 ++++++------
 lib/format_text/import.c              |    2 +-
 lib/format_text/import_vsn1.c         |  120 ++++++++--------
 lib/format_text/tags.c                |    2 +-
 lib/format_text/text_label.c          |   16 +-
 lib/label/label.c                     |   14 +-
 lib/locking/cluster_locking.c         |   20 ++--
 lib/locking/external_locking.c        |    4 +-
 lib/locking/file_locking.c            |    6 +-
 lib/locking/locking.c                 |   18 +-
 lib/locking/no_locking.c              |    4 +-
 lib/log/log.c                         |   51 ++++++-
 lib/log/log.h                         |   18 ++-
 lib/log/lvm-logging.h                 |   11 +-
 lib/metadata/lv_manip.c               |  176 +++++++++++-----------
 lib/metadata/merge.c                  |   46 +++---
 lib/metadata/metadata.c               |  268 ++++++++++++++++----------------
 lib/metadata/mirror.c                 |  156 ++++++++++----------
 lib/metadata/pv_manip.c               |   32 ++--
 lib/metadata/pv_map.c                 |    4 +-
 lib/metadata/segtype.c                |    2 +-
 lib/metadata/snapshot_manip.c         |    6 +-
 lib/mirror/mirrored.c                 |   34 ++--
 lib/misc/lvm-exec.c                   |    8 +-
 lib/misc/lvm-file.c                   |   16 +-
 lib/misc/lvm-string.c                 |    2 +-
 lib/misc/sharedlib.c                  |    4 +-
 lib/mm/memlock.c                      |    4 +-
 lib/report/report.c                   |   58 ++++----
 lib/snapshot/snapshot.c               |   14 +-
 lib/striped/striped.c                 |    8 +-
 lib/uuid/uuid.c                       |    8 +-
 lib/zero/zero.c                       |    2 +-
 libdm/ioctl/libdm-iface.c             |   94 ++++++------
 libdm/libdm-common.c                  |   36 +++---
 libdm/libdm-deptree.c                 |  154 ++++++++++----------
 libdm/libdm-file.c                    |    2 +-
 libdm/libdm-report.c                  |  104 +++++++-------
 libdm/misc/dm-logging.h               |    6 +-
 libdm/mm/dbg_malloc.c                 |   10 +-
 libdm/mm/pool-debug.c                 |    8 +-
 libdm/mm/pool-fast.c                  |    6 +-
 libdm/mm/pool.c                       |    6 +-
 libdm/regex/matcher.c                 |    4 +-
 libdm/regex/parse_rx.c                |   10 +-
 liblvm/lvm.h                          |    3 +
 liblvm/lvm_base.c                     |   19 ++-
 old-tests/datastruct/hash_t.c         |    4 +-
 old-tests/dev-mgr/dev_cache_t.c       |    6 +-
 old-tests/device/dev_cache_t.c        |    6 +-
 old-tests/device/random.c             |    4 +-
 old-tests/filters/pfilter_t.c         |    4 +-
 old-tests/filters/rfilter_t.c         |    2 +-
 tools/dmsetup.c                       |   42 +++---
 tools/lvchange.c                      |  100 ++++++------
 tools/lvconvert.c                     |  112 +++++++-------
 tools/lvcreate.c                      |  156 ++++++++++----------
 tools/lvdisplay.c                     |    6 +-
 tools/lvm.c                           |   10 +-
 tools/lvmcmdlib.c                     |    8 +-
 tools/lvmcmdline.c                    |   57 ++++---
 tools/lvmdiskscan.c                   |   10 +-
 tools/lvremove.c                      |    2 +-
 tools/lvrename.c                      |   18 +-
 tools/lvresize.c                      |   68 ++++----
 tools/lvscan.c                        |    2 +-
 tools/polldaemon.c                    |   16 +-
 tools/pvchange.c                      |   44 +++---
 tools/pvcreate.c                      |   58 ++++----
 tools/pvdisplay.c                     |   10 +-
 tools/pvmove.c                        |   64 ++++----
 tools/pvremove.c                      |   20 ++--
 tools/pvresize.c                      |   28 ++--
 tools/pvscan.c                        |    4 +-
 tools/reporter.c                      |   10 +-
 tools/stub.h                          |    8 +-
 tools/toollib.c                       |  112 +++++++-------
 tools/vgcfgbackup.c                   |    8 +-
 tools/vgcfgrestore.c                  |   10 +-
 tools/vgchange.c                      |   42 +++---
 tools/vgconvert.c                     |   38 +++---
 tools/vgcreate.c                      |   10 +-
 tools/vgdisplay.c                     |    8 +-
 tools/vgexport.c                      |    6 +-
 tools/vgextend.c                      |    4 +-
 tools/vgimport.c                      |    8 +-
 tools/vgmerge.c                       |    6 +-
 tools/vgreduce.c                      |   58 ++++----
 tools/vgremove.c                      |    2 +-
 tools/vgrename.c                      |   14 +-
 tools/vgscan.c                        |    4 +-
 tools/vgsplit.c                       |   24 ++--
 131 files changed, 1906 insertions(+), 1822 deletions(-)
#1 lore raw

PATCH 1/2 Add cmd logging for liblvm error reporting: All logging functions have an additional argument: The error code

---
 daemons/clvmd/lvm-functions.c |    7 +++++-
 lib/commands/toolcontext.c    |   26 ++++++++++++---------
 lib/commands/toolcontext.h    |    6 +++++
 lib/log/log.c                 |   51 +++++++++++++++++++++++++++++++++++++----
 lib/log/log.h                 |   18 ++++++++------
 lib/log/lvm-logging.h         |   11 ++++++--
 libdm/misc/dm-logging.h       |    6 ++--
 libdm/mm/dbg_malloc.c         |    2 +-
 liblvm/lvm.h                  |    3 ++
 liblvm/lvm_base.c             |   17 ++++++++++++-
 tools/lvmcmdline.c            |    5 ++++
 11 files changed, 118 insertions(+), 34 deletions(-)
daemons/clvmd/lvm-functions.c +6 -1
index d559b3a..028698c 100644
@@ -788,7 +788,12 @@ void lvm_do_backup(const char *vgname)
 int init_lvm(int using_gulm)
 {
 	if (!(cmd = create_toolcontext(1, NULL))) {
-		log_error("Failed to allocate command context");
+		log_error(LVM_GEN_ERR, "Failed to allocate command context");
+		return 0;
+	}
+
+	if (lvm_error(cmd) != 0) {
+		log_error(LVM_GEN_ERR, "Failed to create command context");
 		return 0;
 	}
 
lib/commands/toolcontext.c +15 -11
index 17b168a..bfe1ad5 100644
@@ -190,7 +190,7 @@ static void _init_logging(struct cmd_context *cmd)
 
 	/* Tell device-mapper about our logging */
 #ifdef DEVMAPPER_SUPPORT
-	dm_log_init(print_log);
+	dm_log_with_errno_init(print_log);
 #endif
 }
 
@@ -1083,6 +1083,9 @@ struct cmd_context *create_toolcontext(unsigned is_long_lived,
 	dm_list_init(&cmd->tags);
 	dm_list_init(&cmd->config_files);
 
+	/* Log to command */
+	init_log_cmd(cmd);
+
 	/*
 	 * Environment variable LVM_SYSTEM_DIR overrides this below.
 	 */
@@ -1164,16 +1167,7 @@ struct cmd_context *create_toolcontext(unsigned is_long_lived,
 	return cmd;
 
       error:
-	_destroy_tag_configs(cmd);
-	dev_cache_exit();
-	if (cmd->filter)
-		cmd->filter->destroy(cmd->filter);
-	if (cmd->mem)
-		dm_pool_destroy(cmd->mem);
-	if (cmd->libmem)
-		dm_pool_destroy(cmd->libmem);
-	dm_free(cmd);
-	return NULL;
+	return cmd;
 }
 
 static void _destroy_formats(struct dm_list *formats)
@@ -1318,3 +1312,13 @@ void destroy_toolcontext(struct cmd_context *cmd)
 	fin_log();
 	fin_syslog();
 }
+
+int cmd_error(struct cmd_context *cmd)
+{
+	return cmd->error;
+}
+
+const char *cmd_strerror(struct cmd_context *cmd)
+{
+	return cmd->err_string;
+}
lib/commands/toolcontext.h +6 -0
index 374b38f..41f947a 100644
@@ -92,6 +92,9 @@ struct cmd_context {
 	char dev_dir[PATH_MAX];
 	char proc_dir[PATH_MAX];
 	char sysfs_dir[PATH_MAX];
+
+	int error;
+	char err_string[8192]; /* fixed size error srting */
 };
 
 /*
@@ -105,4 +108,7 @@ int refresh_toolcontext(struct cmd_context *cmd);
 int config_files_changed(struct cmd_context *cmd);
 int init_lvmcache_orphans(struct cmd_context *cmd);
 
+int cmd_error(struct cmd_context *cmd);
+const char *cmd_strerror(struct cmd_context *cmd);
+
 #endif
lib/log/log.c +46 -5

87 lines not on this page · raw message

lib/log/log.h +10 -8
index 110f1b0..e0dcd26 100644
@@ -50,22 +50,24 @@
 #define _LOG_ERR 3
 #define _LOG_FATAL 2
 
-#define log_debug(x...) LOG_LINE(_LOG_DEBUG, x)
-#define log_info(x...) LOG_LINE(_LOG_INFO, x)
-#define log_notice(x...) LOG_LINE(_LOG_NOTICE, x)
-#define log_warn(x...) LOG_LINE(_LOG_WARN | _LOG_STDERR, x)
-#define log_err(x...) LOG_LINE(_LOG_ERR, x)
-#define log_fatal(x...) LOG_LINE(_LOG_FATAL, x)
+#define LVM_GEN_ERR -1
+
+#define log_debug(x...) LOG_LINE(_LOG_DEBUG, 0, x)
+#define log_info(x...) LOG_LINE(_LOG_INFO, 0, x)
+#define log_notice(x...) LOG_LINE(_LOG_NOTICE, 0, x)
+#define log_warn(x...) LOG_LINE(_LOG_WARN | _LOG_STDERR, 0, x)
+#define log_err(c, x...) LOG_LINE(_LOG_ERR, c, x)
+#define log_fatal(x...) LOG_LINE(_LOG_FATAL, 0, x)
 
 #define stack log_debug("<backtrace>")	/* Backtrace on error */
 #define log_very_verbose(args...) log_info(args)
 #define log_verbose(args...) log_notice(args)
-#define log_print(args...) LOG_LINE(_LOG_WARN, args)
+#define log_print(args...) LOG_LINE(_LOG_WARN, 0, args)
 #define log_error(args...) log_err(args)
 
 /* System call equivalents */
 #define log_sys_error(x, y) \
-		log_err("%s: %s failed: %s", y, x, strerror(errno))
+		log_err(errno, "%s: %s failed: %s", y, x, strerror(errno))
 #define log_sys_very_verbose(x, y) \
 		log_info("%s: %s failed: %s", y, x, strerror(errno))
 #define log_sys_debug(x, y) \
lib/log/lvm-logging.h +8 -3
index d267e23..3b67813 100644
@@ -16,13 +16,15 @@
 #ifndef _LVM_LOGGING_H
 #define _LVM_LOGGING_H
 
-void print_log(int level, const char *file, int line, const char *format, ...)
-    __attribute__ ((format(printf, 4, 5)));
+void print_log(int level, const char *file, int line, int code, const char *format, ...)
+    __attribute__ ((format(printf, 5, 6)));
 
-#define LOG_LINE(l, x...) print_log(l, __FILE__, __LINE__ , ## x)
+#define LOG_LINE(l, c, x...) print_log(l, __FILE__, __LINE__ , c, ## x)
 
 #include "log.h"
 
+struct cmd_context;
+
 typedef void (*lvm2_log_fn_t) (int level, const char *file, int line,
 			       const char *message);
 
@@ -34,14 +36,17 @@ void init_msg_prefix(const char *prefix);
 void init_log_file(const char *log_file, int append);
 void init_log_direct(const char *log_file, int append);
 void init_log_while_suspended(int log_while_suspended);
+void init_log_cmd(struct cmd_context *cmd);
 
 void fin_log(void);
 void release_log_memory(void);
+void release_log_cmd(struct cmd_context *cmd);
 
 void init_syslog(int facility);
 void fin_syslog(void);
 
 int error_message_produced(void);
+void reset_log_cmd(struct cmd_context *cmd);
 
 /* Suppress messages to stdout/stderr (1) or everywhere (2) */
 /* Returns previous setting */
libdm/misc/dm-logging.h +3 -3
index ee3ed34..d3d2094 100644
@@ -21,15 +21,15 @@
 extern dm_log_fn dm_log;
 extern dm_log_with_errno_fn dm_log_with_errno;
 
-#define LOG_MESG(l, f, ln, x...) \
+#define LOG_MESG(l, f, ln, c, x...)		\
 	do { \
 		if (dm_log_is_non_default()) \
 			dm_log(l, f, ln, ## x); \
 		else \
-			dm_log_with_errno(l, f, ln, 0, ## x); \
+			dm_log_with_errno(l, f, ln, c, ## x); \
 	} while (0)
 
-#define LOG_LINE(l, x...) LOG_MESG(l, __FILE__, __LINE__, ## x)
+#define LOG_LINE(l, c, x...) LOG_MESG(l, __FILE__, __LINE__, c, ## x)
 
 #include "log.h"
 
libdm/mm/dbg_malloc.c +1 -1
index ea97208..3c51b61 100644
@@ -205,7 +205,7 @@ int dm_dump_memory_debug(void)
 		}
 		str[sizeof(str) - 1] = '\0';
 
-		LOG_MESG(_LOG_INFO, mb->file, mb->line,
+		LOG_MESG(_LOG_INFO, mb->file, mb->line, LVM_GEN_ERR,
 			 "block %d at %p, size %" PRIsize_t "\t [%s]",
 			 mb->id, mb->magic, mb->length, str);
 		tot += mb->length;
liblvm/lvm.h +3 -0
index 19ab5dd..83a85de 100644
@@ -71,6 +71,9 @@ void lvm_destroy(lvm_t libh);
  */
 int lvm_reload_config(lvm_t libh);
 
+int lvm_error(lvm_t libh);
+const char *lvm_strerror(lvm_t libh);
+
 /**
  * Create a VG with default parameters.
  *
liblvm/lvm_base.c +15 -2
index 4fa8541..2bf72d6 100644
@@ -30,6 +30,9 @@ lvm_t lvm_create(const char *system_dir)
 	if (!cmd)
 		return NULL;
 	/*
+	if (cmd_error(cmd) != 0)
+		return (lvm_t) cmd;
+
 	 * FIXME: if an non memory error occured, return the cmd (maybe some
 	 * cleanup needed).
 	 */
@@ -58,11 +61,21 @@ lvm_t lvm_create(const char *system_dir)
 void lvm_destroy(lvm_t libh)
 {
 	/* FIXME: error handling */
-	destroy_toolcontext((struct cmd_context *)libh);
+	destroy_toolcontext((struct cmd_context *) libh);
 }
 
 int lvm_reload_config(lvm_t libh)
 {
 	/* FIXME: re-init locking needed here? */
-	return refresh_toolcontext((struct cmd_context *)libh);
+	return refresh_toolcontext((struct cmd_context *) libh);
+}
+
+int lvm_error(lvm_t libh)
+{
+	return cmd_error((struct cmd_context *) libh);
+}
+
+const char *lvm_strerror(lvm_t libh)
+{
+	return cmd_strerror((struct cmd_context *) libh);
 }
tools/lvmcmdline.c +5 -0
index 10cbb12..283d139 100644
@@ -1179,6 +1179,11 @@ struct cmd_context *init_lvm(void)
 	if (!(cmd = create_toolcontext(0, NULL)))
 		return_NULL;
 
+	if (cmd_error(cmd) != 0) {
+		destroy_toolcontext(cmd);
+		return_NULL;
+	}
+
 	return cmd;
 }
 
Signature · 1 line
1.6.2.5