summaryrefslogtreecommitdiff
path: root/lib/ccan/likely/_info
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ccan/likely/_info')
-rw-r--r--lib/ccan/likely/_info45
1 files changed, 45 insertions, 0 deletions
diff --git a/lib/ccan/likely/_info b/lib/ccan/likely/_info
new file mode 100644
index 0000000000..471c1ffc78
--- /dev/null
+++ b/lib/ccan/likely/_info
@@ -0,0 +1,45 @@
+#include <string.h>
+#include <stdio.h>
+#include "config.h"
+
+/**
+ * likely - macros for annotating likely/unlikely branches in the code
+ *
+ * Inspired by Andi Kleen's macros for the Linux Kernel, these macros
+ * help you annotate rare paths in your code for the convenience of the
+ * compiler and the reader.
+ *
+ * License: LGPL (2 or any later version)
+ * Author: Rusty Russell <rusty@rustcorp.com.au>
+ *
+ * Example:
+ * #include <ccan/likely/likely.h>
+ * #include <stdio.h>
+ *
+ * int main(int argc, char *argv[])
+ * {
+ * // This example is silly: the compiler knows exit() is unlikely.
+ * if (unlikely(argc == 1)) {
+ * fprintf(stderr, "Usage: %s <args>...\n", argv[0]);
+ * return 1;
+ * }
+ * for (argc++; argv[argc]; argc++)
+ * printf("%s\n", argv[argc]);
+ * return 0;
+ * }
+ */
+int main(int argc, char *argv[])
+{
+ /* Expect exactly one argument */
+ if (argc != 2)
+ return 1;
+
+ if (strcmp(argv[1], "depends") == 0) {
+ printf("ccan/str\n");
+ printf("ccan/htable\n");
+ printf("ccan/hash\n");
+ return 0;
+ }
+
+ return 1;
+}