Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[MSVC] don't whine on fopen being insecure
[simgrid.git] / include / xbt / sysdep.h
index 64eb191..d127bec 100644 (file)
@@ -2,7 +2,8 @@
 /*  no system header should be loaded out of this file so that we have only */
 /*  one file to check when porting to another OS                            */
 
-/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2004-2015. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 #ifndef _XBT_SYSDEP_H
 #define _XBT_SYSDEP_H
 
-#include <string.h>
-#include <stdlib.h>
-#include <stdarg.h>             /* va_list */
+#ifdef __cplusplus
+#include <type_traits>
+#endif
 
+#include "xbt/log.h"
 #include "xbt/misc.h"
 #include "xbt/asserts.h"
 
+#include "simgrid_config.h"
+
 SG_BEGIN_DECL()
 
+#include <string.h>
+#include <stdlib.h>
+#include <stdarg.h>             /* va_list */
+
 /* They live in asserts.h, but need to be declared before this module.
    double declaration to cut dependency cycle */
 /**
@@ -26,10 +34,28 @@ SG_BEGIN_DECL()
  *
  * @{
  */
+/** @brief Kill the program in silence */
 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
-XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+
+/**
+ * @brief Kill the program with an error message
+ * \param ... a format string and its arguments
+ *
+ * Things are so messed up that the only thing to do now, is to stop the
+ * program.
+ *
+ * The message is handled by a CRITICAL logging request, and may consist of a
+ * format string with arguments.
+ */
+#define xbt_die(...)                            \
+  do {                                          \
+    XBT_CCRITICAL(xbt, __VA_ARGS__);            \
+    xbt_abort();                                \
+  } while (0)
 /** @} */
 
+XBT_LOG_EXTERNAL_CATEGORY(xbt);
+
 /* these ones live in str.h, but redeclare them here so that we do
    not need to load the whole str.h and its heavy dependencies */
 #ifndef __USE_GNU               /* do not redeclare existing headers */
@@ -45,10 +71,15 @@ XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  *  @{
  */
 
-#if defined(__GNUC__) || defined(DOXYGEN)
+#ifdef _MSC_VER /* Microsoft wants to improve the code quality blah blah blah */
+/* warning C4996: '_strdup': The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. */
+# define strdup _strdup
+/* warning C4996: 'fopen': This function or variable may be unsafe. Consider using fopen_s instead. */
+# define _CRT_SECURE_NO_WARNINGS
+#endif
+
 /** @brief Like strdup, but xbt_die() on error */
-static inline __attribute__((always_inline)) char *xbt_strdup(const char *s)
-{
+static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
   char *res = NULL;
   if (s) {
     res = strdup(s);
@@ -62,8 +93,7 @@ XBT_PUBLIC(void) xbt_backtrace_display_current(void);
 
 /** @brief Like malloc, but xbt_die() on error
     @hideinitializer */
-static inline __attribute__((always_inline)) void *xbt_malloc(unsigned int n)
-{
+static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
   void *res;
 /*  if (n==0) {
      xbt_backtrace_display_current();
@@ -72,69 +102,87 @@ static inline __attribute__((always_inline)) void *xbt_malloc(unsigned int n)
 
   res = malloc(n);
   if (!res)
-    xbt_die(bprintf("Memory allocation of %d bytes failed", n));
+    xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
   return res;
 }
 
 /** @brief like malloc, but xbt_die() on error and memset data to 0
     @hideinitializer */
-static inline __attribute__((always_inline)) void *xbt_malloc0(unsigned int n)
-{
+static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
   void *res;
   //if (n==0) xbt_die("calloc(0) is not portable");
   res = calloc(n, 1);
   if (!res)
-    xbt_die(bprintf("Memory callocation of %d bytes failed", n));
+    xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
   return res;
 }
 
 /** @brief like realloc, but xbt_die() on error
     @hideinitializer */
-static inline __attribute__((always_inline)) void *xbt_realloc(void *p, unsigned int s)
-{
-  void *res = res;
+static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
+  void *res = NULL;
   //if (s==0) xbt_die("realloc(0) is not portable");
   if (s) {
     if (p) {
       res = realloc(p, s);
       if (!res)
-        xbt_die(bprintf("memory (re)allocation of %d bytes failed", s));
+        xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
     } else {
       res = xbt_malloc(s);
     }
   } else {
-    if (p) {
-      free(p);
-    }
+    free(p);
   }
   return res;
 }
-#else /* non __GNUC__  */
-#  define xbt_strdup(s)    strdup(s)
-#  define xbt_malloc(n)    malloc(n)
-#  define xbt_malloc0(n)   calloc(n,1)
-#  define xbt_realloc(p,s) realloc(p,s)
-#endif /* __GNUC__ ? */
 
 /** @brief like free
     @hideinitializer */
-#define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
-/*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
+#define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
 
 /** @brief like free, but you can be sure that it is a function  */
 XBT_PUBLIC(void) xbt_free_f(void *p);
 /** @brief should be given a pointer to pointer, and frees the second one */
 XBT_PUBLIC(void) xbt_free_ref(void *d);
 
+SG_END_DECL()
+
 /** @brief like calloc, but xbt_die() on error and don't memset to 0
     @hideinitializer */
+#ifndef __cplusplus
+
 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 /** @brief like calloc, but xbt_die() on error
     @hideinitializer */
 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 
-/** @} */
+#else
+
+/** C++ wrapper for xtb_new
+ *
+ *  This ensures that we do not xbt_new things that need a constructor.
+ */
+template<typename T> inline
+T* xbt_new_(size_t count)
+{
+  static_assert(std::is_trivial<T>(),
+    "Cannot xbt_new this type");
+  return (T*) xbt_malloc(sizeof(T) * count);
+}
 
+template<typename T> inline
+T* xbt_new0_(size_t count)
+{
+  static_assert(std::is_trivial<T>(),
+    "Cannot xbt_new0 this type");
+  return (T*) xbt_malloc0(sizeof(T) * count);
+}
 
-SG_END_DECL()
-#endif /* _XBT_SYSDEP_H */
+#define xbt_new(type, count)  ::xbt_new_<type>(count)
+#define xbt_new0(type, count) ::xbt_new0_<type>(count)
+
+#endif
+
+/** @} */
+
+#endif                          /* _XBT_SYSDEP_H */