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