OTF2_ErrorCodes.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: (c) 2009 RWTH Aachen University <rwth-aachen.de>
 * SPDX-FileCopyrightText: (c) 2009 Gesellschaft für numerische Simulation mbH Braunschweig <gns-mbh.com>
 * SPDX-FileCopyrightText: (c) 2009 Technische Universität Dresden <tu-dresden.de>
 * SPDX-FileCopyrightText: (c) 2009 University of Oregon <uoregon.edu>
 * SPDX-FileCopyrightText: (c) 2009 Forschungszentrum Jülich GmbH <fz-juelich.de>
 * SPDX-FileCopyrightText: (c) 2009 German Research School for Simulation Sciences GmbH
 * SPDX-FileCopyrightText: (c) 2009 Technische Universität München <tum.de>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

#ifndef OTF2_ERROR_CODES_H
#define OTF2_ERROR_CODES_H


#include <stdint.h>
#include <stdarg.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    OTF2_DEPRECATED    = -3,

    OTF2_ABORT         = -2,

    OTF2_WARNING       = -1,

    OTF2_SUCCESS       = 0,

    OTF2_ERROR_INVALID = 1,

    /* These are the internal implementation of POSIX error codes. */
    OTF2_ERROR_E2BIG,
    OTF2_ERROR_EACCES,
    OTF2_ERROR_EADDRNOTAVAIL,
    OTF2_ERROR_EAFNOSUPPORT,
    OTF2_ERROR_EAGAIN,
    OTF2_ERROR_EALREADY,
    OTF2_ERROR_EBADF,
    OTF2_ERROR_EBADMSG,
    OTF2_ERROR_EBUSY,
    OTF2_ERROR_ECANCELED,
    OTF2_ERROR_ECHILD,
    OTF2_ERROR_ECONNREFUSED,
    OTF2_ERROR_ECONNRESET,
    OTF2_ERROR_EDEADLK,
    OTF2_ERROR_EDESTADDRREQ,
    OTF2_ERROR_EDOM,
    OTF2_ERROR_EDQUOT,
    OTF2_ERROR_EEXIST,
    OTF2_ERROR_EFAULT,
    OTF2_ERROR_EFBIG,
    OTF2_ERROR_EINPROGRESS,
    OTF2_ERROR_EINTR,
    OTF2_ERROR_EINVAL,
    OTF2_ERROR_EIO,
    OTF2_ERROR_EISCONN,
    OTF2_ERROR_EISDIR,
    OTF2_ERROR_ELOOP,
    OTF2_ERROR_EMFILE,
    OTF2_ERROR_EMLINK,
    OTF2_ERROR_EMSGSIZE,
    OTF2_ERROR_EMULTIHOP,
    OTF2_ERROR_ENAMETOOLONG,
    OTF2_ERROR_ENETDOWN,
    OTF2_ERROR_ENETRESET,
    OTF2_ERROR_ENETUNREACH,
    OTF2_ERROR_ENFILE,
    OTF2_ERROR_ENOBUFS,
    OTF2_ERROR_ENODATA,
    OTF2_ERROR_ENODEV,
    OTF2_ERROR_ENOENT,
    OTF2_ERROR_ENOEXEC,
    OTF2_ERROR_ENOLCK,
    OTF2_ERROR_ENOLINK,
    OTF2_ERROR_ENOMEM,
    OTF2_ERROR_ENOMSG,
    OTF2_ERROR_ENOPROTOOPT,
    OTF2_ERROR_ENOSPC,
    OTF2_ERROR_ENOSR,
    OTF2_ERROR_ENOSTR,
    OTF2_ERROR_ENOSYS,
    OTF2_ERROR_ENOTCONN,
    OTF2_ERROR_ENOTDIR,
    OTF2_ERROR_ENOTEMPTY,
    OTF2_ERROR_ENOTSOCK,
    OTF2_ERROR_ENOTSUP,
    OTF2_ERROR_ENOTTY,
    OTF2_ERROR_ENXIO,
    OTF2_ERROR_EOPNOTSUPP,
    OTF2_ERROR_EOVERFLOW,
    OTF2_ERROR_EPERM,
    OTF2_ERROR_EPIPE,
    OTF2_ERROR_EPROTO,
    OTF2_ERROR_EPROTONOSUPPORT,
    OTF2_ERROR_EPROTOTYPE,
    OTF2_ERROR_ERANGE,
    OTF2_ERROR_EROFS,
    OTF2_ERROR_ESPIPE,
    OTF2_ERROR_ESRCH,
    OTF2_ERROR_ESTALE,
    OTF2_ERROR_ETIME,
    OTF2_ERROR_ETIMEDOUT,
    OTF2_ERROR_ETXTBSY,
    OTF2_ERROR_EWOULDBLOCK,
    OTF2_ERROR_EXDEV,

    /* These are the error codes specific to the OTF2 package */

    OTF2_ERROR_END_OF_FUNCTION,
    OTF2_ERROR_INVALID_CALL,
    OTF2_ERROR_INVALID_ARGUMENT,
    OTF2_ERROR_INVALID_RECORD,
    OTF2_ERROR_INVALID_DATA,
    OTF2_ERROR_INVALID_SIZE_GIVEN,
    OTF2_ERROR_UNKNOWN_TYPE,
    OTF2_ERROR_INTEGRITY_FAULT,
    OTF2_ERROR_MEM_FAULT,
    OTF2_ERROR_MEM_ALLOC_FAILED,
    OTF2_ERROR_PROCESSED_WITH_FAULTS,
    OTF2_ERROR_INDEX_OUT_OF_BOUNDS,
    OTF2_ERROR_INVALID_LINENO,
    OTF2_ERROR_END_OF_BUFFER,
    OTF2_ERROR_FILE_INTERACTION,
    OTF2_ERROR_FILE_CAN_NOT_OPEN,
    OTF2_ERROR_INTERRUPTED_BY_CALLBACK,
    OTF2_ERROR_PROPERTY_NAME_INVALID,
    OTF2_ERROR_PROPERTY_EXISTS,
    OTF2_ERROR_PROPERTY_NOT_FOUND,
    OTF2_ERROR_PROPERTY_VALUE_INVALID,
    OTF2_ERROR_FILE_COMPRESSION_NOT_SUPPORTED,
    OTF2_ERROR_DUPLICATE_MAPPING_TABLE,
    OTF2_ERROR_INVALID_FILE_MODE_TRANSITION,
    OTF2_ERROR_COLLECTIVE_CALLBACK,
    OTF2_ERROR_FILE_SUBSTRATE_NOT_SUPPORTED,
    OTF2_ERROR_INVALID_ATTRIBUTE_TYPE,
    OTF2_ERROR_LOCKING_CALLBACK,
    OTF2_ERROR_HINT_INVALID,
    OTF2_ERROR_HINT_LOCKED,
    OTF2_ERROR_HINT_INVALID_VALUE
} OTF2_ErrorCode;


const char*
OTF2_Error_GetName( OTF2_ErrorCode errorCode );


const char*
OTF2_Error_GetDescription( OTF2_ErrorCode errorCode );


typedef OTF2_ErrorCode
( *OTF2_ErrorCallback )( void*          userData,
                         const char*    file,
                         uint64_t       line,
                         const char*    function,
                         OTF2_ErrorCode errorCode,
                         const char*    msgFormatString,
                         va_list        va );


OTF2_ErrorCallback
OTF2_Error_RegisterCallback( OTF2_ErrorCallback errorCallbackIn,
                             void*              userData );


#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* OTF2_ERROR_CODES_H */