-
Notifications
You must be signed in to change notification settings - Fork 99
/
Copy pathkokkos-promotion.txt
267 lines (164 loc) · 11.2 KB
/
kokkos-promotion.txt
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
Summary:
- Step 1: Testing Kokkos + KokkosKernels using test_all_sandia
- Step 2: Testing of Kokkos + KokkosKernels integrated into Trilinos (scripts/trilinos-integration/*.sh)
- Step 3: Close all issues labeled "InDevelop"
- Step 4: Locally update CHANGELOG, merge into master, edit scripts/master_history.txt
- Step 5: Locally snapshot new master of kokkos and kokkos-kernels into corresponding Trilinos branch (develop or temporary), issue PR to Trilinos
- Step 6: Push local Kokkos master to GitHub (need Owner approval). Push local KokkosKernels master to GitHub (need Owner approval)
Steps 1, 2, and 4 include testing that may fail. These failures must be fixed either by pull requests to Kokkos and/or KokkosKernels develop, or by creating a new Trilinos branch for parts of Trilinos that must be updated. This is what usually takes the most time.
// -------------------------------------------------------------------------------- //
Step 1: The following should be repeated on enough machines to cover all
supported compilers. Those machines are:
kokkos-dev
blake
white
bowman
waterman
ride
1.1. Clone kokkos develop branch (or just switch to it)
git clone -b develop [email protected]:kokkos/kokkos.git
cd kokkos
1.2. Create a testing directory
mkdir testing
cd testing
1.3. Run the test_all_sandia script with no options to test all compilers
nohup ../scripts/test_all_sandia &
tail -f nohup.out # to watch progress
NOTE: To kill jobs not running in the background (hopefully prevent ghost processes):
control+z
kill -9 %1
1.4. Clone kokkos-kernels develop branch (or just switch to it)
git clone -b develop [email protected]:kokkos/kokkos-kernels.git
cd kokkos-kernels
1.4. Create a testing directory
mkdir testing
cd testing
1.5. Run the test_all_sandia script with no options to test all compilers
nohup ../scripts/test_all_sandia &
tail -f nohup.out # to watch progress
NOTE: To kill jobs not running in the background (hopefully prevent ghost processes):
control+z
kill -9 %1
// -------------------------------------------------------------------------------- //
Step 2:
2.1. Build and test Trilinos with the following configurations:
a) serial, openmp, and cuda via the testing scripts in kokkos-kernels/scripts/trilinos-integration (automates the process)
b) various ATDM-supported builds via Trilinos configuration scripts located in kokkos{-kernels}/scripts/trilinos-integration/ATDM_configurations (not yet automated)
Run scripts for automated testing on white (openmp and cuda) and blake (seral) that are provided in kokkos{-kernels}/scripts/trilinos-integration.
These scripts load their own modules/environment, so don't require preparation. You can run all four at the same time, use separate directories for each.
mkdir serial
cd serial
nohup KOKKOSKERNELS_PATH/scripts/trilinos-integration/blake_jenkins_run_script_serial_intel &
Use scripts to configure Trilinos for waterman (cuda, cuda-debug) and ride (cuda-rdc) that are provided in kokkos-kernels/scripts/trilinos-integration/ATDM_configurations.
These scripts load their own modules/environment, so don't require preparation of the system environment. You can run them all at the same time, just use separate directories for each. Instructions for compute node allocation, building, and testing are included in the scripts.
The Trilinos configuration scripts include an override of the kokkos and kokkos-kernels packages; this requires that a symbolic link for each be created in the Trilinos base directory:
cd Trilinos
ln -s <PATH_TO_YOUR_KOKKOS> kokkos
ln -s <PATH_TO_YOUR_KOKKOSKERNELS> kokkos-kernels
2.2. Compare the compile errors and test failures between updated and pristine versions; the ATDM configurations scripts should have 0 build errors and 100% passing tests. There may be compile failures that happen in both, tests that fail in both, and there may be tests that only fail some times (thus, rerun tests manually as needed).
// -------------------------------------------------------------------------------- //
Step 3: Close all issues labeled "InDevelop"
Use the GitHub web interface: https://github.com/kokkos/kokkos/issues?q=is%3Aopen+is%3Aissue+label%3AInDevelop
Select all with checkbox in upper left, "Mark as closed"
Use the GitHub web interface: https://github.com/kokkos/kokkos-kernels/issues?q=is%3Aopen+is%3Aissue+label%3AInDevelop
Select all with checkbox in upper left, "Mark as closed"
// -------------------------------------------------------------------------------- //
Step 4: This step should be run on kokkos-dev
4.1. If you don't have a GitHub token already, generate one for yourself (this will give you TOKEN):
https://github.com/settings/tokens
4.2. Get a clean copy of the kokkos and kokkos-kernels develop branches
git clone -b develop [email protected]:kokkos/kokkos.git
git clone -b develop [email protected]:kokkos/kokkos-kernels.git
4.3. If you haven't already, install Ruby and the "github_changelog_generator" "gem"
The github_changelog_generator is here: https://github.com/skywinder/github-changelog-generator
Its compatible Ruby version can be found here: https://github.com/skywinder/github-changelog-generator/blob/master/.ruby-version
Grab the corresponding Ruby version from here: https://www.ruby-lang.org/en/downloads/
Follow the usual configure,make,make install process: https://www.ruby-lang.org/en/documentation/installation/#building-from-source
Note that you will likely have to install to a non-default location with "./configure --prefix=/path"
4.4. Generate the initial changelog(s). Use the most recent tag as OLDTAG (`git tag -l` can show you all tags). The NEWTAG is the new version number, e.g. "2.04.00".
RUN THIS OUTSIDE THE KOKKOS SOURCE TREE!
NOTE: You likely need to set an HTTPS proxy in order for this script to work:
export https_proxy=http://wwwproxy.sandia.gov:80
github_changelog_generator kokkos/kokkos --token TOKEN --no-pull-requests --include-labels 'InDevelop' --exclude-labels 'question,DevelopOnly' --enhancement-labels 'enhancement,Feature Request' --future-release 'NEWTAG' --between-tags 'NEWTAG,OLDTAG'
github_changelog_generator kokkos/kokkos-kernels --token TOKEN --no-pull-requests --include-labels 'InDevelop' --exclude-labels 'question,DevelopOnly' --enhancement-labels 'enhancement,Feature Request' --future-release 'NEWTAG' --between-tags 'NEWTAG,OLDTAG'
4.5. Manually cleanup and commit the change log.
(Copy the new section from the generated CHANGELOG.md to the corresponding KOKKOS_PATH/CHANGELOG.md or KOKKOSKERNELS_PATH/CHANGELOG.md)
(Make desired changes to CHANGELOG.md to enhance clarity (remove issues not noteworthy))
(Commit the CHANGELOG.md locally to develop)
The changelog commit message should be:
Adding Changelog for Release A.B.CD
Part of Kokkos C++ Performance Portability Programming EcoSystem A.B
4.6. Merge develop into master. DO NOT FAST-FORWARD THE MERGE!!!!
DO NOT USE AN OLD GIT VERSION!!!!
(From kokkos directory):
git checkout master
git merge --no-ff develop
The merge commit message should be:
Merge branch 'develop' for A.B.CD
Part of Kokkos C++ Performance Portability Programming EcoSystem A.B
(From kokkos-kernels directory):
git checkout master
git merge --no-ff develop
The merge commit message should be:
Merge branch 'develop' for A.B.CD
Part of Kokkos C++ Performance Portability Programming EcoSystem A.B
4.7. Update the tag in kokkos/master_history.txt, then update the tag in kokkos-kernels/master_history.txt
Tag description: MajorNumber.MinorNumber.WeeksSinceMinorNumberUpdate
Tag field widths: #.#.##
date description: month:day:year
date field widths: ##:##:####
master description: SHA1 of previous master commit (use `git log --first-parent master`)
develop description: SHA1 of merged develop branch (use `git log develop`)
SHA1 field width: ######## (8 chars)
# Append to scripts/master_history.txt:
tag: 2.03.13 date: 07:27:2017 master: da314444 develop: 29ccb58a
git commit --amend -a
Keep the merge commit as described in 4.6
4.8. Create the new tag (repeat for kokkos and kokkos-kernels):
git tag -a #.#.##
(type the following into the tag message (same as for step 4.7))
tag: #.#.##
date: mm/dd/yyyy
master: sha1
develop: sha1
4.9. DO NOT PUSH YET !!!
// -------------------------------------------------------------------------------- //
Step 5: This step can be done on any SEMS machine (e.g. kokkos-dev).
5.1. Clone the Trilinos corresponding branch (or just switch to it)
git clone -b kokkos-promotion [email protected]:trilinos/Trilinos.git
TRILINOS_PATH=$PWD/Trilinos
5.2. Snapshot Kokkos into Trilinos - this requires python/2.7.9 and that both Trilinos and Kokkos be clean - no untracked or modified files. Run the following outside of the Kokkos and Trilinos source trees.
* Use the master branch of Kokkos for this.
module load sems-python/2.7.9
python $KOKKOS_PATH/scripts/snapshot.py $KOKKOS_PATH $TRILINOS_PATH/packages
python $KOKKOS_PATH/scripts/snapshot.py $KOKKOSKERNELS_PATH $TRILINOS_PATH/packages
If snapshotting kokkos-kernels, use the snapshot.py in kokkos.
5.3. Push this Trilinos branch to GitHub, open a pull request for it.
The pull request title should be:
Kokkos + KokkosKernels Promotion To X.X.XX
In the message body, mention @trilinos/kokkos and @trilinos/kokkos-kernels,
Add a short description of the most significant features and bug fixes,
Then add:
## Kokkos Changelog
And copy-paste the content for this release from the kokkos CHANGELOG.md file, then do the same for kokkos-kernels under:
## KokkosKernels Changelog
5.4. Wait for Trilinos Autotester results
5.5. If there are failures, fix and backtrack. Otherwise, merge into Trilinos' develop branch and go to next step
// -------------------------------------------------------------------------------- //
Step 6: Push Kokkos + KokkosKernels master and develop branches to respective GitHub repos (requires Owner permission).
6.1. Master branch:
cd KOKKOS_PATH
git checkout master
git push --follow-tags origin master
cd KOKKOSKERNELS_PATH
git checkout master
git push --follow-tags origin master
6.2. Develop branch: First merge (--no-ff) master back into develop
cd KOKKOS_PATH
git checkout develop
git merge --no-ff master
git push origin develop
cd KOKKOSKERNELS_PATH
git checkout develop
git merge --no-ff master
git push origin develop