summaryrefslogtreecommitdiff
path: root/lib/msvc-inval.h
blob: 61f0f4667769f249154452a77f9a94aa83267ae1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/* Invalid parameter handler for MSVC runtime libraries.
   Copyright (C) 2011 Free Software Foundation, Inc.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, 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 General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation,
   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */

#ifndef _MSVC_INVAL_H
#define _MSVC_INVAL_H

/* With MSVC runtime libraries with the "invalid parameter handler" concept,
   functions like fprintf(), dup2(), or close() crash when the caller passes
   an invalid argument.  But POSIX wants error codes (such as EINVAL or EBADF)
   instead.
   This file defines macros that turn such an invalid parameter notification
   into a non-local exit.  An error code can then be produced at the target
   of this exit.  You can thus write code like

     TRY_MSVC_INVAL
       {
         <Code that can trigger an invalid parameter notification
          but does not do 'return', 'break', 'continue', nor 'goto'.>
       }
     CATCH_MSVC_INVAL
       {
         <Code that handles an invalid parameter notification
          but does not do 'return', 'break', 'continue', nor 'goto'.>
       }
     DONE_MSVC_INVAL

   This entire block expands to a single statement.
 */

#if HAVE_MSVC_INVALID_PARAMETER_HANDLER
/* A native Windows platform with the "invalid parameter handler" concept.  */

/* Get _invalid_parameter_handler type and _set_invalid_parameter_handler
   declaration.  */
#include <stdlib.h>

# if defined _MSC_VER
/* A compiler that supports __try/__except, as described in the page
   "try-except statement" on microsoft.com
   <http://msdn.microsoft.com/en-us/library/s58ftw19.aspx>.
   With __try/__except, we can use the multithread-safe exception handling.  */

/* Gnulib can define its own status codes, as described in the page
   "Raising Software Exceptions" on microsoft.com
   <http://msdn.microsoft.com/en-us/library/het71c37.aspx>.
   Our status codes are composed of
     - 0xE0000000, mandatory for all user-defined status codes,
     - 0x474E550, a API identifier ("GNU"),
     - 0, 1, 2, ..., used to distinguish different status codes from the
       same API.  */
#  define STATUS_GNULIB_INVALID_PARAMETER (0xE0000000 + 0x474E550 + 0)

#  ifdef __cplusplus
extern "C" {
#  endif

/* Ensure that the invalid parameter handler in installed that raises a
   software exception with code STATUS_GNULIB_INVALID_PARAMETER.
   Because we assume no other part of the program installs a different
   invalid parameter handler, this solution is multithread-safe.  */
extern void gl_msvc_inval_ensure_handler (void);

#  ifdef __cplusplus
}
#  endif

#  define TRY_MSVC_INVAL \
     {                                                                         \
       gl_msvc_inval_ensure_handler ();                                        \
       __try
#  define CATCH_MSVC_INVAL \
       __except (GetExceptionCode () == STATUS_GNULIB_INVALID_PARAMETER        \
                 ? EXCEPTION_EXECUTE_HANDLER                                   \
                 : EXCEPTION_CONTINUE_SEARCH)
#  define DONE_MSVC_INVAL \
     }

# else
/* Any compiler.
   We can only use setjmp/longjmp.
   Unfortunately, this is *not* multithread-safe.  */

#  include <setjmp.h>

#  ifdef __cplusplus
extern "C" {
#  endif

/* The restart that will resume execution at the code between
   CATCH_MSVC_INVAL and DONE_MSVC_INVAL.  It is enabled only between
   TRY_MSVC_INVAL and CATCH_MSVC_INVAL.  */
extern jmp_buf gl_msvc_inval_restart;

/* The invalid parameter handler that unwinds the stack up to the
   gl_msvc_inval_restart.  It is enabled only between TRY_MSVC_INVAL
   and CATCH_MSVC_INVAL.  */
extern void cdecl gl_msvc_invalid_parameter_handler (const wchar_t *expression,
                                                     const wchar_t *function,
                                                     const wchar_t *file,
                                                     unsigned int line,
                                                     uintptr_t dummy);

#  ifdef __cplusplus
}
#  endif

#  define TRY_MSVC_INVAL \
     {                                                                         \
       _invalid_parameter_handler orig_handler;                                \
       /* First, initialize gl_msvc_inval_restart.  */                         \
       if (setjmp (gl_msvc_inval_restart) == 0)                                \
         {                                                                     \
           /* Then, enable gl_msvc_invalid_parameter_handler.  */              \
           orig_handler =                                                      \
             _set_invalid_parameter_handler (gl_msvc_invalid_parameter_handler);
#  define CATCH_MSVC_INVAL \
           /* Execution completed.                                             \
              Disable gl_msvc_invalid_parameter_handler.  */                   \
           _set_invalid_parameter_handler (orig_handler);                      \
         }                                                                     \
       else                                                                    \
         {                                                                     \
           /* Execution triggered an invalid parameter notification.           \
              Disable gl_msvc_invalid_parameter_handler.  */                   \
           _set_invalid_parameter_handler (orig_handler);
#  define DONE_MSVC_INVAL \
         }                                                                     \
     }

# endif

#else
/* A platform that does not need to the invalid parameter handler.  */

/* The braces here avoid GCC warnings like
   "warning: suggest explicit braces to avoid ambiguous `else'".  */
# define TRY_MSVC_INVAL { if (1)
# define CATCH_MSVC_INVAL else
# define DONE_MSVC_INVAL }

#endif

#endif /* _MSVC_INVAL_H */