blob: e8089cbbe1ac5555855cdf56c8a9c946640568dc [file] [log] [blame]
Dan Handleyf3c8f322014-04-17 17:29:58 +01001/*
2 * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef __CASSERT_H__
32#define __CASSERT_H__
33
34/*******************************************************************************
35 * Macro to flag a compile time assertion. It uses the preprocessor to generate
36 * an invalid C construct if 'cond' evaluates to false.
Sandrine Bailleux9fbf5e42015-10-14 16:00:23 +010037 * The following compilation error is triggered if the assertion fails:
Dan Handleyf3c8f322014-04-17 17:29:58 +010038 * "error: size of array 'msg' is negative"
Sandrine Bailleux9fbf5e42015-10-14 16:00:23 +010039 * The 'unused' attribute ensures that the unused typedef does not emit a
40 * compiler warning.
Dan Handleyf3c8f322014-04-17 17:29:58 +010041 ******************************************************************************/
Sandrine Bailleux9fbf5e42015-10-14 16:00:23 +010042#define CASSERT(cond, msg) \
43 typedef char msg[(cond) ? 1 : -1] __attribute__((unused))
Dan Handleyf3c8f322014-04-17 17:29:58 +010044
45#endif /* __CASSERT_H__ */