xref: /aosp_15_r20/external/perfetto/src/tools/proto_merger/proto_merger.h (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1 /*
2  * Copyright (C) 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef SRC_TOOLS_PROTO_MERGER_PROTO_MERGER_H_
18 #define SRC_TOOLS_PROTO_MERGER_PROTO_MERGER_H_
19 
20 #include "perfetto/base/status.h"
21 #include "src/tools/proto_merger/allowlist.h"
22 #include "src/tools/proto_merger/proto_file.h"
23 
24 namespace perfetto {
25 namespace proto_merger {
26 
27 // Merges any updates in the proto |upstream| into the proto |input|
28 // optionally adding any messages/fields/enums/values specified in the
29 // the |allowlist|.
30 //
31 // Some notes about the merging algorithm:
32 // * Comments for all values are always taken from |upstream|.
33 // * If an enum is allowed, then so are all it's values.
34 // * Options for fields are always taken from |input|; any new options in
35 //   |upstream| are ignored.
36 // * Changing the type of an existing field is not supported (even if its
37 //   just a move); this needs to be handled manually.
38 base::Status MergeProtoFiles(const ProtoFile& input,
39                              const ProtoFile& upstream,
40                              const Allowlist& allowlist,
41                              ProtoFile& out);
42 
43 }  // namespace proto_merger
44 }  // namespace perfetto
45 
46 #endif  // SRC_TOOLS_PROTO_MERGER_PROTO_MERGER_H_
47