simplify executable debug options

Author: pquiring

native/linux/build.xml

@@ -23,8 +23,7 @@
 
       <!-- build cli version -->
       <exec command="gcc ${opt} -I ${java.home}/include -I ${java.home}/include/@{linux} -I ../headers -I ../opencl -Wno-write-strings -D_JF_CLI loader.cpp native.a @{libs} -o ${user.home}/bin/jfexec"/>
-      <exec command="gcc ${opt} -I ${java.home}/include -I ${java.home}/include/@{linux} -I ../headers -I ../opencl -Wno-write-strings -D_JF_CLI -D_JF_DEBUG loader.cpp native.a @{libs} -o ${user.home}/bin/jfexecd"/>
-      <exec command="gcc ${opt} -I ${java.home}/include -I ${java.home}/include/@{linux} -I ../headers -I ../opencl -Wno-write-strings -D_JF_CLI -D_JF_DEBUG -D_JF_SERVICE loader.cpp native.a @{libs} -o ${user.home}/bin/jfexecsd"/>
+      <exec command="gcc ${opt} -I ${java.home}/include -I ${java.home}/include/@{linux} -I ../headers -I ../opencl -Wno-write-strings -D_JF_CLI -D_JF_SERVICE loader.cpp native.a @{libs} -o ${user.home}/bin/jfexecs"/>
 
       <!-- build shared library -->
       <exec command="gcc ${opt} -shared native.o glfw.o glfw-null.o @{libs} -o ${user.home}/bin/jfnative64.so"/>

native/linux/loader.cpp

@@ -61,6 +61,8 @@ char xoptions[MAX_PATH];
 char cfgargs[1024];
 bool graal = false;
 bool debug = false;
+int debug_port = 9010;
+char debug_opt[64];
 char errmsg[1024];
 
 /* Prototypes */
