43442a36160cedf7dac16db788a2ac5659529646
[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 "libavutil/avassert.h"
49 #include "libavutil/intreadwrite.h"
50
51 #include "libavcodec/avcodec.h"
52 #include "libavcodec/bytestream.h"
53 #include "libavformat/avformat.h"
54
55 static void error(const char *err)
56 {
57     fprintf(stderr, "%s", err);
58     exit(1);
59 }
60
61 static AVCodec *c = NULL;
62 static AVCodec *AVCodecInitialize(enum AVCodecID codec_id)
63 {
64     AVCodec *res;
65     av_register_all();
66     av_log_set_level(AV_LOG_PANIC);
67     res = avcodec_find_decoder(codec_id);
68     if (!res)
69         error("Failed to find decoder");
70     return res;
71 }
72
73 #if defined(FUZZ_FFMPEG_VIDEO)
74 #define decode_handler avcodec_decode_video2
75 #elif defined(FUZZ_FFMPEG_AUDIO)
76 #define decode_handler avcodec_decode_audio4
77 #elif defined(FUZZ_FFMPEG_SUBTITLE)
78 static int subtitle_handler(AVCodecContext *avctx, void *frame,
79                             int *got_sub_ptr, AVPacket *avpkt)
80 {
81     AVSubtitle sub;
82     int ret = avcodec_decode_subtitle2(avctx, &sub, got_sub_ptr, avpkt);
83     if (ret >= 0 && *got_sub_ptr)
84         avsubtitle_free(&sub);
85     return ret;
86 }
87
88 #define decode_handler subtitle_handler
89 #else
90 #error "Specify encoder type"  // To catch mistakes
91 #endif
92
93 // Class to handle buffer allocation and resize for each frame
94 typedef struct FuzzDataBuffer {
95     size_t size_;
96     uint8_t *data_;
97 } FuzzDataBuffer;
98
99 void FDBCreate(FuzzDataBuffer *FDB) {
100     FDB->size_ = 0x1000;
101     FDB->data_ = av_malloc(FDB->size_);
102     if (!FDB->data_)
103         error("Failed memory allocation");
104 }
105
106 void FDBDesroy(FuzzDataBuffer *FDB) { av_free(FDB->data_); }
107
108 void FDBRealloc(FuzzDataBuffer *FDB, size_t size) {
109     size_t needed = size + FF_INPUT_BUFFER_PADDING_SIZE;
110     av_assert0(needed > size);
111     if (needed > FDB->size_) {
112         av_free(FDB->data_);
113         FDB->size_ = needed;
114         FDB->data_ = av_malloc(FDB->size_);
115         if (!FDB->data_)
116             error("Failed memory allocation");
117     }
118 }
119
120 void FDBPrepare(FuzzDataBuffer *FDB, AVPacket *dst, const uint8_t *data,
121                 size_t size)
122 {
123     FDBRealloc(FDB, size);
124     memcpy(FDB->data_, data, size);
125     size_t padd = FDB->size_ - size;
126     if (padd > FF_INPUT_BUFFER_PADDING_SIZE)
127         padd = FF_INPUT_BUFFER_PADDING_SIZE;
128     memset(FDB->data_ + size, 0, padd);
129     av_init_packet(dst);
130     dst->data = FDB->data_;
131     dst->size = size;
132 }
133
134 // Ensure we don't loop forever
135 const uint32_t maxiteration = 8096;
136
137 static const uint64_t FUZZ_TAG = 0x4741542D5A5A5546ULL;
138
139 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
140     const uint64_t fuzz_tag = FUZZ_TAG;
141     FuzzDataBuffer buffer;
142     const uint8_t *last = data;
143     const uint8_t *end = data + size;
144     uint32_t it = 0;
145
146     if (!c)
147         c = AVCodecInitialize(FFMPEG_CODEC);  // Done once.
148
149     AVCodecContext* ctx = avcodec_alloc_context3(NULL);
150     if (!ctx)
151         error("Failed memory allocation");
152
153     ctx->max_pixels = 4096 * 4096; //To reduce false positive OOM and hangs
154
155     if (size > 1024) {
156         GetByteContext gbc;
157         bytestream2_init(&gbc, data + size - 1024, 1024);
158         ctx->width                              = bytestream2_get_le32(&gbc);
159         ctx->height                             = bytestream2_get_le32(&gbc);
160         ctx->bit_rate                           = bytestream2_get_le64(&gbc);
161         ctx->bits_per_coded_sample              = bytestream2_get_le32(&gbc);
162         if (av_image_check_size(ctx->width, ctx->height, 0, ctx))
163             ctx->width = ctx->height = 0;
164         size -= 1024;
165     }
166
167     int res = avcodec_open2(ctx, c, NULL);
168     if (res < 0)
169         return res;
170
171     FDBCreate(&buffer);
172     int got_frame;
173     AVFrame *frame = av_frame_alloc();
174     if (!frame)
175         error("Failed memory allocation");
176
177     // Read very simple container
178     AVPacket avpkt;
179     while (data < end && it < maxiteration) {
180         // Search for the TAG
181         while (data + sizeof(fuzz_tag) < end) {
182             if (data[0] == (fuzz_tag & 0xFF) && AV_RN64(data) == fuzz_tag)
183                 break;
184             data++;
185         }
186         if (data + sizeof(fuzz_tag) > end)
187             data = end;
188
189         FDBPrepare(&buffer, &avpkt, last, data - last);
190         data += sizeof(fuzz_tag);
191         last = data;
192
193         // Iterate through all data
194         while (avpkt.size > 0 && it++ < maxiteration) {
195             av_frame_unref(frame);
196             int ret = decode_handler(ctx, frame, &got_frame, &avpkt);
197
198             if (it > 20)
199                 ctx->error_concealment = 0;
200
201             if (ret <= 0 || ret > avpkt.size)
202                break;
203             if (ctx->codec_type != AVMEDIA_TYPE_AUDIO)
204                 ret = avpkt.size;
205             avpkt.data += ret;
206             avpkt.size -= ret;
207         }
208     }
209
210     av_init_packet(&avpkt);
211     avpkt.data = NULL;
212     avpkt.size = 0;
213
214     do {
215         got_frame = 0;
216         decode_handler(ctx, frame, &got_frame, &avpkt);
217     } while (got_frame == 1 && it++ < maxiteration);
218
219     av_frame_free(&frame);
220     avcodec_free_context(&ctx);
221     av_freep(&ctx);
222     FDBDesroy(&buffer);
223     return 0;
224 }