libexplain/malloc.h

Go to the documentation of this file.

/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2009, 2013 Peter Miller
 *
 * This program 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 3 of the License, or (at
 * your option) any later version.
 *
 * This program 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 program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBEXPLAIN_MALLOC_H
#define LIBEXPLAIN_MALLOC_H

#include <libexplain/gcc_attributes.h>

#include <stdlib.h>

#ifdef __cplusplus
extern "C" {
#endif

void *explain_malloc_or_die(size_t size)
                                                     LIBEXPLAIN_ATTRIBUTE_MALLOC
                                             LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(1);

void *explain_malloc_on_error(size_t size)
                                                     LIBEXPLAIN_ATTRIBUTE_MALLOC
                                              LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(1)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

const char *explain_malloc(size_t size)
                                                     LIBEXPLAIN_ATTRIBUTE_MALLOC
                                              LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(1)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

const char *explain_errno_malloc(int errnum, size_t size)
                                              LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(2)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

void explain_message_malloc(char *message, int message_size, size_t size)
                                             LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(3);

void explain_message_errno_malloc(char *message, int message_size, int errnum,
    size_t size)
                                             LIBEXPLAIN_ATTRIBUTE_ALLOC_SIZE(4);

#ifdef __cplusplus
}
#endif

/* vim: set ts=8 sw=4 et : */
#endif /* LIBEXPLAIN_MALLOC_H */