xref: /freebsd/share/man/man9/CTASSERT.9 (revision b1f92fa22938fe29ab7e53692ffe0ed7a0ecc4d0)
1.\" Copyright (c) 2003 Hiten M. Pandya
2.\"
3.\" All rights reserved.
4.\"
5.\" This program is free software.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd August 1, 2015
30.Dt CTASSERT 9
31.Os
32.Sh NAME
33.Nm CTASSERT
34.Nd compile time assertion macro
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/systm.h
38.Fn CTASSERT expression
39.Sh DESCRIPTION
40The
41.Fn CTASSERT
42macro is deprecated and the C11 standard
43.Fn _Static_assert
44should be used instead.
45The header
46.Fa sys/cdefs.h
47should be included to provide compatibility for pre-C11 compilers.
48.Pp
49The
50.Fn CTASSERT
51macro evaluates
52.Fa expression
53at compile time and causes a compiler error if it is false.
54.Pp
55The
56.Fn CTASSERT
57macro is useful for asserting the size or alignment of important
58data structures and variables during compilation, which would
59otherwise cause the code to fail at run time.
60.Sh EXAMPLES
61Assert that the size of the
62.Vt uuid
63structure is 16 bytes.
64.Pp
65.Dl "CTASSERT(sizeof(struct uuid) == 16);"
66.Sh SEE ALSO
67.Xr KASSERT 9
68.Sh AUTHORS
69This manual page was written by
70.An Hiten M. Pandya Aq Mt hmp@FreeBSD.org .
71