ust_safe_snprintf should check print format

[ust.git] / include / usterr.h

diff --git a/include/usterr.h b/include/usterr.h
index 1819f973069b99f670fd5411f6d7809c35daffee..3ec7ae0dd697d1d7d6fd073d1d98762758131f92 100644 (file)
--- a/include/usterr.h
+++ b/include/usterr.h
@@ -1,3 +1,20 @@
+/* Copyright (C) 2009  Pierre-Marc Fournier
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
 #ifndef USTERR_H
 #define USTERR_H
 
@@ -6,6 +23,9 @@
 #include <sys/syscall.h>
 #include <errno.h>
 #include <stdarg.h>
+#include <stdio.h>
+
+#include <ust/core.h>
 
 #include "share.h"
 
@@ -22,6 +42,9 @@
  * signal handlers, so we must use a print method which is signal safe.
  */
 
+extern int ust_safe_snprintf(char *str, size_t n, const char *fmt, ...)
+       __attribute__ ((format (printf, 3, 4)));
+
 #define sigsafe_print_err(fmt, args...) \
 { \
        /* Can't use dynamic allocation. Limit ourselves to 250 chars. */ \
@@ -31,7 +54,7 @@
        /* Save the errno. */ \
        ____saved_errno = errno; \
 \
-       snprintf(____buf, sizeof(____buf), fmt, ## args); \
+       ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \
 \
        /* Add end of string in case of buffer overflow. */ \
        ____buf[sizeof(____buf)-1] = 0; \
@@ -45,13 +68,14 @@
 
 #define UST_STR_COMPONENT XSTR(UST_COMPONENT)
 
-#define ERRMSG(fmt, args...) do { sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (" __FILE__ ":" XSTR(__LINE__) ")\n", (long) getpid(), (long) syscall(SYS_gettid), ## args); fflush(stderr); } while(0)
+#define ERRMSG(fmt, args...) do { sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", (long) getpid(), (long) syscall(SYS_gettid), ## args, __func__); fflush(stderr); } while(0)
 
-#define DEBUG
-#ifdef DEBUG
+#ifdef UST_DEBUG
 # define DBG(fmt, args...) ERRMSG(fmt, ## args)
+# define DBG_raw(fmt, args...) do { sigsafe_print_err(fmt, ## args); fflush(stderr); } while(0)
 #else
 # define DBG(fmt, args...) do {} while(0)
+# define DBG_raw(fmt, args...) do {} while(0)
 #endif
 #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args)
 #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args)
@@ -76,5 +100,6 @@
 
 #define BUG_ON(condition) do { if (unlikely(condition)) ERR("condition not respected (BUG)"); } while(0)
 #define WARN_ON(condition) do { if (unlikely(condition)) WARN("condition not respected on line %s:%d", __FILE__, __LINE__); } while(0)
+#define WARN_ON_ONCE(condition) WARN_ON(condition)
 
 #endif /* USTERR_H */