65e79ebfe0467edc14097b3d28ff2bdade04c702
[ffmpeg.git] / tools / target_dec_fuzzer.c
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /* Targeted fuzzer that targets specific codecs depending on two
20    compile-time flags.
21   INSTRUCTIONS:
22
23   * Get the very fresh clang, e.g. see http://libfuzzer.info#versions
24   * Get and build libFuzzer:
25      svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
26      ./Fuzzer/build.sh
27   * build ffmpeg for fuzzing:
28     FLAGS="-fsanitize=address -fsanitize-coverage=trace-pc-guard,trace-cmp -g" CC="clang $FLAGS" CXX="clang++ $FLAGS" ./configure  --disable-yasm
29     make clean && make -j
30   * build the fuzz target.
31     Choose the value of FFMPEG_CODEC (e.g. AV_CODEC_ID_DVD_SUBTITLE) and
32     choose one of FUZZ_FFMPEG_VIDEO, FUZZ_FFMPEG_AUDIO, FUZZ_FFMPEG_SUBTITLE.
33     clang -fsanitize=address -fsanitize-coverage=trace-pc-guard,trace-cmp tools/target_dec_fuzzer.c -o target_dec_fuzzer -I.   -DFFMPEG_CODEC=AV_CODEC_ID_MPEG1VIDEO -DFUZZ_FFMPEG_VIDEO ../../libfuzzer/libFuzzer.a   -Llibavcodec -Llibavdevice -Llibavfilter -Llibavformat -Llibavresample -Llibavutil -Llibpostproc -Llibswscale -Llibswresample -Wl,--as-needed -Wl,-z,noexecstack -Wl,--warn-common -Wl,-rpath-link=libpostproc:libswresample:libswscale:libavfilter:libavdevice:libavformat:libavcodec:libavutil:libavresample -lavdevice -lavfilter -lavformat -lavcodec -lswresample -lswscale -lavutil -ldl -lxcb -lxcb-shm -lxcb -lxcb-xfixes  -lxcb -lxcb-shape -lxcb -lX11 -lasound -lm -lbz2 -lz -pthread
34   * create a corpus directory and put some samples there (empty dir is ok too):
35     mkdir CORPUS && cp some-files CORPUS
36
37   * Run fuzzing:
38     ./target_dec_fuzzer -max_len=100000 CORPUS
39
40    More info:
41    http://libfuzzer.info
42    http://tutorial.libfuzzer.info
43    https://github.com/google/oss-fuzz
44    http://lcamtuf.coredump.cx/afl/
45    https://security.googleblog.com/2016/08/guided-in-process-fuzzing-of-chrome.html
46 */
47
48 #include "config.h"
49 #include "libavutil/avassert.h"
50 #include "libavutil/imgutils.h"
51 #include "libavutil/intreadwrite.h"
52
53 #include "libavcodec/avcodec.h"
54 #include "libavcodec/bytestream.h"
55 #include "libavformat/avformat.h"
56
57 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size);
58
59 static void error(const char *err)
60 {
61     fprintf(stderr, "%s", err);
62     exit(1);
63 }
64
65 static AVCodec *c = NULL;
66 static AVCodec *AVCodecInitialize(enum AVCodecID codec_id)
67 {
68     AVCodec *res;
69     avcodec_register_all();
70     av_log_set_level(AV_LOG_PANIC);
71     res = avcodec_find_decoder(codec_id);
72     if (!res)
73         error("Failed to find decoder");
74     return res;
75 }
76
77 static int subtitle_handler(AVCodecContext *avctx, void *frame,
78                             int *got_sub_ptr, AVPacket *avpkt)
79 {
80     AVSubtitle sub;
81     int ret = avcodec_decode_subtitle2(avctx, &sub, got_sub_ptr, avpkt);
82     if (ret >= 0 && *got_sub_ptr)
83         avsubtitle_free(&sub);
84     return ret;
85 }
86
87 // Class to handle buffer allocation and resize for each frame
88 typedef struct FuzzDataBuffer {
89     size_t size_;
90     uint8_t *data_;
91 } FuzzDataBuffer;
92
93 static void FDBCreate(FuzzDataBuffer *FDB) {
94     FDB->size_ = 0x1000;
95     FDB->data_ = av_malloc(FDB->size_);
96     if (!FDB->data_)
97         error("Failed memory allocation");
98 }
99
100 static void FDBDesroy(FuzzDataBuffer *FDB) { av_free(FDB->data_); }
101
102 static void FDBRealloc(FuzzDataBuffer *FDB, size_t size) {
103     size_t needed = size + FF_INPUT_BUFFER_PADDING_SIZE;
104     av_assert0(needed > size);
105     if (needed > FDB->size_) {
106         av_free(FDB->data_);
107         FDB->size_ = needed;
108         FDB->data_ = av_malloc(FDB->size_);
109         if (!FDB->data_)
110             error("Failed memory allocation");
111     }
112 }
113
114 static void FDBPrepare(FuzzDataBuffer *FDB, AVPacket *dst, const uint8_t *data,
115                 size_t size)
116 {
117     FDBRealloc(FDB, size);
118     memcpy(FDB->data_, data, size);
119     size_t padd = FDB->size_ - size;
120     if (padd > FF_INPUT_BUFFER_PADDING_SIZE)
121         padd = FF_INPUT_BUFFER_PADDING_SIZE;
122     memset(FDB->data_ + size, 0, padd);
123     av_init_packet(dst);
124     dst->data = FDB->data_;
125     dst->size = size;
126 }
127
128 // Ensure we don't loop forever
129 const uint32_t maxiteration = 8096;
130
131 static const uint64_t FUZZ_TAG = 0x4741542D5A5A5546ULL;
132
133 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
134     const uint64_t fuzz_tag = FUZZ_TAG;
135     FuzzDataBuffer buffer;
136     const uint8_t *last = data;
137     const uint8_t *end = data + size;
138     uint32_t it = 0;
139     int (*decode_handler)(AVCodecContext *avctx, AVFrame *picture,
140                           int *got_picture_ptr,
141                           const AVPacket *avpkt) = NULL;
142
143     if (!c)
144         c = AVCodecInitialize(FFMPEG_CODEC);  // Done once.
145
146     switch (c->type) {
147     case AVMEDIA_TYPE_AUDIO   : decode_handler = avcodec_decode_audio4; break;
148     case AVMEDIA_TYPE_VIDEO   : decode_handler = avcodec_decode_video2; break;
149     case AVMEDIA_TYPE_SUBTITLE: decode_handler = subtitle_handler     ; break;
150     }
151
152     AVCodecContext* ctx = avcodec_alloc_context3(NULL);
153     if (!ctx)
154         error("Failed memory allocation");
155
156     ctx->max_pixels = 4096 * 4096; //To reduce false positive OOM and hangs
157
158     if (size > 1024) {
159         GetByteContext gbc;
160         bytestream2_init(&gbc, data + size - 1024, 1024);
161         ctx->width                              = bytestream2_get_le32(&gbc);
162         ctx->height                             = bytestream2_get_le32(&gbc);
163         ctx->bit_rate                           = bytestream2_get_le64(&gbc);
164         ctx->bits_per_coded_sample              = bytestream2_get_le32(&gbc);
165         if (av_image_check_size(ctx->width, ctx->height, 0, ctx))
166             ctx->width = ctx->height = 0;
167         size -= 1024;
168     }
169
170     int res = avcodec_open2(ctx, c, NULL);
171     if (res < 0)
172         return 0; // Failure of avcodec_open2() does not imply that a issue was found
173
174     FDBCreate(&buffer);
175     int got_frame;
176     AVFrame *frame = av_frame_alloc();
177     if (!frame)
178         error("Failed memory allocation");
179
180     // Read very simple container
181     AVPacket avpkt;
182     while (data < end && it < maxiteration) {
183         // Search for the TAG
184         while (data + sizeof(fuzz_tag) < end) {
185             if (data[0] == (fuzz_tag & 0xFF) && AV_RN64(data) == fuzz_tag)
186                 break;
187             data++;
188         }
189         if (data + sizeof(fuzz_tag) > end)
190             data = end;
191
192         FDBPrepare(&buffer, &avpkt, last, data - last);
193         data += sizeof(fuzz_tag);
194         last = data;
195
196         // Iterate through all data
197         while (avpkt.size > 0 && it++ < maxiteration) {
198             av_frame_unref(frame);
199             int ret = decode_handler(ctx, frame, &got_frame, &avpkt);
200
201             if (it > 20)
202                 ctx->error_concealment = 0;
203
204             if (ret <= 0 || ret > avpkt.size)
205                break;
206             if (ctx->codec_type != AVMEDIA_TYPE_AUDIO)
207                 ret = avpkt.size;
208             avpkt.data += ret;
209             avpkt.size -= ret;
210         }
211     }
212
213     av_init_packet(&avpkt);
214     avpkt.data = NULL;
215     avpkt.size = 0;
216
217     do {
218         got_frame = 0;
219         decode_handler(ctx, frame, &got_frame, &avpkt);
220     } while (got_frame == 1 && it++ < maxiteration);
221
222     av_frame_free(&frame);
223     avcodec_free_context(&ctx);
224     av_freep(&ctx);
225     FDBDesroy(&buffer);
226     return 0;
227 }