src/jalview/bin/Launcher.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import java.io.File;
  24 import java.io.IOException;
  25 import java.lang.management.ManagementFactory;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Locale;
  29 import java.util.concurrent.TimeUnit;
  30
  31 import jalview.util.ChannelProperties;
  32 import jalview.util.LaunchUtils;
  33
  34 /**
  35  * A Launcher class for Jalview. This class is used to launch Jalview from the
  36  * shadowJar when Getdown is not used or available. It attempts to take all the
  37  * command line arguments to pass on to the jalview.bin.Jalview class, but to
  38  * insert a -Xmx memory setting to a sensible default, using the -jvmmempc and
  39  * -jvmmemmax application arguments if specified. If not specified then system
  40  * properties will be looked for by jalview.bin.MemorySetting. If the user has
  41  * provided the JVM with a -Xmx setting directly and not set -jvmmempc or
  42  * -jvmmemmax then this setting will be used and system properties ignored. If
  43  * -Xmx is set as well as -jvmmempc or -jvmmemmax as argument(s) then the -Xmx
  44  * argument will NOT be passed on to the main application launch.
  45  *
  46  * @author bsoares
  47  *
  48  */
  49 public class Launcher
  50 {
  51   private final static String startClass = "jalview.bin.Jalview";
  52
  53   private final static String dockIconPath = ChannelProperties
  54           .getProperty("logo.512");
  55
  56   /**
  57    * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
  58    * the same arguments but with memory adjusted based on extracted -jvmmempc
  59    * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and
  60    * dock:name arguments are also set.
  61    *
  62    * @param args
  63    */
  64   public static void main(String[] args)
  65   {
  66     if (!LaunchUtils.checkJavaVersion())
  67     {
  68       System.err.println("WARNING - The Java version being used (Java "
  69               + LaunchUtils.getJavaVersion()
  70               + ") may lead to problems. This installation of Jalview should be used with Java "
  71               + LaunchUtils.getJavaCompileVersion() + ".");
  72     }
  73
  74     final String javaBin = System.getProperty("java.home") + File.separator
  75             + "bin" + File.separator + "java";
  76
  77     List<String> command = new ArrayList<>();
  78     command.add(javaBin);
  79
  80     String memSetting = null;
  81
  82     boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
  83
  84     for (String jvmArg : ManagementFactory.getRuntimeMXBean()
  85             .getInputArguments())
  86     {
  87       command.add(jvmArg);
  88     }
  89     command.add("-cp");
  90     command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
  91
  92     String jvmmempc = null;
  93     String jvmmemmax = null;
  94     boolean debug = false;
  95     boolean wait = true;
  96     boolean quiet = false;
  97     // must set --debug before --launcher...
  98     boolean launcherstop = false;
  99     boolean launcherprint = false;
 100     boolean launcherwait = false;
 101     ArrayList<String> arguments = new ArrayList<>();
 102     for (String arg : args)
 103     {
 104       if (arg.equals("--debug"))
 105       {
 106         debug = true;
 107       }
 108       if (arg.equals("--quiet"))
 109       {
 110         quiet = true;
 111       }
 112       if (debug && arg.equals("--launcherprint"))
 113       {
 114         launcherprint = true;
 115       }
 116       if (debug && arg.equals("--launcherstop"))
 117       {
 118         launcherstop = true;
 119       }
 120       if (debug && arg.equals("--launcherwait"))
 121       {
 122         launcherwait = true;
 123       }
 124       // this ends the launcher immediately
 125       if (debug && arg.equals("--launchernowait"))
 126       {
 127         wait = false;
 128       }
 129       // Don't add the --launcher... args to Jalview launch
 130       if (arg.startsWith("--launcher"))
 131       {
 132         continue;
 133       }
 134       // jvmmempc and jvmmemmax args used to set memory and are not passed on to
 135       // startClass
 136       if (arg.startsWith(
 137               "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 138       {
 139         jvmmempc = arg.substring(
 140                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 141                         + 2);
 142       }
 143       else if (arg.startsWith(
 144               "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 145       {
 146         jvmmemmax = arg.substring(
 147                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
 148       }
 149       // --doubledash versions
 150       else if (arg.startsWith("--"
 151               + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 152       {
 153         jvmmempc = arg.substring(
 154                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 155                         + 3);
 156       }
 157       else if (arg.startsWith(
 158               "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 159       {
 160         jvmmemmax = arg.substring(
 161                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
 162       }
 163       // retain arg
 164       else
 165       {
 166         arguments.add(arg);
 167       }
 168     }
 169
 170     // use saved preferences if no cmdline args
 171     boolean useCustomisedSettings = LaunchUtils
 172             .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
 173     if (useCustomisedSettings)
 174     {
 175       if (jvmmempc == null)
 176       {
 177         jvmmempc = LaunchUtils
 178                 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
 179       }
 180       if (jvmmemmax == null)
 181       {
 182         jvmmemmax = LaunchUtils
 183                 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
 184       }
 185     }
 186
 187     // add these settings if not already specified
 188     boolean memSet = false;
 189     boolean dockIcon = false;
 190     boolean dockName = false;
 191     for (int i = 0; i < command.size(); i++)
 192     {
 193       String arg = command.get(i);
 194       if (arg.startsWith("-Xmx"))
 195       {
 196         // only use -Xmx if jvmmemmax and jvmmempc have not been set
 197         if (jvmmempc == null && jvmmemmax == null)
 198         {
 199           memSetting = arg;
 200           memSet = true;
 201         }
 202       }
 203       else if (arg.startsWith("-Xdock:icon"))
 204       {
 205         dockIcon = true;
 206       }
 207       else if (arg.startsWith("-Xdock:name"))
 208       {
 209         dockName = true;
 210       }
 211     }
 212
 213     if (!memSet)
 214     {
 215       long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
 216
 217       if (maxMemLong > 0)
 218       {
 219         memSetting = "-Xmx" + Long.toString(maxMemLong);
 220         memSet = true;
 221         command.add(memSetting);
 222       }
 223     }
 224
 225     if (isAMac)
 226     {
 227       if (!dockIcon)
 228       {
 229         command.add("-Xdock:icon=" + dockIconPath);
 230       }
 231       if (!dockName)
 232       {
 233         // -Xdock:name=... doesn't actually work :(
 234         // Leaving it in in case it gets fixed
 235         command.add(
 236                 "-Xdock:name=" + ChannelProperties.getProperty("app_name"));
 237         // this launches WITHOUT an icon in the macOS dock. Could be useful for
 238         // getdown?
 239         // command.add("-Dapple.awt.UIElement=false");
 240         // This also does not work for the dock
 241         command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
 242                 + ChannelProperties.getProperty("app_name"));
 243       }
 244     }
 245
 246     String scalePropertyArg = HiDPISetting.getScalePropertyArg();
 247     if (scalePropertyArg != null)
 248     {
 249       sysout(debug, quiet, "Running " + startClass + " with scale setting "
 250               + scalePropertyArg);
 251       command.add(scalePropertyArg);
 252     }
 253
 254     command.add(startClass);
 255     command.addAll(arguments);
 256
 257     final ProcessBuilder builder = new ProcessBuilder(command);
 258
 259     if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
 260             || launcherprint))
 261     {
 262       sysout(debug, quiet,
 263               "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
 264     }
 265     sysout(debug, quiet,
 266             "Running " + startClass + " with "
 267                     + (memSetting == null ? "no memory setting"
 268                             : ("memory setting " + memSetting)));
 269
 270     if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
 271             || (debug && launcherstop))
 272     {
 273       sysout(debug, quiet,
 274               "System property 'launcherstop' is set and not 'false'. Exiting.");
 275       System.exit(0);
 276     }
 277     try
 278     {
 279       builder.inheritIO();
 280       Process process = builder.start();
 281       if (wait || launcherwait)
 282       {
 283         sysout(debug, quiet, "Launching application process");
 284         process.waitFor();
 285       }
 286       else
 287       {
 288         int waitInt = 0;
 289         sysout(debug, quiet,
 290                 "Wait time for application process is " + waitInt + "ms");
 291         process.waitFor(waitInt, TimeUnit.MILLISECONDS);
 292       }
 293       sysout(debug, quiet, "Launcher process ending");
 294     } catch (IOException e)
 295     {
 296       if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
 297       {
 298         System.err.println("Caught a memory exception: " + e.getMessage());
 299         // Probably the "Cannot allocate memory" error, try without the memory
 300         // setting
 301         ArrayList<String> commandNoMem = new ArrayList<>();
 302         for (int i = 0; i < command.size(); i++)
 303         {
 304           if (!command.get(i).startsWith("-Xmx"))
 305           {
 306             commandNoMem.add(command.get(i));
 307           }
 308         }
 309         final ProcessBuilder builderNoMem = new ProcessBuilder(
 310                 commandNoMem);
 311         System.err.println("Command without memory setting: "
 312                 + String.join(" ", builderNoMem.command()));
 313         try
 314         {
 315           builderNoMem.inheritIO();
 316           Process processNoMem = builderNoMem.start();
 317           processNoMem.waitFor();
 318         } catch (Exception ex)
 319         {
 320           ex.printStackTrace();
 321         }
 322       }
 323       else
 324       {
 325         e.printStackTrace();
 326       }
 327     } catch (Exception e)
 328     {
 329       e.printStackTrace();
 330     }
 331   }
 332
 333   private static void sysout(boolean debug, boolean quiet, String message)
 334   {
 335     if (debug && !quiet)
 336     {
 337       System.out.println("LAUNCHERDEBUG - " + message);
 338     }
 339   }
 340
 341 }