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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/ssx/ssx/ssx_macros.h $ */
/* */
/* OpenPOWER OnChipController Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2014,2015 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __SSX_MACROS_H__
#define __SSX_MACROS_H__
//-----------------------------------------------------------------------------
// *! (C) Copyright International Business Machines Corp. 2014
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
//-----------------------------------------------------------------------------
/// \file ssx_macros.h
/// \brief Boilerplate macros for SSX
/// This macro encapsulates error handling boilerplate for code that uses the
/// SSX API-type error handling, for errors that do not occur in critical
/// sections.
#define SSX_ERROR(code) \
do { \
if (SSX_ERROR_PANIC) { \
SSX_PANIC(code); \
} else { \
return -(code); \
} \
} while (0)
/// This macro encapsulates error handling boilerplate in the SSX API
/// functions, for errors that do not occur in critical sections.
#define SSX_ERROR_IF(condition, code) \
do { \
if (condition) { \
SSX_ERROR(code); \
} \
} while (0)
/// This macro encapsulates error handling boilerplate in the SSX API
/// functions, for errors that do not occur in critical sections and always
/// force a kernel panic, indicating a kernel or API bug.
#define SSX_PANIC_IF(condition, code) \
do { \
if (condition) { \
SSX_PANIC(code); \
} \
} while (0)
/// This macro encapsulates error handling boilerplate in the SSX API
/// functions, for errors that do not occur in critical sections.
/// The error handling will only be enabled when SSX_ERROR_CHECK_API
/// is enabled.
#define SSX_ERROR_IF_CHECK_API(condition, code) \
do { \
if (SSX_ERROR_CHECK_API) { \
SSX_ERROR_IF(condition, code); \
} \
} while (0)
/// This macro encapsulates error handling boilerplate in the SSX API
/// functions, for errors that occur in critical sections.
#define SSX_ERROR_IF_CRITICAL(condition, code, context) \
do { \
if (condition) { \
if (SSX_ERROR_PANIC) { \
SSX_PANIC(code); \
ssx_critical_section_exit(context); \
} else { \
ssx_critical_section_exit(context); \
return -(code); \
} \
} \
} while (0)
/// This is a general macro for errors that require cleanup before returning
/// the error code.
#define SSX_ERROR_IF_CLEANUP(condition, code, cleanup) \
do { \
if (condition) { \
if (SSX_ERROR_PANIC) { \
SSX_PANIC(code); \
cleanup; \
} else { \
cleanup; \
return -(code); \
} \
} \
} while (0)
/// Most SSX APIs can not be called from critical interrupt contexts.
#define SSX_ERROR_IF_CRITICAL_INTERRUPT_CONTEXT() \
SSX_ERROR_IF(__ssx_kernel_context_critical_interrupt(), \
SSX_ILLEGAL_CONTEXT_CRITICAL_INTERRUPT)
/// Some SSX APIs can only be called from thread contexts - these are APIs
/// that threads call on 'themselves'.
#define SSX_ERROR_UNLESS_THREAD_CONTEXT() \
SSX_ERROR_IF(!__ssx_kernel_context_thread(), \
SSX_ILLEGAL_CONTEXT_THREAD_CONTEXT)
/// Some SSX APIs must be called from an interrupt context only.
#define SSX_ERROR_UNLESS_ANY_INTERRUPT_CONTEXT() \
SSX_ERROR_IF(!__ssx_kernel_context_any_interrupt(), \
SSX_ILLEGAL_CONTEXT_INTERRUPT_CONTEXT)
#endif /* __SSX_MACROS_H__ */
|
