summaryrefslogtreecommitdiff
path: root/docs/analyzer/checkers/unix_malloc_example.c
diff options
context:
space:
mode:
authorKristof Umann <dkszelethus@gmail.com>2019-02-05 00:39:33 +0000
committerKristof Umann <dkszelethus@gmail.com>2019-02-05 00:39:33 +0000
commit0ee689c80313bed6e234367ea69d081d6a35bf25 (patch)
treee6069ac1b494bddfca81bedf20db8178c92de615 /docs/analyzer/checkers/unix_malloc_example.c
parent24c8a9a6ae8d231295b8deca1c1a47920e326fe5 (diff)
downloadclang-0ee689c80313bed6e234367ea69d081d6a35bf25.tar.gz
[analyzer] Creating standard Sphinx documentation
The lack of documentation has been a long standing issue in the Static Analyzer, and one of the leading reasons behind this was a lack of good documentation infrastucture. This lead serious drawbacks, such as * Not having proper release notes for years * Not being able to have a sensible auto-generated checker documentations (which lead to most of them not having any) * The HTML website that has to updated manually is a chore, and has been outdated for a long while * Many design discussions are now hidden in phabricator revisions This patch implements a new documentation infrastucture using Sphinx, like most of the other subprojects in LLVM. It transformed some pages as a proof-of- concept, with many others to follow in later patches. The eventual goal is to preserve the original website's (https://clang-analyzer.llvm.org/) frontpage, but move everything else to the new format. Some other ideas, like creating a unipage for each checker (similar to how clang-tidy works now), are also being discussed. Patch by Dániel Krupp! Differential Revision: https://reviews.llvm.org/D54429 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@353126 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/analyzer/checkers/unix_malloc_example.c')
-rw-r--r--docs/analyzer/checkers/unix_malloc_example.c30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/analyzer/checkers/unix_malloc_example.c b/docs/analyzer/checkers/unix_malloc_example.c
new file mode 100644
index 0000000000..68c5a4a8f1
--- /dev/null
+++ b/docs/analyzer/checkers/unix_malloc_example.c
@@ -0,0 +1,30 @@
+
+void test() {
+ int *p = malloc(1);
+ free(p);
+ free(p); // warn: attempt to free released memory
+}
+
+void test() {
+ int *p = malloc(sizeof(int));
+ free(p);
+ *p = 1; // warn: use after free
+}
+
+void test() {
+ int *p = malloc(1);
+ if (p)
+ return; // warn: memory is never released
+}
+
+void test() {
+ int a[] = { 1 };
+ free(a); // warn: argument is not allocated by malloc
+}
+
+void test() {
+ int *p = malloc(sizeof(char));
+ p = p - 1;
+ free(p); // warn: argument to free() is offset by -4 bytes
+}
+