1 /*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "ecmascript/pgo_profiler/ap_file/pgo_file_info.h"
17 namespace panda::ecmascript::pgo {
18 using StringHelper = base::StringHelper;
19 bool PGOProfilerHeader::strictMatch_ = true;
20 bool PGOProfilerHeader::checksumListHasAbcId_ = true;
21
BuildFromLegacy(void * buffer,PGOProfilerHeader ** header)22 bool PGOProfilerHeader::BuildFromLegacy(void *buffer, PGOProfilerHeader **header)
23 {
24 if (buffer == nullptr || header == nullptr) {
25 LOG_ECMA(ERROR) << "buffer or header is null!";
26 return false;
27 }
28 auto *inHeader = reinterpret_cast<PGOProfilerHeaderLegacy *>(buffer);
29 size_t desSize = Size(inHeader->GetSectionNumber());
30 if (desSize > LastSize()) {
31 LOG_ECMA(ERROR) << "header size error, expected size is less than " << LastSize() << ", but got " << desSize;
32 return false;
33 }
34 Build(header, desSize);
35 // copy header base.
36 if (memcpy_s(*header, sizeof(FileHeaderBase), inHeader, sizeof(FileHeaderBase)) != EOK) {
37 LOG_ECMA(FATAL) << "PGOProfilerHeader BuildFromLegacy copy header base memcpy failed!";
38 UNREACHABLE();
39 }
40 // skip elastic header field, and copy section info from incoming buffer.
41 auto sectionSize = desSize - sizeof(FileHeaderElastic);
42 if (memcpy_s(&((*header)->sectionNumber_), sectionSize, &(inHeader->GetSectionNumber()), sectionSize) != EOK) {
43 LOG_ECMA(FATAL) << "PGOProfilerHeader BuildFromLegacy copy section info memcpy failed!";
44 UNREACHABLE();
45 }
46 return true;
47 }
48
BuildFromElastic(void * buffer,size_t bufferSize,PGOProfilerHeader ** header)49 bool PGOProfilerHeader::BuildFromElastic(void *buffer, size_t bufferSize, PGOProfilerHeader **header)
50 {
51 auto *inHeader = reinterpret_cast<PGOProfilerHeader *>(buffer);
52 if (!inHeader->Verify(buffer, bufferSize)) {
53 return false;
54 }
55 size_t desSize = inHeader->Size();
56 if (desSize > LastSize()) {
57 LOG_ECMA(ERROR) << "header size error, expected size is less than " << LastSize() << ", but got " << desSize;
58 return false;
59 }
60 Build(header, desSize);
61 if (memcpy_s(*header, desSize, inHeader, desSize) != EOK) {
62 LOG_ECMA(FATAL) << "PGOProfilerHeader BuildFromElastic memcpy failed!";
63 UNREACHABLE();
64 }
65 return true;
66 }
67
ParseFromBinary(void * buffer,size_t bufferSize,PGOProfilerHeader ** header)68 bool PGOProfilerHeader::ParseFromBinary(void *buffer, size_t bufferSize, PGOProfilerHeader **header)
69 {
70 auto *inHeaderBase = reinterpret_cast<FileHeaderBase *>(buffer);
71 if (inHeaderBase->VerifyVersion("ap file", LAST_VERSION, IsStrictMatch())) {
72 if (!inHeaderBase->CompatibleVerify(ELASTIC_HEADER_MINI_VERSION)) {
73 return BuildFromLegacy(buffer, header);
74 }
75 return BuildFromElastic(buffer, bufferSize, header);
76 }
77 return false;
78 }
79
VerifyFileSize(size_t bufferSize) const80 bool PGOProfilerHeader::VerifyFileSize(size_t bufferSize) const
81 {
82 if (!SupportFileSize()) {
83 return true;
84 }
85 if (GetFileSize() != bufferSize) {
86 LOG_ECMA(ERROR) << "Verify ap file's file size failed. size: " << std::hex << bufferSize << " vs "
87 << GetFileSize();
88 return false;
89 }
90 return true;
91 }
92
VerifyConsistency(void * buffer,size_t bufferSize) const93 bool PGOProfilerHeader::VerifyConsistency(void *buffer, size_t bufferSize) const
94 {
95 if (!SupportFileConsistency()) {
96 return true;
97 }
98 uint32_t checksum = adler32(0, reinterpret_cast<const Bytef *>(buffer) + MAGIC_SIZE, VERSION_SIZE);
99 checksum = adler32(checksum, reinterpret_cast<const Bytef *>(buffer) + CHECKSUM_END_OFFSET,
100 bufferSize - CHECKSUM_END_OFFSET);
101 if (checksum != GetChecksum()) {
102 LOG_ECMA(ERROR) << "Verify ap file's consistency failed. checksum: " << std::hex << checksum << " vs "
103 << std::hex << GetChecksum();
104 return false;
105 }
106 return true;
107 }
108
ProcessToBinary(std::fstream & fileStream) const109 void PGOProfilerHeader::ProcessToBinary(std::fstream &fileStream) const
110 {
111 fileStream.seekp(0);
112 if (base::FileHeaderBase::CompatibleVerify(ELASTIC_HEADER_MINI_VERSION)) {
113 fileStream.write(reinterpret_cast<const char *>(this), Size());
114 } else {
115 // copy header base.
116 fileStream.write(reinterpret_cast<const char *>(this), sizeof(FileHeaderBase));
117 // skip elastic header field, and copy section info from incoming buffer.
118 auto sectionSize = Size() - sizeof(FileHeaderElastic);
119 fileStream.write(reinterpret_cast<const char *>(§ionNumber_), sectionSize);
120 }
121 }
122
ProcessToText(std::ofstream & stream) const123 bool PGOProfilerHeader::ProcessToText(std::ofstream &stream) const
124 {
125 if (!Verify()) {
126 return false;
127 }
128 stream << DumpUtils::VERSION_HEADER << InternalGetVersion() << DumpUtils::NEW_LINE;
129 stream << "Compatible an file version: " << ConvToStr(GetCompatibleAnVersion()) << DumpUtils::NEW_LINE;
130 if (SupportFileConsistency()) {
131 stream << "FileSize: " << GetFileSize() << ", HeaderSize: " << GetHeaderSize() << ", Checksum: " << std::hex
132 << GetChecksum() << DumpUtils::NEW_LINE;
133 }
134 return true;
135 }
136 } // namespace panda::ecmascript::pgo