Add ASSERT_WITH_SECURITY_IMPLICATION to detect out of bounds access
[WebKit-https.git] / Source / WTF / wtf / StringPrintStream.cpp
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "StringPrintStream.h"
28
29 #include <stdarg.h>
30 #include <stdio.h>
31 #include <wtf/FastMalloc.h>
32 #include <wtf/StringExtras.h>
33
34 namespace WTF {
35
36 StringPrintStream::StringPrintStream()
37     : m_buffer(m_inlineBuffer)
38     , m_next(0)
39     , m_size(sizeof(m_inlineBuffer))
40 {
41     m_buffer[0] = 0; // Make sure that we always have a null terminator.
42 }
43
44 StringPrintStream::~StringPrintStream()
45 {
46     if (m_buffer == m_inlineBuffer)
47         return;
48     fastFree(m_buffer);
49 }
50
51 void StringPrintStream::vprintf(const char* format, va_list argList)
52 {
53     ASSERT_WITH_SECURITY_IMPLICATION(m_next < m_size);
54     ASSERT(!m_buffer[m_next]);
55     
56     va_list firstPassArgList;
57 #if OS(WINDOWS)
58     firstPassArgList = argList;
59 #else
60     va_copy(firstPassArgList, argList);
61 #endif
62     
63     int numberOfBytesNotIncludingTerminatorThatWouldHaveBeenWritten =
64         vsnprintf(m_buffer + m_next, m_size - m_next, format, firstPassArgList);
65     
66     int numberOfBytesThatWouldHaveBeenWritten =
67         numberOfBytesNotIncludingTerminatorThatWouldHaveBeenWritten + 1;
68     
69     if (m_next + numberOfBytesThatWouldHaveBeenWritten <= m_size) {
70         m_next += numberOfBytesNotIncludingTerminatorThatWouldHaveBeenWritten;
71         return; // This means that vsnprintf() succeeded.
72     }
73     
74     increaseSize(m_next + numberOfBytesThatWouldHaveBeenWritten);
75     
76     int numberOfBytesNotIncludingTerminatorThatWereWritten =
77         vsnprintf(m_buffer + m_next, m_size - m_next, format, argList);
78     
79     int numberOfBytesThatWereWritten = numberOfBytesNotIncludingTerminatorThatWereWritten + 1;
80     
81     ASSERT_UNUSED(numberOfBytesThatWereWritten, m_next + numberOfBytesThatWereWritten <= m_size);
82     
83     m_next += numberOfBytesNotIncludingTerminatorThatWereWritten;
84     
85     ASSERT_WITH_SECURITY_IMPLICATION(m_next < m_size);
86     ASSERT(!m_buffer[m_next]);
87 }
88
89 CString StringPrintStream::toCString()
90 {
91     ASSERT(m_next == strlen(m_buffer));
92     return CString(m_buffer, m_next);
93 }
94
95 void StringPrintStream::reset()
96 {
97     m_next = 0;
98     m_buffer[0] = 0;
99 }
100
101 String StringPrintStream::toString()
102 {
103     ASSERT(m_next == strlen(m_buffer));
104     return String::fromUTF8(m_buffer, m_next);
105 }
106
107 void StringPrintStream::increaseSize(size_t newSize)
108 {
109     ASSERT(newSize > m_size);
110     ASSERT(newSize > sizeof(m_inlineBuffer));
111     
112     // Use exponential resizing to reduce thrashing.
113     m_size = newSize << 1;
114     
115     // Use fastMalloc instead of fastRealloc because we know that for the sizes we're using,
116     // fastRealloc will just do malloc+free anyway. Also, this simplifies the code since
117     // we can't realloc the inline buffer.
118     char* newBuffer = static_cast<char*>(fastMalloc(m_size));
119     memcpy(newBuffer, m_buffer, m_next + 1);
120     if (m_buffer != m_inlineBuffer)
121         fastFree(m_buffer);
122     m_buffer = newBuffer;
123 }
124
125 } // namespace WTF
126