CTASSERT (9)

Leading comments

Copyright (c) 2003 Hiten M. Pandya

All rights reserved.

This program is free software.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer ...

(The comments found at the beginning of the groff file "man9/CTASSERT.9freebsd".)

NAME

CTASSERT - compile time assertion macro

SYNOPSIS

In sys/param.h In sys/systm.h Fn CTASSERT expression

DESCRIPTION

The Fn CTASSERT macro evaluates Fa expression at compile time and causes a compiler error if it is false.

The Fn CTASSERT macro is useful for asserting the size or alignment of important data structures and variables during compilation, which would otherwise cause the code to fail at run time.

IMPLEMENTATION NOTES

The Fn CTASSERT macro should not be used in a header file. It is implemented using a dummy typedef, with a name (based on line number) that may conflict with a Fn CTASSERT in a source file including that header.

EXAMPLES

Assert that the size of the Vt uuid structure is 16 bytes.

"CTASSERT(sizeof(struct uuid) == 16);"

SEE ALSO

KASSERT(9)

AUTHORS

This manual page was written by An Hiten M. Pandya Aq hmp@FreeBSD.org .