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 dependencies: ["boot_jdk", "gnumake", "jtreg"], 217 configure_args: ["--with-default-make-target=all"], 218 configure_args_32bit: ["--with-target-bits=32", "--with-jvm-variants=client,server"], 219 configure_args_debug: ["--enable-debug"], 220 configure_args_slowdebug: ["--with-debug-level=slowdebug"], 221 organization: "jpg.infra.builddeps" 222 }; 223 224 return common; 225 }; 226 227 /** 228 * Generates the profiles part of the configuration. 229 * 230 * @param input External data to use for generating the configuration 231 * @param common The common values 232 * @returns {{}} Profiles part of the configuration 233 */ 234 var getJibProfilesProfiles = function (input, common) { 235 var profiles = {}; 236 237 // Main SE profiles 238 var mainProfiles = { 239 240 "linux-x64": { 241 target_os: "linux", 242 target_cpu: "x64", 243 dependencies: concat(common.dependencies, "devkit"), 244 configure_args: common.configure_args, 245 configure_args: concat(common.configure_args, "--with-zlib=system"), 246 make_args: common.make_args 247 }, 248 249 "linux-x86": { 250 target_os: "linux", 251 target_cpu: "x86", 252 build_cpu: "x64", 253 dependencies: concat(common.dependencies, "devkit"), 254 configure_args: concat(common.configure_args, common.configure_args_32bit), 255 configure_args: concat(common.configure_args, "--with-zlib=system"), 256 make_args: common.make_args 257 }, 258 259 "macosx-x64": { 260 target_os: "macosx", 261 target_cpu: "x64", 262 dependencies: concat(common.dependencies, "devkit"), 263 configure_args: common.configure_args, 264 configure_args: concat(common.configure_args, "--with-zlib=system"), 265 make_args: common.make_args 266 }, 267 268 "solaris-x64": { 269 target_os: "solaris", 270 target_cpu: "x64", 271 dependencies: concat(common.dependencies, "devkit", "cups"), 272 configure_args: common.configure_args, 273 configure_args: concat(common.configure_args, "--with-zlib=system"), 274 make_args: common.make_args 275 }, 276 277 "solaris-sparcv9": { 278 target_os: "solaris", 279 target_cpu: "sparcv9", 280 dependencies: concat(common.dependencies, "devkit", "cups"), 281 configure_args: common.configure_args, 282 configure_args: concat(common.configure_args, "--with-zlib=system"), 283 make_args: common.make_args 284 }, 285 286 "windows-x64": { 287 target_os: "windows", 288 target_cpu: "x64", 289 dependencies: concat(common.dependencies, "devkit", "freetype"), 290 configure_args: common.configure_args, 291 make_args: common.make_args 292 }, 293 294 "windows-x86": { 295 target_os: "windows", 296 target_cpu: "x86", 297 build_cpu: "x64", 298 dependencies: concat(common.dependencies, "devkit", "freetype"), 299 configure_args: concat(common.configure_args, common.configure_args_32bit), 300 make_args: common.make_args 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. 314 var openOnlyProfilesExtra = { 315 "linux-x64-open": { 316 configure_args: ["--with-default-make-target=all profiles"], 317 }, 318 319 "linux-x86-open": { 320 configure_args: ["--with-default-make-target=all profiles"], 321 } 322 }; 323 var openOnlyProfiles = concatObjects(openOnlyProfiles, openOnlyProfilesExtra); 324 325 profiles = concatObjects(profiles, openOnlyProfiles); 326 // Generate debug profiles for the open jprt profiles 327 profiles = concatObjects(profiles, generateDebugProfiles(common, openOnlyProfiles)); 328 329 // Profiles used to run tests. Used in JPRT. 330 var testOnlyProfiles = { 331 332 "run-test": { 333 target_os: input.build_os, 334 target_cpu: input.build_cpu, 335 dependencies: [ "jtreg", "gnumake" ], 336 labels: "test" 337 } 338 }; 339 profiles = concatObjects(profiles, testOnlyProfiles); 340 341 // Generate the missing platform attributes 342 profiles = generatePlatformAttributes(profiles); 343 return profiles; 344 }; 345 346 /** 347 * Generate the dependencies part of the configuration 348 * 349 * @param input External data to use for generating the configuration 350 * @param common The common values 351 * @returns {{}} Dependencies part of configuration 352 */ 353 var getJibProfilesDependencies = function (input, common) { 354 355 var boot_jdk_platform = input.build_os + "-" 356 + (input.build_cpu == "x86" ? "i586" : input.build_cpu); 357 358 var devkit_platform_revisions = { 359 linux_x64: "gcc4.9.2-OEL6.4+1.0", 360 macosx_x64: "Xcode6.3-MacOSX10.9+1.0", 361 solaris_x64: "SS12u4-Solaris11u1+1.0", 362 solaris_sparcv9: "SS12u4-Solaris11u1+1.0", 363 windows_x64: "VS2013SP4+1.0" 364 }; 365 366 var devkit_platform = (input.target_cpu == "x86" 367 ? input.target_os + "_x64" 368 : input.target_platform); 369 370 var dependencies = { 371 372 boot_jdk: { 373 server: "javare", 374 module: "jdk", 375 revision: "8", 376 checksum_file: boot_jdk_platform + "/MD5_VALUES", 377 file: boot_jdk_platform + "/jdk-8-" + boot_jdk_platform + ".tar.gz", 378 configure_args: (input.build_os == "macosx" 379 ? "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0.jdk/Contents/Home" 380 : "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0") 381 }, 382 383 devkit: { 384 organization: common.organization, 385 ext: "tar.gz", 386 module: "devkit-" + devkit_platform, 387 revision: devkit_platform_revisions[devkit_platform] 388 }, 389 390 build_devkit: { 391 organization: common.organization, 392 ext: "tar.gz", 393 module: "devkit-" + input.build_platform, 394 revision: devkit_platform_revisions[input.build_platform] 395 }, 396 397 cups: { 398 organization: common.organization, 399 ext: "tar.gz", 400 revision: "1.0118+1.0" 401 }, 402 403 jtreg: { 404 server: "javare", 405 revision: "4.2", 406 build_number: "b01", 407 checksum_file: "MD5_VALUES", 408 file: "jtreg_bin-4.2.zip", 409 environment_name: "JT_HOME" 410 }, 411 412 gnumake: { 413 organization: common.organization, 414 ext: "tar.gz", 415 revision: "4.0+1.0", 416 417 module: (input.build_os == "windows" 418 ? "gnumake-" + input.build_osenv_platform 419 : "gnumake-" + input.build_platform), 420 421 configure_args: (input.build_os == "windows" 422 ? "MAKE=" + input.get("gnumake", "install_path") + "/cygwin/bin/make" 423 : "MAKE=" + input.get("gnumake", "install_path") + "/bin/make"), 424 425 environment_path: (input.build_os == "windows" 426 ? input.get("gnumake", "install_path") + "/cygwin/bin" 427 : input.get("gnumake", "install_path") + "/bin") 428 }, 429 430 freetype: { 431 organization: common.organization, 432 ext: "tar.gz", 433 revision: "2.3.4+1.0", 434 module: "freetype-" + input.target_platform 435 } 436 }; 437 438 return dependencies; 439 }; 440 441 /** 442 * Generate the missing platform attributes for profiles 443 * 444 * @param profiles Profiles map to generate attributes on 445 * @returns {{}} New profiles map with platform attributes fully filled in 446 */ 447 var generatePlatformAttributes = function (profiles) { 448 var ret = concatObjects(profiles, {}); 449 for (var profile in profiles) { 450 if (ret[profile].build_os == null) { 451 ret[profile].build_os = ret[profile].target_os; 452 } 453 if (ret[profile].build_cpu == null) { 454 ret[profile].build_cpu = ret[profile].target_cpu; 455 } 456 ret[profile].target_platform = ret[profile].target_os + "_" + ret[profile].target_cpu; 457 ret[profile].build_platform = ret[profile].build_os + "_" + ret[profile].build_cpu; 458 } 459 return ret; 460 }; 461 462 /** 463 * Generates debug versions of profiles. Clones the given profiles and adds 464 * debug metadata. 465 * 466 * @param common Common values 467 * @param profiles Profiles map to generate debug profiles for 468 * @returns {{}} New map of profiles containing debug profiles 469 */ 470 var generateDebugProfiles = function (common, profiles) { 471 var newProfiles = {}; 472 for (var profile in profiles) { 473 var debugProfile = profile + "-debug"; 474 newProfiles[debugProfile] = clone(profiles[profile]); 475 newProfiles[debugProfile].debug_level = "fastdebug"; 476 newProfiles[debugProfile].labels 477 = concat(newProfiles[debugProfile].labels || [], "debug"), 478 newProfiles[debugProfile].configure_args 479 = concat(newProfiles[debugProfile].configure_args, 480 common.configure_args_debug); 481 } 482 return newProfiles; 483 }; 484 485 /** 486 * Generates slowdebug 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 */ 493 var generateSlowdebugProfiles = function (common, profiles) { 494 var newProfiles = {}; 495 for (var profile in profiles) { 496 var debugProfile = profile + "-slowdebug"; 497 newProfiles[debugProfile] = clone(profiles[profile]); 498 newProfiles[debugProfile].debug_level = "slowdebug"; 499 newProfiles[debugProfile].labels 500 = concat(newProfiles[debugProfile].labels || [], "slowdebug"), 501 newProfiles[debugProfile].configure_args 502 = concat(newProfiles[debugProfile].configure_args, 503 common.configure_args_slowdebug); 504 } 505 return newProfiles; 506 }; 507 508 /** 509 * Generates open only versions of profiles. Clones the given profiles and adds 510 * open metadata. 511 * 512 * @param common Common values 513 * @param profiles Profiles map to generate open only profiles for 514 * @returns {{}} New map of profiles containing open only profiles 515 */ 516 var generateOpenOnlyProfiles = function (common, profiles) { 517 var newProfiles = {}; 518 for (var profile in profiles) { 519 var openProfile = profile + "-open"; 520 newProfiles[openProfile] = clone(profiles[profile]); 521 newProfiles[openProfile].labels 522 = concat(newProfiles[openProfile].labels || [], "open"), 523 newProfiles[openProfile].configure_args 524 = concat(newProfiles[openProfile].configure_args, 525 "--enable-openjdk-only"); 526 } 527 return newProfiles; 528 }; 529 530 /** 531 * Deep clones an object tree. 532 * 533 * @param o Object to clone 534 * @returns {{}} Clone of o 535 */ 536 var clone = function (o) { 537 return JSON.parse(JSON.stringify(o)); 538 }; 539 540 /** 541 * Concatenates all arguments into a new array 542 * 543 * @returns {Array.<T>} New array containing all arguments 544 */ 545 var concat = function () { 546 return Array.prototype.concat.apply([], arguments); 547 }; 548 549 /** 550 * Copies all elements in an array into a new array but replacing all 551 * occurrences of original with replacement. 552 * 553 * @param original Element to look for 554 * @param replacement Element to replace with 555 * @param a Array to copy 556 * @returns {Array} New array with all occurrences of original replaced 557 * with replacement 558 */ 559 var replace = function (original, replacement, a) { 560 var newA = []; 561 for (var i in a) { 562 if (original == a[i]) { 563 newA.push(replacement); 564 } else { 565 newA.push(a[i]); 566 } 567 } 568 return newA; 569 }; 570 571 /** 572 * Deep concatenation of two objects. For each node encountered, merge 573 * the contents with the corresponding node in the other object tree, 574 * treating all strings as array elements. 575 * 576 * @param o1 Object to concatenate 577 * @param o2 Object to concatenate 578 * @returns {{}} New object tree containing the concatenation of o1 and o2 579 */ 580 var concatObjects = function (o1, o2) { 581 var ret = {}; 582 for (var a in o1) { 583 if (o2[a] == null) { 584 ret[a] = o1[a]; 585 } 586 } 587 for (var a in o2) { 588 if (o1[a] == null) { 589 ret[a] = o2[a]; 590 } else { 591 if (typeof o1[a] == 'string') { 592 ret[a] = [o1[a]].concat(o2[a]); 593 } else if (Array.isArray(o1[a])) { 594 ret[a] = o1[a].concat(o2[a]); 595 } else if (typeof o1[a] == 'object') { 596 ret[a] = concatObjects(o1[a], o2[a]); 597 } 598 } 599 } 600 return ret; 601 };