@@ -243,19 +245,24 @@ JavaVMInitArgs *BuildArgs() {
   int nOpts = 0;
   char *opts[64];
   int idx;
+  char *jf_debug;
 
-#ifdef _JF_DEBUG
-  debug = true;
-#else
-  if (getenv("JF_DEBUG") != NULL) {
-    debug = true;
+  jf_debug = getenv("JF_DEBUG");
+  if (jf_debug != NULL) {
+    if (strcmp(jf_debug, "true") == 0) {
+      debug = true;
+    }
+  }
+  jf_debug = getenv("JF_DEBUG_PORT");
+  if (jf_debug != NULL) {
+    debug_port = atoi(jf_debug);
   }
-#endif
 
   if (debug) {
     opts[nOpts++] = "-Djava.debug=true";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote";
-    opts[nOpts++] = "-Dcom.sun.management.jmxremote.port=9010";
+    sprintf(debug_opt, "-Dcom.sun.management.jmxremote.port=%d", debug_port);
+    opts[nOpts++] = debug_opt;
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.local.only=false";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.authenticate=false";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.ssl=false";
@@ -521,6 +528,9 @@ bool loadProperties() {
     else if (strncmp(ln1, "DEBUG=", 6) == 0) {
       debug = true;
     }
+    else if (strncmp(ln1, "DEBUG_PORT=", 11) == 0) {
+      debug_port = atoi(ln1 + 11);
+    }
     ln1 = ln2;
   }
   free(data);

native/mac/build.xml

@@ -19,7 +19,6 @@
 
     <!-- build native cli executable -->
     <exec command="gcc -framework CoreFoundation -I ${java.home}/include -I ${java.home}/include/darwin -I ../headers -D_JF_CLI loader.mm ${libs} -o ${user.home}/bin/jfexec"/>
-    <exec command="gcc -framework CoreFoundation -I ${java.home}/include -I ${java.home}/include/darwin -I ../headers -D_JF_CLI -D_JF_DEBUG loader.mm ${libs} -o ${user.home}/bin/jfexecd"/>
 
     <delete>
       <fileset dir=".">

native/mac/loader.mm

@@ -63,6 +63,9 @@
 char cfgargs[1024];
 char app_path[MAX_PATH];
 char app_name[MAX_PATH];
+bool debug = false;
+int debug_port = 9010;
+char debug_opt[64];
 
 /* Prototypes */
 void error(char *msg);
@@ -153,17 +156,30 @@ void printException(JNIEnv *env) {
   int nOpts = 0;
   char *opts[64];
   int idx;
+  char *jf_debug;
 
-#ifdef _JF_DEBUG
-  opts[nOpts++] = "-Djava.debug=true";
-  opts[nOpts++] = "-Dcom.sun.management.jmxremote";
-  opts[nOpts++] = "-Dcom.sun.management.jmxremote.port=9010";
-  opts[nOpts++] = "-Dcom.sun.management.jmxremote.local.only=false";
-  opts[nOpts++] = "-Dcom.sun.management.jmxremote.authenticate=false";
-  opts[nOpts++] = "-Dcom.sun.management.jmxremote.ssl=false";
-#else
-  opts[nOpts++] = "-XX:-UsePerfData";
-#endif
+  jf_debug = getenv("JF_DEBUG");
+  if (jf_debug != NULL) {
+    if (strcmp(jf_debug, "true") == 0) {
+      debug = true;
+    }
+  }
+  jf_debug = getenv("JF_DEBUG_PORT");
+  if (jf_debug != NULL) {
+    debug_port = atoi(jf_debug);
+  }
+
+  if (debug) {
+    opts[nOpts++] = "-Djava.debug=true";
+    opts[nOpts++] = "-Dcom.sun.management.jmxremote";
+    sprintf(debug_opt, "-Dcom.sun.management.jmxremote.port=%d", debug_port);
+    opts[nOpts++] = debug_opt;
+    opts[nOpts++] = "-Dcom.sun.management.jmxremote.local.only=false";
+    opts[nOpts++] = "-Dcom.sun.management.jmxremote.authenticate=false";
+    opts[nOpts++] = "-Dcom.sun.management.jmxremote.ssl=false";
+  } else {
+    opts[nOpts++] = "-XX:-UsePerfData";
+  }
   opts[nOpts++] = (char*)"-Djava.app.home=.";
   if (graal) {
     opts[nOpts++] = (char*)"-Djava.graal=true";
@@ -313,6 +329,12 @@ int loadProperties() {
     else if (strncmp(ln1, "ARGS=", 5) == 0) {
       strcpy(cfgargs, ln1 + 5);
     }
+    else if (strncmp(ln1, "DEBUG=", 6) == 0) {
+      debug = true;
+    }
+    else if (strncmp(ln1, "DEBUG_PORT=", 11) == 0) {
+      debug_port = atoi(ln1 + 11);
+    }
     ln1 = ln2;
   }
   free(data);

native/windows/build.xml

@@ -22,9 +22,7 @@
     <!-- native cli loaders -->
     <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexecw.exe /link /subsystem:windows /entry:mainCRTStartup"/>
     <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexec.exe /link /subsystem:console"/>
-    <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI /D_JF_DEBUG loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexecwd.exe /link /subsystem:windows /entry:mainCRTStartup"/>
-    <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI /D_JF_DEBUG loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexecd.exe /link /subsystem:console"/>
-    <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI /D_JF_DEBUG /D_JF_CLI_SERVICE loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexecsd.exe /link /subsystem:console"/>
+    <exec command="cl /I '${java.home}/include' /I '${java.home}/include/win32' /I '../headers' /D_JF_CLI /D_JF_CLI_SERVICE loader.cpp native.lib ${winlibs} /Fe: ${user.home}/bin/jfexecs.exe /link /subsystem:console"/>
 
     <!-- native shared library -->
     <exec command="cl /LD /MT ${objs} ${winlibs} libcmt.lib /Fe: ${user.home}/bin/jfnative64.dll /link /MACHINE:X64"/>

native/windows/loader.cpp

@@ -65,6 +65,8 @@ JavaVM *g_jvm = NULL;
 JNIEnv *g_env = NULL;
 bool graal = false;
 bool debug = false;
+int debug_port = 9010;
+char debug_opt[64];
 char errmsg[1024];
 
 /* Prototypes */
@@ -254,22 +256,24 @@ JavaVMInitArgs *BuildArgs() {
   int idx;
   char *opts[64];
 
-#ifdef _JF_DEBUG
-  debug = true;
-#else
   char jf_debug[64];
   jf_debug[0] = 0;
   GetEnvironmentVariable("JF_DEBUG", jf_debug, 64);
   if (strcmp(jf_debug, "true") == 0) {
     debug = true;
   }
-#endif
+  jf_debug[0] = 0;
+  GetEnvironmentVariable("JF_DEBUG_PORT", jf_debug, 64);
+  if (jf_debug[0] != 0) {
+    debug_port = atoi(jf_debug);
+  }
 
   if (debug) {
 // Warning : this will cause the app not to load if MSVCRT is not installed at the system level - the one included in the MSI is not found by jmx
     opts[nOpts++] = "-Djava.debug=true";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote";
-    opts[nOpts++] = "-Dcom.sun.management.jmxremote.port=9010";
+    sprintf(debug_opt, "-Dcom.sun.management.jmxremote.port=%d", debug_port);
+    opts[nOpts++] = debug_opt;
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.local.only=false";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.authenticate=false";
     opts[nOpts++] = "-Dcom.sun.management.jmxremote.ssl=false";
@@ -494,6 +498,9 @@ bool loadProperties() {
     else if (strncmp(ln1, "DEBUG=", 6) == 0) {
       debug = true;
     }
+    else if (strncmp(ln1, "DEBUG_PORT=", 11) == 0) {
+      debug_port = atoi(ln1 + 11);
+    }
 #ifdef _JF_SERVICE
     else if (strncmp(ln1, "SERVICE=", 8) == 0) {
       strcpy(service, ln1 + 8);

readme.txt

@@ -85,13 +85,21 @@ deploy : build maven deployment artifacts (requires pom.xml) and publish to sona
   - must define 'maven' property which is groupId
   - auth token must be defined in ~/.m2/settings.xml
 executable : build native loader
- - a stub loader for the platform is copied into the project folder and configured to load classpath and start main method
- - a project property "apptype" can be defined as:
+ - creates executable for the app and configures it to load classpath and start main method
+ - project property "apptype" can be defined as:
      "window" for Window GUI apps (default)
      "console" for console apps (alias "c")
      "service" for service apps (alias "s")
      "server" for service config GUI apps (same as "window" type plus adds "-server" to executable and package names)
      "client" for client config GUI apps (same as "window" type plus adds "-client" to executable and package names)
+ - {app}.cfg file contains executable properties:
+   - CLASSPATH={list of jar files seperated by ;}  //CLASSPATH will be adjusted to OS requirements
+   - MAINCLASS={main class to find main()}         //startup class to find main() or serviceStart() if apptype=service
+   - DEBUG=true                                    //enable JMX debugging (see JMX Debugging)
+   - DEBUG_PORT={port}                             //JMX port binding (default = 9010)
+   - OPTION={options}                              //JVM options such as heap size, GC options, etc.
+   - JAVA_HOME={path}                              //alternative JVM home (default = search various locations which depends on OS)
+   - METHOD={start method}                         //alternative main method (default = main or serviceStart)
 ffmpeg : copy ffmpeg libraries to project folder (Windows only)
 installapp : install files before package creation (Linux only)
 deb : build Debian deb file (after installapp)
@@ -150,15 +158,13 @@ To build a project using Graal use the following Ant Tasks.
     - library name should be the full class name where main() is defined (ie: javaforce.utils.CopyPath.dll)
 GraalVM support for AWT is still a work in progress.
 
-Debugging
----------
-The CLI native loaders ~/bin/jfexec* enable JMX debugging support on port 9010.
-These loaders are used when you run an app with "ant run".
-From VisualVM you can connect to the JMX as localhost:9010
-You can also enable debug support by adding DEBUG=true to the project .cfg file to have it enabled in the generated executable.
-Debug support can also be enabled with environment variable JF_DEBUG=true
+JMX Debugging
+-------------
+JMX debugging support can be enabled with environment variable JF_DEBUG=true
+The JMX port by default is 9010 but can be overridden with environment variable JF_DEBUG_PORT
+You can enable debug support by adding DEBUG=true and DEBUG_PORT=9010 to the project .cfg file to have it enabled in the generated executable.
+From VisualVM you can connect to the JMX as localhost:9010 if it does not appear automatically.
 Also try adding -Xlog:gc*:gc.log to the OPTIONS= in the project .cfg file.  Then while the app is running use 'tail -f gc.log' from a terminal to watch memory usage.
-This should be removed for any public release.
 
 Requirements
 ------------

src/javaforce/utils/ExecProject.java

@@ -60,8 +60,6 @@ public void run(String buildfile) throws Exception {
       exec += "s";
     }
 
-    exec += "d";  //use debug version
-
     if (JF.isWindows()) {
       exec += ".exe";
     }