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