9dd6a5ef0bfc4eb63dadec449409ed7cde9e3d5f
[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-x86asm
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 extern AVCodec * codec_list[];
60
61 static void error(const char *err)
62 {
63     fprintf(stderr, "%s", err);
64     exit(1);
65 }
66
67 static AVCodec *c = NULL;
68 static AVCodec *AVCodecInitialize(enum AVCodecID codec_id)
69 {
70     AVCodec *res;
71
72     res = avcodec_find_decoder(codec_id);
73     if (!res)
74         error("Failed to find decoder");
75     return res;
76 }
77
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 // Ensure we don't loop forever
89 const uint32_t maxiteration = 8096;
90 const uint64_t maxpixels_per_frame = 4096 * 4096;
91 uint64_t maxpixels;
92
93 static const uint64_t FUZZ_TAG = 0x4741542D5A5A5546ULL;
94
95 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
96     const uint64_t fuzz_tag = FUZZ_TAG;
97     const uint8_t *last = data;
98     const uint8_t *end = data + size;
99     uint32_t it = 0;
100     uint64_t ec_pixels = 0;
101     int (*decode_handler)(AVCodecContext *avctx, AVFrame *picture,
102                           int *got_picture_ptr,
103                           const AVPacket *avpkt) = NULL;
104     AVCodecParserContext *parser = NULL;
105
106
107     if (!c) {
108 #ifdef FFMPEG_DECODER
109 #define DECODER_SYMBOL0(CODEC) ff_##CODEC##_decoder
110 #define DECODER_SYMBOL(CODEC) DECODER_SYMBOL0(CODEC)
111         extern AVCodec DECODER_SYMBOL(FFMPEG_DECODER);
112         codec_list[0] = &DECODER_SYMBOL(FFMPEG_DECODER);
113         avcodec_register(&DECODER_SYMBOL(FFMPEG_DECODER));
114
115         c = &DECODER_SYMBOL(FFMPEG_DECODER);
116 #else
117         avcodec_register_all();
118         c = AVCodecInitialize(FFMPEG_CODEC);  // Done once.
119 #endif
120         av_log_set_level(AV_LOG_PANIC);
121     }
122
123     switch (c->type) {
124     case AVMEDIA_TYPE_AUDIO   : decode_handler = avcodec_decode_audio4; break;
125     case AVMEDIA_TYPE_VIDEO   : decode_handler = avcodec_decode_video2; break;
126     case AVMEDIA_TYPE_SUBTITLE: decode_handler = subtitle_handler     ; break;
127     }
128     maxpixels = maxpixels_per_frame * maxiteration;
129     switch (c->id) {
130         // Allows a small input to generate gigantic output
131     case AV_CODEC_ID_MSRLE:     maxpixels /= 16;  break;
132     case AV_CODEC_ID_QTRLE:     maxpixels /= 16;  break;
133     case AV_CODEC_ID_GIF:       maxpixels /= 16;  break;
134         // Performs slow frame rescaling in C
135     case AV_CODEC_ID_GDV:       maxpixels /= 256; break;
136         // Postprocessing in C
137     case AV_CODEC_ID_HNM4_VIDEO:maxpixels /= 128; break;
138     }
139
140
141     AVCodecContext* ctx = avcodec_alloc_context3(c);
142     AVCodecContext* parser_avctx = avcodec_alloc_context3(NULL);
143     if (!ctx || !parser_avctx)
144         error("Failed memory allocation");
145
146     if (ctx->max_pixels == 0 || ctx->max_pixels > maxpixels_per_frame)
147         ctx->max_pixels = maxpixels_per_frame; //To reduce false positive OOM and hangs
148     ctx->refcounted_frames = 1; //To reduce false positive timeouts and focus testing on the refcounted API
149
150     if (size > 1024) {
151         GetByteContext gbc;
152         int extradata_size;
153         size -= 1024;
154         bytestream2_init(&gbc, data + size, 1024);
155         ctx->width                              = bytestream2_get_le32(&gbc);
156         ctx->height                             = bytestream2_get_le32(&gbc);
157         ctx->bit_rate                           = bytestream2_get_le64(&gbc);
158         ctx->bits_per_coded_sample              = bytestream2_get_le32(&gbc);
159         // Try to initialize a parser for this codec, note, this may fail which just means we test without one
160         if (bytestream2_get_byte(&gbc) & 1)
161             parser = av_parser_init(c->id);
162
163         extradata_size = bytestream2_get_le32(&gbc);
164         if (extradata_size < size) {
165             ctx->extradata = av_mallocz(extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
166             if (ctx->extradata) {
167                 ctx->extradata_size = extradata_size;
168                 size -= ctx->extradata_size;
169                 memcpy(ctx->extradata, data + size, ctx->extradata_size);
170             }
171         }
172         if (av_image_check_size(ctx->width, ctx->height, 0, ctx))
173             ctx->width = ctx->height = 0;
174     }
175
176     int res = avcodec_open2(ctx, c, NULL);
177     if (res < 0) {
178         avcodec_free_context(&ctx);
179         av_free(parser_avctx);
180         av_parser_close(parser);
181         return 0; // Failure of avcodec_open2() does not imply that a issue was found
182     }
183     parser_avctx->codec_id = ctx->codec_id;
184
185     int got_frame;
186     AVFrame *frame = av_frame_alloc();
187     if (!frame)
188         error("Failed memory allocation");
189
190     // Read very simple container
191     AVPacket avpkt, parsepkt;
192     av_init_packet(&avpkt);
193     while (data < end && it < maxiteration) {
194         // Search for the TAG
195         while (data + sizeof(fuzz_tag) < end) {
196             if (data[0] == (fuzz_tag & 0xFF) && AV_RN64(data) == fuzz_tag)
197                 break;
198             data++;
199         }
200         if (data + sizeof(fuzz_tag) > end)
201             data = end;
202
203         res = av_new_packet(&parsepkt, data - last);
204         if (res < 0)
205             error("Failed memory allocation");
206         memcpy(parsepkt.data, last, data - last);
207         data += sizeof(fuzz_tag);
208         last = data;
209
210         while (parsepkt.size > 0) {
211
212             if (parser) {
213                 av_init_packet(&avpkt);
214                 int ret = av_parser_parse2(parser, parser_avctx, &avpkt.data, &avpkt.size,
215                                            parsepkt.data, parsepkt.size,
216                                            parsepkt.pts, parsepkt.dts, parsepkt.pos);
217                 if (avpkt.data == parsepkt.data) {
218                     avpkt.buf = av_buffer_ref(parsepkt.buf);
219                     if (!avpkt.buf)
220                         error("Failed memory allocation");
221                 } else {
222                     if (av_packet_make_refcounted(&avpkt) < 0)
223                         error("Failed memory allocation");
224                 }
225                 parsepkt.data += ret;
226                 parsepkt.size -= ret;
227                 parsepkt.pos  += ret;
228                 avpkt.pts = parser->pts;
229                 avpkt.dts = parser->dts;
230                 avpkt.pos = parser->pos;
231                 if ( parser->key_frame == 1 ||
232                     (parser->key_frame == -1 && parser->pict_type == AV_PICTURE_TYPE_I))
233                     avpkt.flags |= AV_PKT_FLAG_KEY;
234                 avpkt.flags |= parsepkt.flags & AV_PKT_FLAG_DISCARD;
235             } else {
236                 av_packet_move_ref(&avpkt, &parsepkt);
237             }
238
239           // Iterate through all data
240           while (avpkt.size > 0 && it++ < maxiteration) {
241             av_frame_unref(frame);
242             int ret = decode_handler(ctx, frame, &got_frame, &avpkt);
243
244             ec_pixels += ctx->width * ctx->height;
245             if (it > 20 || ec_pixels > 4 * ctx->max_pixels)
246                 ctx->error_concealment = 0;
247             if (ec_pixels > maxpixels)
248                 goto maximums_reached;
249
250             if (ret <= 0 || ret > avpkt.size)
251                break;
252             if (ctx->codec_type != AVMEDIA_TYPE_AUDIO)
253                 ret = avpkt.size;
254             avpkt.data += ret;
255             avpkt.size -= ret;
256           }
257           av_packet_unref(&avpkt);
258         }
259         av_packet_unref(&parsepkt);
260     }
261 maximums_reached:
262
263     av_packet_unref(&avpkt);
264
265     do {
266         got_frame = 0;
267         av_frame_unref(frame);
268         decode_handler(ctx, frame, &got_frame, &avpkt);
269     } while (got_frame == 1 && it++ < maxiteration);
270
271     fprintf(stderr, "pixels decoded: %"PRId64", iterations: %d\n", ec_pixels, it);
272
273     av_frame_free(&frame);
274     avcodec_free_context(&ctx);
275     avcodec_free_context(&parser_avctx);
276     av_parser_close(parser);
277     av_packet_unref(&parsepkt);
278     return 0;
279 }