-
Notifications
You must be signed in to change notification settings - Fork 0
/
cherrypick_cl.py
executable file
·215 lines (180 loc) · 7.45 KB
/
cherrypick_cl.py
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
#!/usr/bin/env python3
#
# Copyright (C) 2020 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.
#
from __future__ import annotations
import argparse
import collections
import dataclasses
from dataclasses import dataclass
import json
import math
from pathlib import Path
import re
from typing import Any, Dict, List, Optional, Tuple
from android_version import get_svn_revision_number
from merge_from_upstream import fetch_upstream, sha_to_revision
import paths
import source_manager
from utils import check_call, check_output
def parse_args():
parser = argparse.ArgumentParser(description="Cherry pick upstream LLVM patches.",
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('--sha', nargs='+', help='sha of patches to cherry pick')
parser.add_argument(
'--start-version', default='llvm',
help="""svn revision to start applying patches. 'llvm' can also be used.""")
parser.add_argument('--verify-merge', action='store_true',
help='check if patches can be applied cleanly')
parser.add_argument('--create-cl', action='store_true', help='create a CL')
parser.add_argument('--bug', help='bug to reference in CLs created (if any)')
parser.add_argument('--reason', help='issue/reason to mention in CL subject line')
args = parser.parse_args()
return args
def parse_start_version(start_version: str) -> int:
if start_version == 'llvm':
return int(get_svn_revision_number())
m = re.match(r'r?(\d+)', start_version)
assert m, f'invalid start_version: {start_version}'
return int(m.group(1))
@dataclass
class PatchItem:
metadata: Dict[str, Any]
# info: Optional[List[str]]
# title: str
platforms: List[str]
rel_patch_path: str
version_range: Dict[str, Optional[int]]
# from: Optional[int]
# until: Optional[int]
@classmethod
def from_dict(cls, d: Dict[str, Any]) -> PatchItem:
return PatchItem(
metadata=d['metadata'],
platforms=d['platforms'],
rel_patch_path=d['rel_patch_path'],
version_range=d['version_range'])
def to_dict(self) -> Dict[str, Any]:
return dataclasses.asdict(self, dict_factory=collections.OrderedDict)
@property
def is_local_patch(self) -> bool:
return not self.rel_patch_path.startswith('cherry/')
@property
def sha(self) -> str:
m = re.match(r'cherry/(.+)\.patch', self.rel_patch_path)
assert m, self.rel_patch_path
return m.group(1)
@property
def end_version(self) -> Optional[int]:
return self.version_range.get('until', None)
@property
def start_version(self) -> Optional[int]:
return self.version_range.get('from', None)
@property
def sort_key(item: PatchItem) -> Tuple:
# Keep local patches at the end of the list, and don't change the
# relative order between two local patches.
if item.is_local_patch:
return (True,)
# Just before local patches, include patches with no end_version. Sort
# them by start_version.
if item.end_version is None:
return (False, math.inf, item.start_version)
# At the front of the list, sort upstream patches by ascending order of
# end_version. Don't reorder patches with the same end_version.
return (False, item.end_version)
def __lt__(self, other: PatchItem) -> bool:
"""Used to sort patches in PatchList"""
return self.sort_key < other.sort_key
class PatchList(list):
""" a list of PatchItem """
JSON_FILE_PATH = paths.SCRIPTS_DIR / 'patches' / 'PATCHES.json'
@classmethod
def load_from_file(cls) -> PatchList:
with open(cls.JSON_FILE_PATH, 'r') as fh:
array = json.load(fh)
return PatchList(PatchItem.from_dict(d) for d in array)
def save_to_file(self):
array = [patch.to_dict() for patch in self]
with open(self.JSON_FILE_PATH, 'w') as fh:
json.dump(array, fh, indent=4, separators=(',', ': '), sort_keys=True)
fh.write('\n')
def generate_patch_files(sha_list: List[str], start_version: int) -> PatchList:
""" generate upstream cherry-pick patch files """
upstream_dir = paths.TOOLCHAIN_LLVM_PATH
fetch_upstream()
result = PatchList()
for sha in sha_list:
if len(sha) < 40:
sha = get_full_sha(upstream_dir, sha)
file_path = paths.SCRIPTS_DIR / 'patches' / 'cherry' / f'{sha}.patch'
assert not file_path.exists(), f'{file_path} already exists'
with open(file_path, 'w') as fh:
check_call(f'git format-patch -1 {sha} --stdout',
stdout=fh, shell=True, cwd=upstream_dir)
commit_subject = check_output(
f'git log -n1 --format=%s {sha}', shell=True, cwd=upstream_dir)
info: Optional[List[str]] = []
title = '[UPSTREAM] ' + commit_subject.strip()
rel_patch_path = f'cherry/{sha}.patch'
end_version = sha_to_revision(sha)
metadata = { 'info': info, 'title': title }
platforms = ['android']
version_range: Dict[str, Optional[int]] = {
'from': start_version,
'until': end_version,
}
result.append(PatchItem(metadata, platforms, rel_patch_path, version_range))
return result
def get_full_sha(upstream_dir: Path, short_sha: str) -> str:
return check_output(['git', 'rev-parse', short_sha], cwd=upstream_dir).strip()
def create_cl(new_patches: PatchList, reason: str, bug: Optional[str]):
file_list = [p.rel_patch_path for p in new_patches] + ['PATCHES.json']
file_list = [str(paths.SCRIPTS_DIR / 'patches' / f) for f in file_list]
check_call(['git', 'add'] + file_list)
subject = f'[patches] Cherry pick CLS for: {reason}'
commit_lines = [subject, '']
if bug:
if bug.isnumeric():
commit_lines += [f'Bug: http://b/{bug}', '']
else:
commit_lines += [f'Bug: {bug}', '']
for patch in new_patches:
sha = patch.sha[:11]
subject = patch.metadata['title']
if subject.startswith('[UPSTREAM] '):
subject = subject[len('[UPSTREAM] '):]
commit_lines.append(sha + ' ' + subject)
commit_lines += ['', 'Test: N/A']
check_call(['git', 'commit', '-m', '\n'.join(commit_lines)])
def main():
args = parse_args()
patch_list = PatchList.load_from_file()
if args.sha:
start_version = parse_start_version(args.start_version)
new_patches = generate_patch_files(args.sha, start_version)
patch_list.extend(new_patches)
patch_list.sort()
patch_list.save_to_file()
if args.verify_merge:
print('verify merge...')
source_manager.setup_sources()
if args.create_cl:
if not args.reason:
print('error: --create-cl requires --reason')
exit(1)
create_cl(new_patches, args.reason, args.bug)
if __name__ == '__main__':
main()