1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#ifndef FD_BUFFER_H
#define FD_BUFFER_H
#include <android-base/unique_fd.h>
#include <android/util/EncodedBuffer.h>
#include <utils/Errors.h>
namespace android {
namespace os {
namespace incidentd {
using namespace android::base;
using namespace android::util;
/**
* Reads data from fd into a buffer, fd must be closed explicitly.
*/
class FdBuffer {
public:
FdBuffer();
FdBuffer(sp<EncodedBuffer> buffer, bool isBufferPooled = false);
~FdBuffer();
/**
* Read the data until the timeout is hit or we hit eof.
* Returns NO_ERROR if there were no errors or if we timed out.
* Will mark the file O_NONBLOCK.
*/
status_t read(int fd, int64_t timeoutMs);
/**
* Read the data until we hit eof.
* Returns NO_ERROR if there were no errors.
*/
status_t readFully(int fd);
/**
* Read processed results by streaming data to a parsing process, e.g. incident helper.
* The parsing process provides IO fds which are 'toFd' and 'fromFd'. The function
* reads original data in 'fd' and writes to parsing process through 'toFd', then it reads
* and stores the processed data from 'fromFd' in memory for later usage.
* This function behaves in a streaming fashion in order to save memory usage.
* Returns NO_ERROR if there were no errors or if we timed out.
*
* Poll will return POLLERR if fd is from sysfs, handle this edge case.
*/
status_t readProcessedDataInStream(int fd, unique_fd toFd, unique_fd fromFd, int64_t timeoutMs,
const bool isSysfs = false);
/**
* Write by hand into the buffer.
*/
status_t write(uint8_t const* buf, size_t size);
/**
* Write all the data from a ProtoReader into our internal buffer.
*/
status_t write(const sp<ProtoReader>& data);
/**
* Write size bytes of data from a ProtoReader into our internal buffer.
*/
status_t write(const sp<ProtoReader>& data, size_t size);
/**
* Whether we timed out.
*/
bool timedOut() const { return mTimedOut; }
/**
* If more than 4 MB is read, we truncate the data and return success.
* Downstream tools must handle truncated incident reports as best as possible
* anyway because they could be cut off for a lot of reasons and it's best
* to get as much useful information out of the system as possible. If this
* happens, truncated() will return true so it can be marked. If the data is
* exactly 4 MB, truncated is still set. Sorry.
*/
bool truncated() const { return mTruncated; }
/**
* How much data was read.
*/
size_t size() const;
/**
* How long the read took in milliseconds.
*/
int64_t durationMs() const { return mFinishTime - mStartTime; }
/**
* Get the EncodedBuffer inside.
*/
sp<EncodedBuffer> data() const;
private:
sp<EncodedBuffer> mBuffer;
int64_t mStartTime;
int64_t mFinishTime;
bool mTimedOut;
bool mTruncated;
bool mIsBufferPooled;
};
} // namespace incidentd
} // namespace os
} // namespace android
#endif // FD_BUFFER_H
|
