Docs: Copyright updates for 2018 (#114)

[thirdparty/squid.git] / compat / xalloc.h

diff --git a/compat/xalloc.h b/compat/xalloc.h
index fd9260145924436651b69f5a97fae33464d35a0a..c28b047822059fc2e198368448e879165a175589 100644 (file)
--- a/compat/xalloc.h
+++ b/compat/xalloc.h
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
 #ifndef _SQUID_COMPAT_XALLOC_H
 #define _SQUID_COMPAT_XALLOC_H
 
@@ -5,70 +13,72 @@
 extern "C" {
 #endif
 
-    /**
-     * xcalloc() - same as calloc(3).  Used for portability.
-     * Never returns NULL; fatal on error.
-     *
-     * Define failure_notify to receive error message.
-     * otherwise perror() is used to display it.
-     */
-    void *xcalloc(size_t n, size_t sz);
-
-    /**
-     * xmalloc() - same as malloc(3).  Used for portability.
-     * Never returns NULL; fatal on error.
-     *
-     * Define failure_notify to receive error message.
-     * otherwise perror() is used to display it.
-     */
-    void *xmalloc(size_t sz);
-
-    /**
-     * xrealloc() - same as realloc(3). Used for portability.
-     * Never returns NULL; fatal on error.
-     */
-    void *xrealloc(void *s, size_t sz);
+/**
+ * xcalloc() - same as calloc(3).  Used for portability.
+ * Never returns NULL; fatal on error.
+ *
+ * Define failure_notify to receive error message.
+ * otherwise perror() is used to display it.
+ */
+void *xcalloc(size_t n, size_t sz);
 
-    /**
-     *  xfree() - same as free(3).  Used for portability.
-     *   Will not call free(3) if s == NULL.
-     *
-     * Define failure_notify to receive error message.
-     * otherwise perror() is used to display it.
-     */
-    void xfree(void *s);
+/**
+ * xmalloc() - same as malloc(3).  Used for portability.
+ * Never returns NULL; fatal on error.
+ *
+ * Define failure_notify to receive error message.
+ * otherwise perror() is used to display it.
+ */
+void *xmalloc(size_t sz);
 
-    /**
-     * xxfree() / free_const() - Same as free(3).  Used for portability.
-     * Accepts pointers to dynamically allocated const data.
-     *
-     * Define failure_notify to receive error message.
-     * otherwise perror() is used to display it.
-     */
-    void free_const(const void *s);
+/**
+ * xrealloc() - same as realloc(3). Used for portability.
+ * Never returns NULL; fatal on error.
+ */
+void *xrealloc(void *s, size_t sz);
 
-/// Backward compatibility alias for free_const(const void *s)
-#define xxfree(x)  free_const((x))
+/**
+ * free_const() - Same as free(3).  Used for portability.
+ * Accepts pointers to dynamically allocated const data.
+ *
+ * Define failure_notify to receive error message.
+ * otherwise perror() is used to display it.
+ */
+void free_const(const void *s);
 
-    /**
-     * Accepts pointers to dynamically allocated const data.
-     * Will not call free(3) if the pointer is NULL.
-     * Sets the pointer to NULL on completion.
-     *
-     * Use xfree() if the pointer does not need to be set afterward.
-     *
-     * Define failure_notify to receive error message.
-     * otherwise perror() is used to display it.
-     */
-#define safe_free(x)    while (x) { xxfree(x); (x) = NULL; }
+/**
+ *  xfree() - same as free(3).  Used for portability.
+ * Accepts pointers to dynamically allocated const data.
+ * Will not call free(3) if the pointer is NULL.
+ *
+ * Pointer is left with a value on completion.
+ * Use safe_free() if the pointer needs to be set to NULL afterward.
+ *
+ * Define failure_notify to receive error message.
+ * otherwise perror() is used to display it.
+ */
+static inline void xfree(const void *p) { if (p) free_const(p); }
 
-
-#if XMALLOC_STATISTICS
-    void malloc_statistics(void (*func) (int, int, int, void *), void *data);
-#endif
+/**
+ *  safe_free() - same as free(3).  Used for portability.
+ * Accepts pointers to dynamically allocated const data.
+ * Will not call free(3) if the pointer is NULL.
+ * Sets the pointer to NULL on completion.
+ *
+ * Use xfree() if the pointer does not need to be set afterward.
+ *
+ * Define failure_notify to receive error message.
+ * otherwise perror() is used to display it.
+ */
+#define safe_free(x)    while ((x)) { free_const((x)); (x) = NULL; }
 
 #ifdef __cplusplus
 }
 #endif
 
+#if XMALLOC_STATISTICS
+extern void malloc_statistics(void (*func) (int, int, int, void *), void *data);
+#endif
+
 #endif /* _SQUID_COMPAT_XALLOC_H */
+