1 /*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 /*
27 * This file defines build profiles for the JIB tool and others.
28 *
29 * A build profile defines a set of configuration options and external
30 * dependencies that we for some reason or other care about specifically.
31 * Typically, build profiles are defined for the build configurations we
32 * build regularly.
33 *
34 * Contract against this file from the tools that use it, is to provide
35 * a function on the form:
36 *
37 * getJibProfiles(input)
38 *
39 * which returns an object graph describing the profiles and their
40 * dependencies. The name of the function is based on the name of this
41 * file, minus the extension and the '-', camel cased and prefixed with
42 * 'get'.
43 *
44 *
45 * The parameter 'input' is an object that optionally contains some data.
46 * Optionally because a tool may read the configuration for different purposes.
47 * To initially get a list of available profiles, the active profile may not
48 * yet be known for instance.
49 *
50 * Data that may be set on the input object:
51 *
52 * input.profile = <name of active profile>
53 *
54 * If the active profile is set, the following data from it must also
55 * be provided:
56 *
57 * input.profile
58 * input.target_os
59 * input.target_cpu
60 * input.build_os
61 * input.build_cpu
62 * input.target_platform
63 * input.build_platform
64 * // The build_osenv_* variables describe the unix layer on Windows systems,
65 * // i.e. Cygwin, which may also be 32 or 64 bit.
66 * input.build_osenv
67 * input.build_osenv_cpu
68 * input.build_osenv_platform
69 *
70 * For more complex nested attributes, there is a method "get":
71 *
72 * input.get("<dependency>", "<attribute>")
73 *
74 * Valid attributes are:
75 * install_path
76 * download_path
77 * download_dir
78 *
79 *
80 * The output data generated by this configuration file has the following
81 * format:
82 *
83 * data: {
84 * // Identifies the version of this format to the tool reading it
85 * format_version: "1.0",
86 *
87 * // Name of base outputdir. JIB assumes the actual output dir is formed
88 * // by adding the configuration name: <output_basedir>/<config-name>
89 * output_basedir: "build",
90 * // Configure argument to use to specify configuration name
91 * configuration_configure_arg:
92 * // Make argument to use to specify configuration name
93 * configuration_make_arg:
94 *
95 * profiles: {
96 * <profile-name>: {
97 * // Name of os the profile is built to run on
98 * target_os; <string>
99 * // Name of cpu the profile is built to run on
100 * target_cpu; <string>
101 * // Combination of target_os and target_cpu for convenience
102 * target_platform; <string>
103 * // Name of os the profile is built on
104 * build_os; <string>
105 * // Name of cpu the profile is built on
106 * build_cpu; <string>
107 * // Combination of build_os and build_cpu for convenience
108 * build_platform; <string>
109 *
110 * // List of dependencies needed to build this profile
111 * dependencies: <Array of strings>
112 *
113 * // List of configure args to use for this profile
114 * configure_args: <Array of strings>
115 *
116 * // List of free form labels describing aspects of this profile
117 * labels: <Array of strings>
118 * }
119 * }
120 *
121 * // Dependencies use a Maven like deployment structure
122 * dependencies: {
123 * <dependency-name>: {
124 * // Organization part of path defining this dependency
125 * organization: <string>
126 * // File extension for this dependency
127 * ext: <string>
128 * // Module part of path for defining this dependency,
129 * // defaults to <dependency-name>
130 * module: <string>
131 * // Revision part of path for defining this dependency
132 * revision: <string>
133 *
134 * // List of configure args to add when using this dependency,
135 * // defaults to
136 * // "--with-<dependency-name>=input.get("<dependency-name", "install_path")"
137 * configure_args: <array of strings>
138 *
139 * // Name of environment variable to set when using this dependency
140 * // when running make
141 * environment_name: <string>
142 * // Value of environment variable to set when using this dependency
143 * // when running make
144 * environment_value: <string>
145 *
146 * // Value to add to the PATH variable when using this dependency,
147 * // applies to both make and configure
148 * environment_path: <string>
149 * }
150 *
151 * <dependency-name>: {
152 * // For certain dependencies where a legacy distribution mechanism is
153 * // already in place, the "javare" server layout is also supported
154 * // Indicate that an alternate server source and layout should be used
155 * server: "javare"
156 *
157 * // For "javare", a combination of module, revision,
158 * // build number (optional), files and checksum file is possible for
159 * // artifacts following the standard layout.
160 * module: <string>
161 * revision: <string>
162 * build_number: <string>
163 * checksum_file: <string>
164 * file: <string>
165 *
166 * // For other files, use checksum path and path instead
167 * checksum_path: <string>
168 * path: <string>
169 * }
170 * }
171 * }
172 */
173
174 /**
175 * Main entry to generate the profile configuration
176 *
177 * @param input External data to use for generating the configuration
178 * @returns {{}} Profile configuration
179 */
180 var getJibProfiles = function (input) {
181
182 var data = {};
183
184 // Identifies the version of this format to the tool reading it
185 data.format_version = "1.0";
186
187 // Organization is used when uploading/publishing build results
188 data.organization = "com.oracle.jpg.jdk";
189
190 // The base directory for the build output. JIB will assume that the
191 // actual build directory will be <output_basedir>/<configuration>
192 data.output_basedir = "build";
193 // The configure argument to use to specify the name of the configuration
194 data.configuration_configure_arg = "--with-conf-name=";
195 // The make argument to use to specify the name of the configuration
196 data.configuration_make_arg = "CONF_NAME=";
197
198 // Define some common values
199 var common = getJibProfilesCommon(input);
200 // Generate the profiles part of the configuration
201 data.profiles = getJibProfilesProfiles(input, common);
202 // Generate the dependencies part of the configuration
203 data.dependencies = getJibProfilesDependencies(input, common);
204
205 return data;
206 };
207
208 /**
209 * Generates some common values
210 *
211 * @param input External data to use for generating the configuration
212 * @returns Common values
213 */
214 var getJibProfilesCommon = function (input) {
215 var common = {};
216
217 common.dependencies = ["boot_jdk", "gnumake", "jtreg"],
218 common.default_make_targets = ["product-images", "test-image"],
219 common.default_make_targets_debug = common.default_make_targets;
220 common.default_make_targets_slowdebug = common.default_make_targets;
221 common.configure_args = ["--enable-jtreg-failure-handler"],
222 common.configure_args_32bit = ["--with-target-bits=32"],
223 common.configure_args_debug = ["--enable-debug"],
224 common.configure_args_slowdebug = ["--with-debug-level=slowdebug"],
225 common.organization = "jpg.infra.builddeps"
226
227 return common;
228 };
229
230 /**
231 * Generates the profiles part of the configuration.
232 *
233 * @param input External data to use for generating the configuration
234 * @param common The common values
235 * @returns {{}} Profiles part of the configuration
236 */
237 var getJibProfilesProfiles = function (input, common) {
238 var profiles = {};
239
240 // Main SE profiles
241 var mainProfiles = {
242
243 "linux-x64": {
244 target_os: "linux",
245 target_cpu: "x64",
246 dependencies: concat(common.dependencies, "devkit"),
247 configure_args: concat(common.configure_args, "--with-zlib=system"),
248 default_make_targets: concat(common.default_make_targets, "docs-image")
249 },
250
251 "linux-x86": {
252 target_os: "linux",
253 target_cpu: "x86",
254 build_cpu: "x64",
255 dependencies: concat(common.dependencies, "devkit"),
256 configure_args: concat(common.configure_args, common.configure_args_32bit,
257 "--with-jvm-variants=minimal,client,server", "--with-zlib=system"),
258 default_make_targets: common.default_make_targets
259 },
260
261 "macosx-x64": {
262 target_os: "macosx",
263 target_cpu: "x64",
264 dependencies: concat(common.dependencies, "devkit"),
265 configure_args: concat(common.configure_args, "--with-zlib=system"),
266 default_make_targets: common.default_make_targets
267 },
268
269 "solaris-x64": {
270 target_os: "solaris",
271 target_cpu: "x64",
272 dependencies: concat(common.dependencies, "devkit", "cups"),
273 configure_args: concat(common.configure_args, "--with-zlib=system"),
274 default_make_targets: common.default_make_targets
275 },
276
277 "solaris-sparcv9": {
278 target_os: "solaris",
279 target_cpu: "sparcv9",
280 dependencies: concat(common.dependencies, "devkit", "cups"),
281 configure_args: concat(common.configure_args, "--with-zlib=system"),
282 default_make_targets: common.default_make_targets
283 },
284
285 "windows-x64": {
286 target_os: "windows",
287 target_cpu: "x64",
288 dependencies: concat(common.dependencies, "devkit", "freetype"),
289 configure_args: concat(common.configure_args),
290 default_make_targets: common.default_make_targets
291 },
292
293 "windows-x86": {
294 target_os: "windows",
295 target_cpu: "x86",
296 build_cpu: "x64",
297 dependencies: concat(common.dependencies, "devkit", "freetype"),
298 configure_args: concat(common.configure_args,
299 "--with-jvm-variants=client,server", common.configure_args_32bit),
300 default_make_targets: common.default_make_targets
301 }
302 };
303 profiles = concatObjects(profiles, mainProfiles);
304 // Generate debug versions of all the main profiles
305 profiles = concatObjects(profiles, generateDebugProfiles(common, mainProfiles));
306 // Generate slowdebug versions of all the main profiles
307 profiles = concatObjects(profiles, generateSlowdebugProfiles(common, mainProfiles));
308
309 // Generate open only profiles for all the main profiles for JPRT and reference
310 // implementation builds.
311 var openOnlyProfiles = generateOpenOnlyProfiles(common, mainProfiles);
312 // The open only profiles on linux are used for reference builds and should
313 // produce the compact profile images by default. This adds "profiles" as an
314 // extra default target.
315 var openOnlyProfilesExtra = {
316 "linux-x64-open": {
317 default_make_targets: "profiles"
318 },
319
320 "linux-x86-open": {
321 default_make_targets: "profiles"
322 }
323 };
324 var openOnlyProfiles = concatObjects(openOnlyProfiles, openOnlyProfilesExtra);
325
326 profiles = concatObjects(profiles, openOnlyProfiles);
327 // Generate debug profiles for the open jprt profiles
328 profiles = concatObjects(profiles, generateDebugProfiles(common, openOnlyProfiles));
329
330 // Profiles used to run tests. Used in JPRT.
331 var testOnlyProfiles = {
332
333 "run-test": {
334 target_os: input.build_os,
335 target_cpu: input.build_cpu,
336 dependencies: [ "jtreg", "gnumake" ],
337 labels: "test"
338 }
339 };
340 profiles = concatObjects(profiles, testOnlyProfiles);
341
342 // Generate the missing platform attributes
343 profiles = generatePlatformAttributes(profiles);
344 profiles = generateDefaultMakeTargetsConfigureArg(common, profiles);
345 return profiles;
346 };
347
348 /**
349 * Generate the dependencies part of the configuration
350 *
351 * @param input External data to use for generating the configuration
352 * @param common The common values
353 * @returns {{}} Dependencies part of configuration
354 */
355 var getJibProfilesDependencies = function (input, common) {
356
357 var boot_jdk_platform = input.build_os + "-"
358 + (input.build_cpu == "x86" ? "i586" : input.build_cpu);
359
360 var devkit_platform_revisions = {
361 linux_x64: "gcc4.9.2-OEL6.4+1.0",
362 macosx_x64: "Xcode6.3-MacOSX10.9+1.0",
363 solaris_x64: "SS12u4-Solaris11u1+1.0",
364 solaris_sparcv9: "SS12u4-Solaris11u1+1.0",
365 windows_x64: "VS2013SP4+1.0"
366 };
367
368 var devkit_platform = (input.target_cpu == "x86"
369 ? input.target_os + "_x64"
370 : input.target_platform);
371
372 var dependencies = {
373
374 boot_jdk: {
375 server: "javare",
376 module: "jdk",
377 revision: "8",
378 checksum_file: boot_jdk_platform + "/MD5_VALUES",
379 file: boot_jdk_platform + "/jdk-8-" + boot_jdk_platform + ".tar.gz",
380 configure_args: (input.build_os == "macosx"
381 ? "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0.jdk/Contents/Home"
382 : "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0")
383 },
384
385 devkit: {
386 organization: common.organization,
387 ext: "tar.gz",
388 module: "devkit-" + devkit_platform,
389 revision: devkit_platform_revisions[devkit_platform]
390 },
391
392 build_devkit: {
393 organization: common.organization,
394 ext: "tar.gz",
395 module: "devkit-" + input.build_platform,
396 revision: devkit_platform_revisions[input.build_platform]
397 },
398
399 cups: {
400 organization: common.organization,
401 ext: "tar.gz",
402 revision: "1.0118+1.0"
403 },
404
405 jtreg: {
406 server: "javare",
407 revision: "4.2",
408 build_number: "b01",
409 checksum_file: "MD5_VALUES",
410 file: "jtreg_bin-4.2.zip",
411 environment_name: "JT_HOME"
412 },
413
414 gnumake: {
415 organization: common.organization,
416 ext: "tar.gz",
417 revision: "4.0+1.0",
418
419 module: (input.build_os == "windows"
420 ? "gnumake-" + input.build_osenv_platform
421 : "gnumake-" + input.build_platform),
422
423 configure_args: (input.build_os == "windows"
424 ? "MAKE=" + input.get("gnumake", "install_path") + "/cygwin/bin/make"
425 : "MAKE=" + input.get("gnumake", "install_path") + "/bin/make"),
426
427 environment_path: (input.build_os == "windows"
428 ? input.get("gnumake", "install_path") + "/cygwin/bin"
429 : input.get("gnumake", "install_path") + "/bin")
430 },
431
432 freetype: {
433 organization: common.organization,
434 ext: "tar.gz",
435 revision: "2.3.4+1.0",
436 module: "freetype-" + input.target_platform
437 }
438 };
439
440 return dependencies;
441 };
442
443 /**
444 * Generate the missing platform attributes for profiles
445 *
446 * @param profiles Profiles map to generate attributes on
447 * @returns {{}} New profiles map with platform attributes fully filled in
448 */
449 var generatePlatformAttributes = function (profiles) {
450 var ret = concatObjects(profiles, {});
451 for (var profile in profiles) {
452 if (ret[profile].build_os == null) {
453 ret[profile].build_os = ret[profile].target_os;
454 }
455 if (ret[profile].build_cpu == null) {
456 ret[profile].build_cpu = ret[profile].target_cpu;
457 }
458 ret[profile].target_platform = ret[profile].target_os + "_" + ret[profile].target_cpu;
459 ret[profile].build_platform = ret[profile].build_os + "_" + ret[profile].build_cpu;
460 }
461 return ret;
462 };
463
464 /**
465 * Generates debug versions of profiles. Clones the given profiles and adds
466 * debug metadata.
467 *
468 * @param common Common values
469 * @param profiles Profiles map to generate debug profiles for
470 * @returns {{}} New map of profiles containing debug profiles
471 */
472 var generateDebugProfiles = function (common, profiles) {
473 var newProfiles = {};
474 for (var profile in profiles) {
475 var debugProfile = profile + "-debug";
476 newProfiles[debugProfile] = clone(profiles[profile]);
477 newProfiles[debugProfile].debug_level = "fastdebug";
478 newProfiles[debugProfile].default_make_targets
479 = common.default_make_targets_debug;
480 newProfiles[debugProfile].labels
481 = concat(newProfiles[debugProfile].labels || [], "debug"),
482 newProfiles[debugProfile].configure_args
483 = concat(newProfiles[debugProfile].configure_args,
484 common.configure_args_debug);
485 }
486 return newProfiles;
487 };
488
489 /**
490 * Generates slowdebug versions of profiles. Clones the given profiles and adds
491 * debug metadata.
492 *
493 * @param common Common values
494 * @param profiles Profiles map to generate debug profiles for
495 * @returns {{}} New map of profiles containing debug profiles
496 */
497 var generateSlowdebugProfiles = function (common, profiles) {
498 var newProfiles = {};
499 for (var profile in profiles) {
500 var debugProfile = profile + "-slowdebug";
501 newProfiles[debugProfile] = clone(profiles[profile]);
502 newProfiles[debugProfile].debug_level = "slowdebug";
503 newProfiles[debugProfile].default_make_targets
504 = common.default_make_targets_slowdebug;
505 newProfiles[debugProfile].labels
506 = concat(newProfiles[debugProfile].labels || [], "slowdebug"),
507 newProfiles[debugProfile].configure_args
508 = concat(newProfiles[debugProfile].configure_args,
509 common.configure_args_slowdebug);
510 }
511 return newProfiles;
512 };
513
514 /**
515 * Generates open only versions of profiles. Clones the given profiles and adds
516 * open metadata.
517 *
518 * @param common Common values
519 * @param profiles Profiles map to generate open only profiles for
520 * @returns {{}} New map of profiles containing open only profiles
521 */
522 var generateOpenOnlyProfiles = function (common, profiles) {
523 var newProfiles = {};
524 for (var profile in profiles) {
525 var openProfile = profile + "-open";
526 newProfiles[openProfile] = clone(profiles[profile]);
527 newProfiles[openProfile].labels
528 = concat(newProfiles[openProfile].labels || [], "open"),
529 newProfiles[openProfile].configure_args
530 = concat(newProfiles[openProfile].configure_args,
531 "--enable-openjdk-only");
532 }
533 return newProfiles;
534 };
535
536 /**
537 * The default_make_targets attribute on a profile is not a real Jib attribute.
538 * This function rewrites that attribute into the corresponding configure arg.
539 * Calling this function multiple times on the same profiles object is safe.
540 *
541 * @param common Common values
542 * @param profiles Profiles map to rewrite profiles for
543 * @returns {{}} New map of profiles with the make targets converted
544 */
545 var generateDefaultMakeTargetsConfigureArg = function (common, profiles) {
546 var ret = concatObjects(profiles, {});
547 for (var profile in ret) {
548 if (ret[profile]["default_make_targets"] != null) {
549 var targetsString = concat(ret[profile].default_make_targets).join(" ");
550 // Iterate over all configure args and see if --with-default-make-target
551 // is already there and change it, otherwise add it.
552 var found = false;
553 for (var arg in ret[profile].configure_args) {
554 if (arg.startsWith("--with-default-make-target")) {
555 found = true;
556 arg.replace(/=.*/, "=" + targetsString);
557 }
558 }
559 if (!found) {
560 ret[profile].configure_args = concat(
561 ret[profile].configure_args,
562 "--with-default-make-target=" + targetsString);
563 }
564 }
565 }
566 return ret;
567 }
568
569 /**
570 * Deep clones an object tree.
571 *
572 * @param o Object to clone
573 * @returns {{}} Clone of o
574 */
575 var clone = function (o) {
576 return JSON.parse(JSON.stringify(o));
577 };
578
579 /**
580 * Concatenates all arguments into a new array
581 *
582 * @returns {Array.<T>} New array containing all arguments
583 */
584 var concat = function () {
585 return Array.prototype.concat.apply([], arguments);
586 };
587
588 /**
589 * Copies all elements in an array into a new array but replacing all
590 * occurrences of original with replacement.
591 *
592 * @param original Element to look for
593 * @param replacement Element to replace with
594 * @param a Array to copy
595 * @returns {Array} New array with all occurrences of original replaced
596 * with replacement
597 */
598 var replace = function (original, replacement, a) {
599 var newA = [];
600 for (var i in a) {
601 if (original == a[i]) {
602 newA.push(replacement);
603 } else {
604 newA.push(a[i]);
605 }
606 }
607 return newA;
608 };
609
610 /**
611 * Deep concatenation of two objects. For each node encountered, merge
612 * the contents with the corresponding node in the other object tree,
613 * treating all strings as array elements.
614 *
615 * @param o1 Object to concatenate
616 * @param o2 Object to concatenate
617 * @returns {{}} New object tree containing the concatenation of o1 and o2
618 */
619 var concatObjects = function (o1, o2) {
620 var ret = {};
621 for (var a in o1) {
622 if (o2[a] == null) {
623 ret[a] = o1[a];
624 }
625 }
626 for (var a in o2) {
627 if (o1[a] == null) {
628 ret[a] = o2[a];
629 } else {
630 if (typeof o1[a] == 'string') {
631 ret[a] = [o1[a]].concat(o2[a]);
632 } else if (Array.isArray(o1[a])) {
633 ret[a] = o1[a].concat(o2[a]);
634 } else if (typeof o1[a] == 'object') {
635 ret[a] = concatObjects(o1[a], o2[a]);
636 }
637 }
638 }
639 return ret;
640 };