summaryrefslogtreecommitdiffstats
path: root/libdimension/profile.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2011-01-29 19:14:45 -0500
committerTavian Barnes <tavianator@gmail.com>2011-01-29 19:14:45 -0500
commit9400fce82dcf773c9862006a41681a73b22cbd87 (patch)
tree8193cc766c169c15cf1e74145ea2432ac70286cd /libdimension/profile.h
parent4f0c30aee2c56967895c981534414d1b04e9e0ce (diff)
downloaddimension-9400fce82dcf773c9862006a41681a73b22cbd87.tar.xz
Add dmnsn_[un]likely() macros and a profiling framework.
Diffstat (limited to 'libdimension/profile.h')
-rw-r--r--libdimension/profile.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/libdimension/profile.h b/libdimension/profile.h
new file mode 100644
index 0000000..e891771
--- /dev/null
+++ b/libdimension/profile.h
@@ -0,0 +1,44 @@
+/*************************************************************************
+ * Copyright (C) 2010 Tavian Barnes <tavianator@gmail.com> *
+ * *
+ * This file is part of The Dimension Library. *
+ * *
+ * The Dimension Library is free software; you can redistribute it and/ *
+ * or modify it under the terms of the GNU Lesser General Public License *
+ * as published by the Free Software Foundation; either version 3 of the *
+ * License, or (at your option) any later version. *
+ * *
+ * The Dimension Library 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 *
+ * Lesser General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU Lesser General Public *
+ * License along with this program. If not, see *
+ * <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+/**
+ * @file
+ * Built-in branch profiler.
+ */
+
+#ifndef DIMENSION_IMPL_PROFILE_H
+#define DIMENSION_IMPL_PROFILE_H
+
+#include <stdbool.h>
+
+/**
+ * Record an test and its expected result. Called by dmnsn_[un]likely();
+ * don't call directly.
+ * @param[in] value The result of the test.
+ * @param[in] expected The expected result of the test.
+ * @param[in] func The name of the function the test occurs in.
+ * @param[in] file The name of the file the test occurs in.
+ * @param[in] line The line number on which the test occurs.
+ * @return \p value.
+ */
+bool dmnsn_expect(bool result, bool expected,
+ const char *func, const char *file, unsigned int line);
+
+#endif /* DIMENSION_IMPL_PROFILE_H */