Skip to content

Fix random crashing of ClientContext::write(Stream) and write_P(PGM_P buf, size_t size) (#2504) #4530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Mar 22, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 49 additions & 12 deletions libraries/ESP8266WiFi/src/include/DataSource.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ class BufferDataSource : public DataSource {

const uint8_t* get_buffer(size_t size) override
{
(void) size;
(void)size;
assert(_pos + size <= _size);
return _data + _pos;
}

void release_buffer(const uint8_t* buffer, size_t size) override
{
(void) buffer;
(void)buffer;
assert(buffer == _data + _pos);
_pos += size;
}
Expand Down Expand Up @@ -66,28 +66,65 @@ class BufferedStreamDataSource : public DataSource {
const uint8_t* get_buffer(size_t size) override
{
assert(_pos + size <= _size);
if (_bufferSize < size) {
_buffer.reset(new uint8_t[size]);
_bufferSize = size;

//Data that was already read from the stream but not released (e.g. if tcp_write error occured). Otherwise this should be 0.
const size_t stream_read = _streamPos - _pos;

//Min required buffer size: max(requested size, previous stream data already in buffer)
const size_t min_buffer_size = size > stream_read ? size : stream_read;

//Buffer too small?
if (_bufferSize < min_buffer_size) {
uint8_t *new_buffer = new uint8_t[min_buffer_size];
//If stream reading is ahead, than some data is already in the old buffer and needs to be copied to new resized buffer
if (_buffer && stream_read > 0) {
memcpy(new_buffer, _buffer.get(), stream_read);
}
_buffer.reset(new_buffer);
_bufferSize = min_buffer_size;
}

//Fetch remaining data from stream
//If error in tcp_write in ClientContext::_write_some() occured earlier and therefore release_buffer was not called last time, than the requested stream data is already in the buffer.
if (size > stream_read) {
//Remaining bytes to read from stream
const size_t stream_rem = size - stream_read;
const size_t cb = _stream.readBytes(reinterpret_cast<char*>(_buffer.get() + stream_read), stream_rem);
assert(cb == stream_rem);
(void)cb;
_streamPos += stream_rem;
}
size_t cb = _stream.readBytes(reinterpret_cast<char*>(_buffer.get()), size);
assert(cb == size);
(void) cb;
return _buffer.get();

}

void release_buffer(const uint8_t* buffer, size_t size) override
{
(void) buffer;
_pos += size;
if (size == 0) {
return;
}

(void)buffer;
_pos += size;

//Cannot release more than acquired through get_buffer
assert(_pos <= _streamPos);

//Release less than requested with get_buffer?
if (_pos < _streamPos) {
// Move unreleased stream data in buffer to front
assert(_buffer);
memmove(_buffer.get(), _buffer.get() + size, _streamPos - _pos);
}
}

protected:
TStream& _stream;
TStream & _stream;
std::unique_ptr<uint8_t[]> _buffer;
size_t _size;
size_t _pos = 0;
size_t _bufferSize = 0;
size_t _streamPos = 0;
};

class ProgmemStream
Expand All @@ -104,7 +141,7 @@ class ProgmemStream
size_t will_read = (_left < size) ? _left : size;
memcpy_P((void*)dst, (PGM_VOID_P)_buf, will_read);
_left -= will_read;
_buf += will_read;
_buf += will_read;
return will_read;
}

Expand Down