err.hpp 8.85 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq 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.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
30 31
#ifndef __ZMQ_ERR_HPP_INCLUDED__
#define __ZMQ_ERR_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32 33

#include <assert.h>
34
#if defined _WIN32_WCE
boris@boressoft.ru's avatar
boris@boressoft.ru committed
35 36
#include "..\builds\msvc\errno.hpp"
#else
Martin Sustrik's avatar
Martin Sustrik committed
37
#include <errno.h>
boris@boressoft.ru's avatar
boris@boressoft.ru committed
38
#endif
39
#include <string.h>
Martin Sustrik's avatar
Martin Sustrik committed
40 41 42
#include <stdlib.h>
#include <stdio.h>

43
#ifndef ZMQ_HAVE_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
44 45 46
#include <netdb.h>
#endif

Michael's avatar
Michael committed
47 48 49 50
#include "likely.hpp"

//  0MQ-specific error codes are defined in zmq.h

51 52 53 54 55
// EPROTO is not used by OpenBSD and maybe other platforms.
#ifndef EPROTO
#define EPROTO 0
#endif

56 57
namespace zmq
{
58
const char *errno_to_string (int errno_);
59 60 61 62 63 64 65
#if defined __clang__
#if __has_feature(attribute_analyzer_noreturn)
void zmq_abort (const char *errmsg_) __attribute__ ((analyzer_noreturn));
#endif
#elif defined __MSCVER__
__declspec(noreturn) void zmq_abort (const char *errmsg_);
#else
66
void zmq_abort (const char *errmsg_);
67
#endif
68
void print_backtrace ();
69 70
}

Martin Sustrik's avatar
Martin Sustrik committed
71
#ifdef ZMQ_HAVE_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
72

Martin Sustrik's avatar
Martin Sustrik committed
73
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
74
{
75 76 77
const char *wsa_error ();
const char *
wsa_error_no (int no_,
78
              const char *wsae_wouldblock_string_ = "Operation would block");
79
void win_error (char *buffer_, size_t buffer_size_);
80
int wsa_error_to_errno (int errcode_);
Martin Sustrik's avatar
Martin Sustrik committed
81 82 83
}

//  Provides convenient way to check WSA-style errors on Windows.
84 85 86 87 88
#define wsa_assert(x)                                                          \
    do {                                                                       \
        if (unlikely (!(x))) {                                                 \
            const char *errstr = zmq::wsa_error ();                            \
            if (errstr != NULL) {                                              \
89 90
                fprintf (stderr, "Assertion failed: %s [%i] (%s:%d)\n",        \
                         errstr, WSAGetLastError (), __FILE__, __LINE__);      \
91 92 93 94
                fflush (stderr);                                               \
                zmq::zmq_abort (errstr);                                       \
            }                                                                  \
        }                                                                      \
95 96
    } while (false)

97
//  Provides convenient way to assert on WSA-style errors on Windows.
98 99 100 101 102 103 104 105 106
#define wsa_assert_no(no)                                                      \
    do {                                                                       \
        const char *errstr = zmq::wsa_error_no (no);                           \
        if (errstr != NULL) {                                                  \
            fprintf (stderr, "Assertion failed: %s (%s:%d)\n", errstr,         \
                     __FILE__, __LINE__);                                      \
            fflush (stderr);                                                   \
            zmq::zmq_abort (errstr);                                           \
        }                                                                      \
107 108
    } while (false)

109
// Provides convenient way to check GetLastError-style errors on Windows.
110 111 112 113 114 115 116 117 118 119
#define win_assert(x)                                                          \
    do {                                                                       \
        if (unlikely (!(x))) {                                                 \
            char errstr[256];                                                  \
            zmq::win_error (errstr, 256);                                      \
            fprintf (stderr, "Assertion failed: %s (%s:%d)\n", errstr,         \
                     __FILE__, __LINE__);                                      \
            fflush (stderr);                                                   \
            zmq::zmq_abort (errstr);                                           \
        }                                                                      \
120
    } while (false)
Martin Sustrik's avatar
Martin Sustrik committed
121 122 123 124 125 126

#endif

//  This macro works in exactly the same way as the normal assert. It is used
//  in its stead because standard assert on Win32 in broken - it prints nothing
//  when used within the scope of JNI library.
127 128 129 130 131 132 133 134
#define zmq_assert(x)                                                          \
    do {                                                                       \
        if (unlikely (!(x))) {                                                 \
            fprintf (stderr, "Assertion failed: %s (%s:%d)\n", #x, __FILE__,   \
                     __LINE__);                                                \
            fflush (stderr);                                                   \
            zmq::zmq_abort (#x);                                               \
        }                                                                      \
135
    } while (false)
Martin Sustrik's avatar
Martin Sustrik committed
136 137

//  Provides convenient way to check for errno-style errors.
138 139 140 141 142 143 144 145
#define errno_assert(x)                                                        \
    do {                                                                       \
        if (unlikely (!(x))) {                                                 \
            const char *errstr = strerror (errno);                             \
            fprintf (stderr, "%s (%s:%d)\n", errstr, __FILE__, __LINE__);      \
            fflush (stderr);                                                   \
            zmq::zmq_abort (errstr);                                           \
        }                                                                      \
146
    } while (false)
Martin Sustrik's avatar
Martin Sustrik committed
147

148
//  Provides convenient way to check for POSIX errors.
149 150 151 152 153 154 155 156
#define posix_assert(x)                                                        \
    do {                                                                       \
        if (unlikely (x)) {                                                    \
            const char *errstr = strerror (x);                                 \
            fprintf (stderr, "%s (%s:%d)\n", errstr, __FILE__, __LINE__);      \
            fflush (stderr);                                                   \
            zmq::zmq_abort (errstr);                                           \
        }                                                                      \
157
    } while (false)
158

159
//  Provides convenient way to check for errors from getaddrinfo.
160 161 162 163 164 165 166 167
#define gai_assert(x)                                                          \
    do {                                                                       \
        if (unlikely (x)) {                                                    \
            const char *errstr = gai_strerror (x);                             \
            fprintf (stderr, "%s (%s:%d)\n", errstr, __FILE__, __LINE__);      \
            fflush (stderr);                                                   \
            zmq::zmq_abort (errstr);                                           \
        }                                                                      \
168
    } while (false)
Martin Sustrik's avatar
Martin Sustrik committed
169

170
//  Provides convenient way to check whether memory allocation have succeeded.
171 172 173 174 175 176 177 178
#define alloc_assert(x)                                                        \
    do {                                                                       \
        if (unlikely (!x)) {                                                   \
            fprintf (stderr, "FATAL ERROR: OUT OF MEMORY (%s:%d)\n", __FILE__, \
                     __LINE__);                                                \
            fflush (stderr);                                                   \
            zmq::zmq_abort ("FATAL ERROR: OUT OF MEMORY");                     \
        }                                                                      \
Martin Hurton's avatar
Martin Hurton committed
179
    } while (false)
180 181

#endif