jib-profiles.js revision 2258:67c4388142bd
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 */ 180var 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 */ 214var getJibProfilesCommon = function (input) { 215 var common = {}; 216 217 common.dependencies = ["boot_jdk", "gnumake", "jtreg"], 218 common.default_make_targets = ["product-bundles", "test-bundles"], 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 var boot_jdk_revision = "8"; 228 var boot_jdk_subdirpart = "1.8.0"; 229 // JDK 8 does not work on sparc M7 cpus, need a newer update when building 230 // on such hardware. 231 if (input.build_cpu == "sparcv9") { 232 var cpu_brand = $EXEC("bash -c \"kstat -m cpu_info | grep brand | head -n1 | awk '{ print \$2 }'\""); 233 if (cpu_brand.trim() == 'SPARC-M7') { 234 boot_jdk_revision = "8u20"; 235 boot_jdk_subdirpart = "1.8.0_20"; 236 } 237 } 238 common.boot_jdk_revision = boot_jdk_revision; 239 common.boot_jdk_subdirpart = boot_jdk_subdirpart; 240 common.boot_jdk_home = input.get("boot_jdk", "home_path") + "/jdk" 241 + common.boot_jdk_subdirpart 242 + (input.build_os == "macosx" ? ".jdk/Contents/Home" : ""); 243 244 return common; 245}; 246 247/** 248 * Generates the profiles part of the configuration. 249 * 250 * @param input External data to use for generating the configuration 251 * @param common The common values 252 * @returns {{}} Profiles part of the configuration 253 */ 254var getJibProfilesProfiles = function (input, common) { 255 var profiles = {}; 256 257 // Main SE profiles 258 var mainProfiles = { 259 260 "linux-x64": { 261 target_os: "linux", 262 target_cpu: "x64", 263 dependencies: concat(common.dependencies, "devkit"), 264 configure_args: concat(common.configure_args, "--with-zlib=system"), 265 default_make_targets: concat(common.default_make_targets, "docs-bundles") 266 }, 267 268 "linux-x86": { 269 target_os: "linux", 270 target_cpu: "x86", 271 build_cpu: "x64", 272 dependencies: concat(common.dependencies, "devkit"), 273 configure_args: concat(common.configure_args, common.configure_args_32bit, 274 "--with-jvm-variants=minimal,server", "--with-zlib=system"), 275 default_make_targets: common.default_make_targets 276 }, 277 278 "macosx-x64": { 279 target_os: "macosx", 280 target_cpu: "x64", 281 dependencies: concat(common.dependencies, "devkit"), 282 configure_args: concat(common.configure_args, "--with-zlib=system"), 283 default_make_targets: common.default_make_targets 284 }, 285 286 "solaris-x64": { 287 target_os: "solaris", 288 target_cpu: "x64", 289 dependencies: concat(common.dependencies, "devkit", "cups"), 290 configure_args: concat(common.configure_args, "--with-zlib=system"), 291 default_make_targets: common.default_make_targets 292 }, 293 294 "solaris-sparcv9": { 295 target_os: "solaris", 296 target_cpu: "sparcv9", 297 dependencies: concat(common.dependencies, "devkit", "cups"), 298 configure_args: concat(common.configure_args, "--with-zlib=system"), 299 default_make_targets: common.default_make_targets 300 }, 301 302 "windows-x64": { 303 target_os: "windows", 304 target_cpu: "x64", 305 dependencies: concat(common.dependencies, "devkit", "freetype"), 306 configure_args: concat(common.configure_args), 307 default_make_targets: common.default_make_targets 308 }, 309 310 "windows-x86": { 311 target_os: "windows", 312 target_cpu: "x86", 313 build_cpu: "x64", 314 dependencies: concat(common.dependencies, "devkit", "freetype"), 315 configure_args: concat(common.configure_args, common.configure_args_32bit), 316 default_make_targets: common.default_make_targets 317 } 318 }; 319 profiles = concatObjects(profiles, mainProfiles); 320 // Generate debug versions of all the main profiles 321 profiles = concatObjects(profiles, generateDebugProfiles(common, mainProfiles)); 322 // Generate slowdebug versions of all the main profiles 323 profiles = concatObjects(profiles, generateSlowdebugProfiles(common, mainProfiles)); 324 325 // Generate open only profiles for all the main profiles for JPRT and reference 326 // implementation builds. 327 var openOnlyProfiles = generateOpenOnlyProfiles(common, mainProfiles); 328 // The open only profiles on linux are used for reference builds and should 329 // produce the compact profile images by default. This adds "profiles" as an 330 // extra default target. 331 var openOnlyProfilesExtra = { 332 "linux-x64-open": { 333 default_make_targets: "profiles" 334 }, 335 336 "linux-x86-open": { 337 default_make_targets: "profiles", 338 configure_args: "--with-jvm-variants=client,server" 339 } 340 }; 341 var openOnlyProfiles = concatObjects(openOnlyProfiles, openOnlyProfilesExtra); 342 343 profiles = concatObjects(profiles, openOnlyProfiles); 344 // Generate debug profiles for the open jprt profiles 345 profiles = concatObjects(profiles, generateDebugProfiles(common, openOnlyProfiles)); 346 347 // Profiles used to run tests. Used in JPRT. 348 var testOnlyProfiles = { 349 350 "run-test": { 351 target_os: input.build_os, 352 target_cpu: input.build_cpu, 353 dependencies: [ "jtreg", "gnumake", "boot_jdk" ], 354 labels: "test", 355 environment: { 356 "JT_JAVA": common.boot_jdk_home 357 } 358 } 359 }; 360 profiles = concatObjects(profiles, testOnlyProfiles); 361 362 // Generate the missing platform attributes 363 profiles = generatePlatformAttributes(profiles); 364 profiles = generateDefaultMakeTargetsConfigureArg(common, profiles); 365 return profiles; 366}; 367 368/** 369 * Generate the dependencies part of the configuration 370 * 371 * @param input External data to use for generating the configuration 372 * @param common The common values 373 * @returns {{}} Dependencies part of configuration 374 */ 375var getJibProfilesDependencies = function (input, common) { 376 377 var boot_jdk_platform = input.build_os + "-" 378 + (input.build_cpu == "x86" ? "i586" : input.build_cpu); 379 380 var devkit_platform_revisions = { 381 linux_x64: "gcc4.9.2-OEL6.4+1.0", 382 macosx_x64: "Xcode6.3-MacOSX10.9+1.0", 383 solaris_x64: "SS12u4-Solaris11u1+1.0", 384 solaris_sparcv9: "SS12u4-Solaris11u1+1.0", 385 windows_x64: "VS2013SP4+1.0" 386 }; 387 388 var devkit_platform = (input.target_cpu == "x86" 389 ? input.target_os + "_x64" 390 : input.target_platform); 391 392 var dependencies = { 393 394 boot_jdk: { 395 server: "javare", 396 module: "jdk", 397 revision: common.boot_jdk_revision, 398 checksum_file: boot_jdk_platform + "/MD5_VALUES", 399 file: boot_jdk_platform + "/jdk-" + common.boot_jdk_revision 400 + "-" + boot_jdk_platform + ".tar.gz", 401 configure_args: "--with-boot-jdk=" + common.boot_jdk_home, 402 environment_path: common.boot_jdk_home 403 }, 404 405 devkit: { 406 organization: common.organization, 407 ext: "tar.gz", 408 module: "devkit-" + devkit_platform, 409 revision: devkit_platform_revisions[devkit_platform] 410 }, 411 412 build_devkit: { 413 organization: common.organization, 414 ext: "tar.gz", 415 module: "devkit-" + input.build_platform, 416 revision: devkit_platform_revisions[input.build_platform] 417 }, 418 419 cups: { 420 organization: common.organization, 421 ext: "tar.gz", 422 revision: "1.0118+1.0" 423 }, 424 425 jtreg: { 426 server: "javare", 427 revision: "4.2", 428 build_number: "b03", 429 checksum_file: "MD5_VALUES", 430 file: "jtreg_bin-4.2.zip", 431 environment_name: "JT_HOME", 432 environment_path: input.get("jtreg", "install_path") + "/jtreg/bin" 433 }, 434 435 gnumake: { 436 organization: common.organization, 437 ext: "tar.gz", 438 revision: "4.0+1.0", 439 440 module: (input.build_os == "windows" 441 ? "gnumake-" + input.build_osenv_platform 442 : "gnumake-" + input.build_platform), 443 444 configure_args: (input.build_os == "windows" 445 ? "MAKE=" + input.get("gnumake", "install_path") + "/cygwin/bin/make" 446 : "MAKE=" + input.get("gnumake", "install_path") + "/bin/make"), 447 448 environment_path: (input.build_os == "windows" 449 ? input.get("gnumake", "install_path") + "/cygwin/bin" 450 : input.get("gnumake", "install_path") + "/bin") 451 }, 452 453 freetype: { 454 organization: common.organization, 455 ext: "tar.gz", 456 revision: "2.3.4+1.0", 457 module: "freetype-" + input.target_platform 458 } 459 }; 460 461 return dependencies; 462}; 463 464/** 465 * Generate the missing platform attributes for profiles 466 * 467 * @param profiles Profiles map to generate attributes on 468 * @returns {{}} New profiles map with platform attributes fully filled in 469 */ 470var generatePlatformAttributes = function (profiles) { 471 var ret = concatObjects(profiles, {}); 472 for (var profile in profiles) { 473 if (ret[profile].build_os == null) { 474 ret[profile].build_os = ret[profile].target_os; 475 } 476 if (ret[profile].build_cpu == null) { 477 ret[profile].build_cpu = ret[profile].target_cpu; 478 } 479 ret[profile].target_platform = ret[profile].target_os + "_" + ret[profile].target_cpu; 480 ret[profile].build_platform = ret[profile].build_os + "_" + ret[profile].build_cpu; 481 } 482 return ret; 483}; 484 485/** 486 * Generates debug versions of profiles. Clones the given profiles and adds 487 * debug metadata. 488 * 489 * @param common Common values 490 * @param profiles Profiles map to generate debug profiles for 491 * @returns {{}} New map of profiles containing debug profiles 492 */ 493var generateDebugProfiles = function (common, profiles) { 494 var newProfiles = {}; 495 for (var profile in profiles) { 496 var debugProfile = profile + "-debug"; 497 newProfiles[debugProfile] = clone(profiles[profile]); 498 newProfiles[debugProfile].debug_level = "fastdebug"; 499 newProfiles[debugProfile].default_make_targets 500 = common.default_make_targets_debug; 501 newProfiles[debugProfile].labels 502 = concat(newProfiles[debugProfile].labels || [], "debug"), 503 newProfiles[debugProfile].configure_args 504 = concat(newProfiles[debugProfile].configure_args, 505 common.configure_args_debug); 506 } 507 return newProfiles; 508}; 509 510/** 511 * Generates slowdebug versions of profiles. Clones the given profiles and adds 512 * debug metadata. 513 * 514 * @param common Common values 515 * @param profiles Profiles map to generate debug profiles for 516 * @returns {{}} New map of profiles containing debug profiles 517 */ 518var generateSlowdebugProfiles = function (common, profiles) { 519 var newProfiles = {}; 520 for (var profile in profiles) { 521 var debugProfile = profile + "-slowdebug"; 522 newProfiles[debugProfile] = clone(profiles[profile]); 523 newProfiles[debugProfile].debug_level = "slowdebug"; 524 newProfiles[debugProfile].default_make_targets 525 = common.default_make_targets_slowdebug; 526 newProfiles[debugProfile].labels 527 = concat(newProfiles[debugProfile].labels || [], "slowdebug"), 528 newProfiles[debugProfile].configure_args 529 = concat(newProfiles[debugProfile].configure_args, 530 common.configure_args_slowdebug); 531 } 532 return newProfiles; 533}; 534 535/** 536 * Generates open only versions of profiles. Clones the given profiles and adds 537 * open metadata. 538 * 539 * @param common Common values 540 * @param profiles Profiles map to generate open only profiles for 541 * @returns {{}} New map of profiles containing open only profiles 542 */ 543var generateOpenOnlyProfiles = function (common, profiles) { 544 var newProfiles = {}; 545 for (var profile in profiles) { 546 var openProfile = profile + "-open"; 547 newProfiles[openProfile] = clone(profiles[profile]); 548 newProfiles[openProfile].labels 549 = concat(newProfiles[openProfile].labels || [], "open"), 550 newProfiles[openProfile].configure_args 551 = concat(newProfiles[openProfile].configure_args, 552 "--enable-openjdk-only"); 553 } 554 return newProfiles; 555}; 556 557/** 558 * The default_make_targets attribute on a profile is not a real Jib attribute. 559 * This function rewrites that attribute into the corresponding configure arg. 560 * Calling this function multiple times on the same profiles object is safe. 561 * 562 * @param common Common values 563 * @param profiles Profiles map to rewrite profiles for 564 * @returns {{}} New map of profiles with the make targets converted 565 */ 566var generateDefaultMakeTargetsConfigureArg = function (common, profiles) { 567 var ret = concatObjects(profiles, {}); 568 for (var profile in ret) { 569 if (ret[profile]["default_make_targets"] != null) { 570 var targetsString = concat(ret[profile].default_make_targets).join(" "); 571 // Iterate over all configure args and see if --with-default-make-target 572 // is already there and change it, otherwise add it. 573 var found = false; 574 for (var arg in ret[profile].configure_args) { 575 if (arg.startsWith("--with-default-make-target")) { 576 found = true; 577 arg.replace(/=.*/, "=" + targetsString); 578 } 579 } 580 if (!found) { 581 ret[profile].configure_args = concat( 582 ret[profile].configure_args, 583 "--with-default-make-target=" + targetsString); 584 } 585 } 586 } 587 return ret; 588} 589 590/** 591 * Deep clones an object tree. 592 * 593 * @param o Object to clone 594 * @returns {{}} Clone of o 595 */ 596var clone = function (o) { 597 return JSON.parse(JSON.stringify(o)); 598}; 599 600/** 601 * Concatenates all arguments into a new array 602 * 603 * @returns {Array.<T>} New array containing all arguments 604 */ 605var concat = function () { 606 return Array.prototype.concat.apply([], arguments); 607}; 608 609/** 610 * Copies all elements in an array into a new array but replacing all 611 * occurrences of original with replacement. 612 * 613 * @param original Element to look for 614 * @param replacement Element to replace with 615 * @param a Array to copy 616 * @returns {Array} New array with all occurrences of original replaced 617 * with replacement 618 */ 619var replace = function (original, replacement, a) { 620 var newA = []; 621 for (var i in a) { 622 if (original == a[i]) { 623 newA.push(replacement); 624 } else { 625 newA.push(a[i]); 626 } 627 } 628 return newA; 629}; 630 631/** 632 * Deep concatenation of two objects. For each node encountered, merge 633 * the contents with the corresponding node in the other object tree, 634 * treating all strings as array elements. 635 * 636 * @param o1 Object to concatenate 637 * @param o2 Object to concatenate 638 * @returns {{}} New object tree containing the concatenation of o1 and o2 639 */ 640var concatObjects = function (o1, o2) { 641 var ret = {}; 642 for (var a in o1) { 643 if (o2[a] == null) { 644 ret[a] = o1[a]; 645 } 646 } 647 for (var a in o2) { 648 if (o1[a] == null) { 649 ret[a] = o2[a]; 650 } else { 651 if (typeof o1[a] == 'string') { 652 ret[a] = [o1[a]].concat(o2[a]); 653 } else if (Array.isArray(o1[a])) { 654 ret[a] = o1[a].concat(o2[a]); 655 } else if (typeof o1[a] == 'object') { 656 ret[a] = concatObjects(o1[a], o2[a]); 657 } 658 } 659 } 660 return ret; 661}; 662