Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Jonas Olsson | a4d8737 | 2019-07-05 19:08:33 +0200 | [diff] [blame] | 11 | #include "api/rtc_event_log_output_file.h" |
| 12 | |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 13 | #include <limits> |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 14 | #include <utility> |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 15 | |
Danil Chapovalov | b32f2c7 | 2019-05-22 13:39:25 +0200 | [diff] [blame] | 16 | #include "api/rtc_event_log/rtc_event_log.h" |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 17 | #include "rtc_base/checks.h" |
| 18 | #include "rtc_base/logging.h" |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 19 | |
| 20 | namespace webrtc { |
| 21 | |
| 22 | // Together with the assumption of no single Write() would ever be called on |
| 23 | // an input with length greater-than-or-equal-to (max(size_t) / 2), this |
| 24 | // guarantees no overflow of the check for remaining file capacity in Write(). |
| 25 | // This does *not* apply to files with unlimited size. |
| 26 | const size_t RtcEventLogOutputFile::kMaxReasonableFileSize = |
| 27 | std::numeric_limits<size_t>::max() / 2; |
| 28 | |
| 29 | RtcEventLogOutputFile::RtcEventLogOutputFile(const std::string& file_name) |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 30 | : RtcEventLogOutputFile(FileWrapper::OpenWriteOnly(file_name), |
| 31 | RtcEventLog::kUnlimitedOutput) {} |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 32 | |
| 33 | RtcEventLogOutputFile::RtcEventLogOutputFile(const std::string& file_name, |
| 34 | size_t max_size_bytes) |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 35 | |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 36 | // Unlike plain fopen, FileWrapper takes care of filename utf8 -> |
| 37 | // wchar conversion on Windows. |
| 38 | : RtcEventLogOutputFile(FileWrapper::OpenWriteOnly(file_name), |
Niels Möller | d4d3990 | 2017-12-07 09:35:23 +0100 | [diff] [blame] | 39 | max_size_bytes) {} |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 40 | |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 41 | RtcEventLogOutputFile::RtcEventLogOutputFile(FILE* file, size_t max_size_bytes) |
| 42 | : RtcEventLogOutputFile(FileWrapper(file), max_size_bytes) {} |
| 43 | |
| 44 | RtcEventLogOutputFile::RtcEventLogOutputFile(FileWrapper file, |
| 45 | size_t max_size_bytes) |
| 46 | : max_size_bytes_(max_size_bytes), file_(std::move(file)) { |
| 47 | RTC_CHECK_LE(max_size_bytes_, kMaxReasonableFileSize); |
| 48 | if (!file_.is_open()) { |
| 49 | RTC_LOG(LS_ERROR) << "Invalid file. WebRTC event log not started."; |
| 50 | } |
| 51 | } |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 52 | |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 53 | bool RtcEventLogOutputFile::IsActive() const { |
| 54 | return IsActiveInternal(); |
| 55 | } |
| 56 | |
| 57 | bool RtcEventLogOutputFile::Write(const std::string& output) { |
| 58 | RTC_DCHECK(IsActiveInternal()); |
| 59 | // No single write may be so big, that it would risk overflowing the |
| 60 | // calculation of (written_bytes_ + output.length()). |
| 61 | RTC_DCHECK_LT(output.length(), kMaxReasonableFileSize); |
| 62 | |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 63 | if (max_size_bytes_ == RtcEventLog::kUnlimitedOutput || |
| 64 | written_bytes_ + output.length() <= max_size_bytes_) { |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 65 | if (file_.Write(output.c_str(), output.size())) { |
Niels Möller | d4d3990 | 2017-12-07 09:35:23 +0100 | [diff] [blame] | 66 | written_bytes_ += output.size(); |
| 67 | return true; |
| 68 | } else { |
| 69 | RTC_LOG(LS_ERROR) << "Write to WebRtcEventLog file failed."; |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 70 | } |
| 71 | } else { |
Mirko Bonadei | 675513b | 2017-11-09 11:09:25 +0100 | [diff] [blame] | 72 | RTC_LOG(LS_VERBOSE) << "Max file size reached."; |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 73 | } |
| 74 | |
Niels Möller | d4d3990 | 2017-12-07 09:35:23 +0100 | [diff] [blame] | 75 | // Failed, for one of above reasons. Close output file. |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 76 | file_.Close(); |
Niels Möller | d4d3990 | 2017-12-07 09:35:23 +0100 | [diff] [blame] | 77 | return false; |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 78 | } |
| 79 | |
Niels Möller | d4d3990 | 2017-12-07 09:35:23 +0100 | [diff] [blame] | 80 | // Internal non-virtual method. |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 81 | bool RtcEventLogOutputFile::IsActiveInternal() const { |
Niels Möller | e396276 | 2019-05-06 09:14:31 +0200 | [diff] [blame] | 82 | return file_.is_open(); |
Elad Alon | 83ccca1 | 2017-10-04 13:18:26 +0200 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | } // namespace webrtc |