1 /*
   2  * Copyright (c) 2011, 2013, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 import java.io.File;
  26 import java.io.FileNotFoundException;
  27 import java.io.IOException;
  28 import java.io.PrintWriter;
  29 import java.io.UnsupportedEncodingException;
  30 import java.nio.file.FileSystems;
  31 import java.util.Iterator;
  32 import java.util.LinkedList;
  33 import java.util.UUID;
  34 import java.util.Vector;
  35 
  36 public class WinGammaPlatformVC10 extends WinGammaPlatform {
  37 
  38 
  39    LinkedList <String>filters = new LinkedList<String>();
  40    LinkedList <String[]>filterDeps = new LinkedList<String[]>();
  41 
  42     @Override
  43     protected String getProjectExt() {
  44         return ".vcxproj";
  45     }
  46 
  47     @Override
  48     public void writeProjectFile(String projectFileName, String projectName,
  49             Vector<BuildConfig> allConfigs) throws IOException {
  50         System.out.println();
  51         System.out.println("    Writing .vcxproj file: " + projectFileName);
  52 
  53         String projDir = Util.normalize(new File(projectFileName).getParent());
  54 
  55         printWriter = new PrintWriter(projectFileName, "UTF-8");
  56         printWriter.println("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
  57         startTag("Project",
  58                 "DefaultTargets", "Build",
  59                 "ToolsVersion", "4.0",
  60                 "xmlns", "http://schemas.microsoft.com/developer/msbuild/2003");
  61         startTag("ItemGroup",
  62                 "Label", "ProjectConfigurations");
  63         for (BuildConfig cfg : allConfigs) {
  64             startTag("ProjectConfiguration",
  65                     "Include", cfg.get("Name"));
  66             tagData("Configuration", cfg.get("Id"));
  67             tagData("Platform", cfg.get("PlatformName"));
  68             endTag();
  69         }
  70         endTag();
  71 
  72         startTag("PropertyGroup", "Label", "Globals");
  73         tagData("ProjectGuid", "{8822CB5C-1C41-41C2-8493-9F6E1994338B}");
  74         tag("SccProjectName");
  75         tag("SccLocalPath");
  76         endTag();
  77 
  78         tag("Import", "Project", "$(VCTargetsPath)\\Microsoft.Cpp.Default.props");
  79 
  80         for (BuildConfig cfg : allConfigs) {
  81             startTag(cfg, "PropertyGroup", "Label", "Configuration");
  82             tagData("ConfigurationType", "DynamicLibrary");
  83             tagData("UseOfMfc", "false");
  84             endTag();
  85         }
  86 
  87         tag("Import", "Project", "$(VCTargetsPath)\\Microsoft.Cpp.props");
  88         startTag("ImportGroup", "Label", "ExtensionSettings");
  89         endTag();
  90         for (BuildConfig cfg : allConfigs) {
  91             startTag(cfg, "ImportGroup", "Label", "PropertySheets");
  92             tag("Import",
  93                     "Project", "$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props",
  94                     "Condition", "exists('$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props')",
  95                     "Label", "LocalAppDataPlatform");
  96             endTag();
  97         }
  98 
  99         tag("PropertyGroup", "Label", "UserMacros");
 100 
 101         startTag("PropertyGroup");
 102         tagData("_ProjectFileVersion", "10.0.30319.1");
 103         for (BuildConfig cfg : allConfigs) {
 104             tagData(cfg, "OutDir", cfg.get("OutputDir") + Util.sep);
 105             tagData(cfg, "IntDir", cfg.get("OutputDir") + Util.sep);
 106             tagData(cfg, "LinkIncremental", "false");
 107         }
 108         for (BuildConfig cfg : allConfigs) {
 109             tagData(cfg, "CodeAnalysisRuleSet", "AllRules.ruleset");
 110             tag(cfg, "CodeAnalysisRules");
 111             tag(cfg, "CodeAnalysisRuleAssemblies");
 112         }
 113         endTag();
 114 
 115         for (BuildConfig cfg : allConfigs) {
 116             startTag(cfg, "ItemDefinitionGroup");
 117             startTag("ClCompile");
 118             tagV(cfg.getV("CompilerFlags"));
 119             endTag();
 120 
 121             startTag("Link");
 122             tagV(cfg.getV("LinkerFlags"));
 123             endTag();
 124 
 125             startTag("PreLinkEvent");
 126             tagData("Message", BuildConfig.getFieldString(null, "PrelinkDescription"));
 127             tagData("Command", cfg.expandFormat(BuildConfig.getFieldString(null, "PrelinkCommand").replace("\t", "\r\n")));
 128             endTag();
 129 
 130             endTag();
 131         }
 132 
 133         writeFiles(allConfigs, projDir);
 134 
 135         tag("Import", "Project", "$(VCTargetsPath)\\Microsoft.Cpp.targets");
 136         startTag("ImportGroup", "Label", "ExtensionTargets");
 137         endTag();
 138 
 139         endTag();
 140         printWriter.close();
 141         System.out.println("    Done writing .vcxproj file.");
 142 
 143         writeFilterFile(projectFileName, projectName, allConfigs, projDir);
 144         writeUserFile(projectFileName, allConfigs);
 145     }
 146 
 147 
 148     private void writeUserFile(String projectFileName, Vector<BuildConfig> allConfigs) throws FileNotFoundException, UnsupportedEncodingException {
 149         String userFileName = projectFileName + ".user";
 150         if (new File(userFileName).exists()) {
 151             return;
 152         }
 153         System.out.print("    Writing .vcxproj.user file: " + userFileName);
 154         printWriter = new PrintWriter(userFileName, "UTF-8");
 155 
 156         printWriter.println("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
 157         startTag("Project",
 158                 "ToolsVersion", "4.0",
 159                 "xmlns", "http://schemas.microsoft.com/developer/msbuild/2003");
 160 
 161         for (BuildConfig cfg : allConfigs) {
 162             startTag(cfg, "PropertyGroup");
 163             tagData("LocalDebuggerCommand", cfg.get("JdkTargetRoot") + "\\bin\\java.exe");
 164             // The JVM loads some libraries using a path relative to
 165             // itself because it expects to be in a JRE or a JDK. The java
 166             // launcher's '-XXaltjvm=' option allows the JVM to be outside
 167             // the JRE or JDK so '-Dsun.java.launcher.is_altjvm=true'
 168             // forces a fake JAVA_HOME relative path to be used to
 169             // find the other libraries. The '-XX:+PauseAtExit' option
 170             // causes the VM to wait for key press before exiting; this
 171             // allows any stdout or stderr messages to be seen before
 172             // the cmdtool exits.
 173             tagData("LocalDebuggerCommandArguments", "-XXaltjvm=$(TargetDir) "
 174                     + "-Dsun.java.launcher.is_altjvm=true "
 175                     + "-XX:+UnlockDiagnosticVMOptions -XX:+PauseAtExit");
 176             tagData("LocalDebuggerEnvironment", "JAVA_HOME=" + cfg.get("JdkTargetRoot"));
 177             endTag();
 178         }
 179 
 180         endTag();
 181         printWriter.close();
 182         System.out.println("    Done.");
 183     }
 184 
 185     public void addFilter(String rPath) {
 186        filters.add(rPath);
 187     }
 188 
 189     public void addFilterDependency(String fileLoc, String filter) {
 190       filterDeps.add(new String[] {fileLoc, filter});
 191     }
 192 
 193     private void writeFilterFile(String projectFileName, String projectName,
 194             Vector<BuildConfig> allConfigs, String base) throws FileNotFoundException, UnsupportedEncodingException {
 195         String filterFileName = projectFileName + ".filters";
 196         System.out.print("    Writing .vcxproj.filters file: " + filterFileName);
 197         printWriter = new PrintWriter(filterFileName, "UTF-8");
 198 
 199         printWriter.println("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
 200         startTag("Project",
 201                 "ToolsVersion", "4.0",
 202                 "xmlns", "http://schemas.microsoft.com/developer/msbuild/2003");
 203 
 204         startTag("ItemGroup");
 205         for (String filter : filters) {
 206            startTag("Filter", "Include",filter);
 207            UUID uuid = UUID.randomUUID();
 208            tagData("UniqueIdentifier", "{" + uuid.toString() + "}");
 209            endTag();
 210         }
 211         startTag("Filter", "Include", "Resource Files");
 212         UUID uuid = UUID.randomUUID();
 213         tagData("UniqueIdentifier", "{" + uuid.toString() + "}");
 214         tagData("Extensions", "ico;cur;bmp;dlg;rc2;rct;bin;cnt;rtf;gif;jpg;jpeg;jpe");
 215         endTag();
 216         endTag();
 217 
 218         //TODO - do I need to split cpp and hpp files?
 219 
 220         // then all files
 221         startTag("ItemGroup");
 222         for (String[] dep : filterDeps) {
 223            String tagName = getFileTagFromSuffix(dep[0]);
 224 
 225            startTag(tagName, "Include", dep[0]);
 226            tagData("Filter", dep[1]);
 227            endTag();
 228         }
 229         endTag();
 230 
 231         endTag();
 232         printWriter.close();
 233         System.out.println("    Done.");
 234     }
 235 
 236     public String getFileTagFromSuffix(String fileName) {
 237        if (fileName.endsWith(".cpp")) {
 238           return"ClCompile";
 239        } else if (fileName.endsWith(".c")) {
 240           return "ClCompile";
 241        } else if (fileName.endsWith(".hpp")) {
 242           return"ClInclude";
 243        } else if (fileName.endsWith(".h")) {
 244           return "ClInclude";
 245        } else {
 246           return"None";
 247        }
 248     }
 249 
 250     void writeFiles(Vector<BuildConfig> allConfigs, String projDir) {
 251        // This code assummes there are no config specific includes.
 252        startTag("ItemGroup");
 253 
 254        String sourceBase = BuildConfig.getFieldString(null, "SourceBase");
 255 
 256        // Use first config for all global absolute includes.
 257        BuildConfig baseConfig = allConfigs.firstElement();
 258        Vector<String> rv = new Vector<String>();
 259 
 260        // Then use first config for all relative includes
 261        Vector<String> ri = new Vector<String>();
 262        baseConfig.collectRelevantVectors(ri, "RelativeSrcInclude");
 263        for (String f : ri) {
 264           rv.add(sourceBase + Util.sep + f);
 265        }
 266 
 267        baseConfig.collectRelevantVectors(rv, "AbsoluteSrcInclude");
 268 
 269        handleIncludes(rv, allConfigs);
 270 
 271        endTag();
 272     }
 273 
 274     // Will visit file tree for each include
 275     private void handleIncludes(Vector<String> includes, Vector<BuildConfig> allConfigs) {
 276        for (String path : includes)  {
 277           FileTreeCreatorVC10 ftc = new FileTreeCreatorVC10(FileSystems.getDefault().getPath(path) , allConfigs, this);
 278           try {
 279              ftc.writeFileTree();
 280           } catch (IOException e) {
 281              e.printStackTrace();
 282           }
 283        }
 284     }
 285 
 286     String buildCond(BuildConfig cfg) {
 287         return "'$(Configuration)|$(Platform)'=='"+cfg.get("Name")+"'";
 288     }
 289 
 290     void tagV(Vector<String> v) {
 291         Iterator<String> i = v.iterator();
 292         while(i.hasNext()) {
 293             String name = i.next();
 294             String data = i.next();
 295             tagData(name, data);
 296         }
 297     }
 298 
 299     void tagData(BuildConfig cfg, String name, String data) {
 300         tagData(name, data, "Condition", buildCond(cfg));
 301     }
 302 
 303     void tag(BuildConfig cfg, String name, String... attrs) {
 304         String[] ss = new String[attrs.length + 2];
 305         ss[0] = "Condition";
 306         ss[1] = buildCond(cfg);
 307         System.arraycopy(attrs, 0, ss, 2, attrs.length);
 308 
 309         tag(name, ss);
 310     }
 311 
 312     void startTag(BuildConfig cfg, String name, String... attrs) {
 313         String[] ss = new String[attrs.length + 2];
 314         ss[0] = "Condition";
 315         ss[1] = buildCond(cfg);
 316         System.arraycopy(attrs, 0, ss, 2, attrs.length);
 317 
 318         startTag(name, ss);
 319     }
 320 
 321 }
 322 
 323 class CompilerInterfaceVC10 extends CompilerInterface {
 324 
 325     @Override
 326     Vector getBaseCompilerFlags(Vector defines, Vector includes, String outDir) {
 327         Vector rv = new Vector();
 328 
 329         addAttr(rv, "AdditionalIncludeDirectories", Util.join(";", includes));
 330         addAttr(rv, "PreprocessorDefinitions",
 331                 Util.join(";", defines).replace("\\\"", "\""));
 332         addAttr(rv, "PrecompiledHeaderFile", "precompiled.hpp");
 333         addAttr(rv, "PrecompiledHeaderOutputFile", outDir+Util.sep+"vm.pch");
 334         addAttr(rv, "AssemblerListingLocation", outDir);
 335         addAttr(rv, "ObjectFileName", outDir+Util.sep);
 336         addAttr(rv, "ProgramDataBaseFileName", outDir+Util.sep+"jvm.pdb");
 337         // Set /nologo option
 338         addAttr(rv, "SuppressStartupBanner", "true");
 339         // Surpass the default /Tc or /Tp.
 340         addAttr(rv, "CompileAs", "Default");
 341         // Set /W3 option.
 342         addAttr(rv, "WarningLevel", "Level3");
 343         // Set /WX option,
 344         addAttr(rv, "TreatWarningAsError", "true");
 345         // Set /GS option
 346         addAttr(rv, "BufferSecurityCheck", "false");
 347         // Set /Zi option.
 348         addAttr(rv, "DebugInformationFormat", "ProgramDatabase");
 349         // Set /Yu option.
 350         addAttr(rv, "PrecompiledHeader", "Use");
 351         // Set /EHsc- option
 352         addAttr(rv, "ExceptionHandling", "");
 353 
 354         addAttr(rv, "MultiProcessorCompilation", "true");
 355 
 356         return rv;
 357     }
 358 
 359     @Override
 360     Vector getDebugCompilerFlags(String opt, String platformName) {
 361         Vector rv = new Vector();
 362 
 363         // Set /On option
 364         addAttr(rv, "Optimization", opt);
 365         // Set /FR option.
 366         addAttr(rv, "BrowseInformation", "true");
 367         addAttr(rv, "BrowseInformationFile", "$(IntDir)");
 368         // Set /MD option.
 369         addAttr(rv, "RuntimeLibrary", "MultiThreadedDLL");
 370         // Set /Oy- option
 371         addAttr(rv, "OmitFramePointers", "false");
 372         // Set /homeparams for x64 debug builds
 373         if(platformName.equals("x64")) {
 374             addAttr(rv, "AdditionalOptions", "/homeparams");
 375         }
 376 
 377         return rv;
 378     }
 379 
 380     @Override
 381     Vector getProductCompilerFlags() {
 382         Vector rv = new Vector();
 383 
 384         // Set /O2 option.
 385         addAttr(rv, "Optimization", "MaxSpeed");
 386         // Set /Oy- option
 387         addAttr(rv, "OmitFramePointers", "false");
 388         // Set /Ob option.  1 is expandOnlyInline
 389         addAttr(rv, "InlineFunctionExpansion", "OnlyExplicitInline");
 390         // Set /GF option.
 391         addAttr(rv, "StringPooling", "true");
 392         // Set /MD option. 2 is rtMultiThreadedDLL
 393         addAttr(rv, "RuntimeLibrary", "MultiThreadedDLL");
 394         // Set /Gy option
 395         addAttr(rv, "FunctionLevelLinking", "true");
 396 
 397         return rv;
 398     }
 399 
 400     @Override
 401     Vector getBaseLinkerFlags(String outDir, String outDll, String platformName) {
 402         Vector rv = new Vector();
 403 
 404         addAttr(rv, "AdditionalOptions",
 405                 "/export:JNI_GetDefaultJavaVMInitArgs " +
 406                 "/export:JNI_CreateJavaVM " +
 407                 "/export:JVM_FindClassFromBootLoader "+
 408                 "/export:JNI_GetCreatedJavaVMs "+
 409                 "/export:jio_snprintf /export:jio_printf "+
 410                 "/export:jio_fprintf /export:jio_vfprintf "+
 411                 "/export:jio_vsnprintf "+
 412                 "/export:JVM_GetVersionInfo "+
 413                 "/export:JVM_GetThreadStateNames "+
 414                 "/export:JVM_GetThreadStateValues "+
 415                 "/export:JVM_InitAgentProperties");
 416         addAttr(rv, "AdditionalDependencies", "kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;Wsock32.lib;winmm.lib;psapi.lib");
 417         addAttr(rv, "OutputFile", outDll);
 418         addAttr(rv, "SuppressStartupBanner", "true");
 419         addAttr(rv, "ModuleDefinitionFile", outDir+Util.sep+"vm.def");
 420         addAttr(rv, "ProgramDatabaseFile", outDir+Util.sep+"jvm.pdb");
 421         addAttr(rv, "SubSystem", "Windows");
 422         addAttr(rv, "BaseAddress", "0x8000000");
 423         addAttr(rv, "ImportLibrary", outDir+Util.sep+"jvm.lib");
 424 
 425         if(platformName.equals("Win32")) {
 426             addAttr(rv, "TargetMachine", "MachineX86");
 427         } else {
 428             addAttr(rv, "TargetMachine", "MachineX64");
 429         }
 430 
 431         // We always want the /DEBUG option to get full symbol information in the pdb files
 432         addAttr(rv, "GenerateDebugInformation", "true");
 433 
 434         return rv;
 435     }
 436 
 437     @Override
 438     Vector getDebugLinkerFlags() {
 439         Vector rv = new Vector();
 440 
 441         // Empty now that /DEBUG option is used by all configs
 442 
 443         return rv;
 444     }
 445 
 446     @Override
 447     Vector getProductLinkerFlags() {
 448         Vector rv = new Vector();
 449 
 450         // Set /OPT:REF option.
 451         addAttr(rv, "OptimizeReferences", "true");
 452         // Set /OPT:ICF option.
 453         addAttr(rv, "EnableCOMDATFolding", "true");
 454 
 455         return rv;
 456     }
 457 
 458     @Override
 459     void getAdditionalNonKernelLinkerFlags(Vector rv) {
 460         extAttr(rv, "AdditionalOptions", " /export:AsyncGetCallTrace");
 461     }
 462 
 463     @Override
 464     String getOptFlag() {
 465         return "MaxSpeed";
 466     }
 467 
 468     @Override
 469     String getNoOptFlag() {
 470         return "Disabled";
 471     }
 472 
 473     @Override
 474     String makeCfgName(String flavourBuild, String platform) {
 475         return  flavourBuild + "|" + platform;
 476     }
 477 
 478 }