xref: /aosp_15_r20/external/pigweed/pw_build_info/public/pw_build_info/build_id.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2021 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 #include <cstddef>
17 
18 #include "pw_span/span.h"
19 
20 namespace pw::build_info {
21 
22 // Build IDs may be generated with several different algorithms. The largest of
23 // these (aside from user-provided build IDs) are a fixed size of 20 bytes.
24 inline constexpr size_t kMaxBuildIdSizeBytes = 20;
25 
26 // Reads a GNU build ID from the address starting at the address of the
27 // `gnu_build_id_begin` symbol. This must be manually explicitly provided as
28 // part of a linker script. See build_id_linker_snippet.ld for an example.
29 span<const std::byte> BuildId();
30 
31 }  // namespace pw::build_info
32