FPC JVM/Building: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | # Building the JVM compiler | |
| 2 | 2 | ||
| 3 | 3 | The instructions below are for Unix-like platforms, but by changing the forward slashes to backslashes (and adding *.exe* after the compiler binary name when copying it), most, if not all, commands will work on Windows, too. | |
| 4 | 4 | ||
| 5 | 5 | Every sequence of commands below starts from the assumption that you are in the top-level FPC source directory. | |
| 6 | 6 | ||
| 7 | 7 | ## Prerequisites | |
| 8 | 8 | ||
| 9 | 9 | A complete and working installation of FPC 2.6.0 or later (matching the version of the JVM compiler you want to build), the [FPC JVM utilities](ftp://ftp.freepascal.org/pub/fpc/contrib/jvm/fpcjvmutilities.zip), and an installation of the JDK 1.5 or later (with the binaries/jar files of all of them in the path). | |
| 10 | 10 | ||
| 11 | 11 | ## Obtaining the FPC sources | |
| 12 | 12 | ||
| 13 | 13 | The FPC JVM backend is now part of the main branch. | |
| 14 | 14 | ||
| 15 | 15 | ` `[`https://gitlab.com/freepascal.org/fpc/source/-/tree/main/compiler/jvm`](https://gitlab.com/freepascal.org/fpc/source/-/tree/main/compiler/jvm) | |
| 16 | 16 | ||
| 17 | 17 | To build the compiler, clone the repository to a local folder "fpc" from | |
| 18 | 18 | ||
| 19 | 19 | ` `[`https://gitlab.com/freepascal.org/fpc/source`](https://gitlab.com/freepascal.org/fpc/source) | |
| 20 | 20 | ||
| 21 | 21 | If the latest official release of FPC, installed on your system does not match the version in the main branch, don't use it to build the JVM. Instead, check out the relevant tagged release from the repository! | |
| 22 | 22 | ||
| 23 | 23 | ## Building the compiler and RTL | |
| 24 | 24 | ||
| 25 | 25 | **Note**: all of the commands below require that the latest native FPC release for your platform is in the PATH. | |
| 26 | 26 | ||
| 27 | 27 | Execute the following command in the top level directory of the checked out sources, i.e. in the *fpc* directory (replace *FullPathToInstallLocation* with the directory where to install the result): | |
| 28 | 28 | ||
| 29 | 29 | `make CROSSOPT="-O2 -g" CPU_TARGET=jvm OS_TARGET=java INSTALL_PREFIX=`*`FullPathToInstallLocation`*` all crossinstall` | |
| 30 | 30 | ||
| 31 | 31 | If you wish to also create a run time library that can be used for Android development, use the following command (replace *FullPathToInstallLocation* with the directory where to install the result): | |
| 32 | 32 | ||
| 33 | 33 | `make CROSSOPT="-O2 -g" CPU_TARGET=jvm OS_TARGET=android INSTALL_PREFIX=`*`FullPathToInstallLocation all crossinstall`* | |
| 34 | 34 | ||
| 35 | 35 | The generated compiler is called *ppcjvm*/*ppcjvm.exe*. | |
| 36 | 36 | ||
| 37 | 37 | In both cases, a *ppcjvm* (or *ppcjvm.exe*) binary will be created and installed. The compiler generated by both build processes is the same, so you only need one. When compiling programs using this compiler, specify the correct *-Fu* parameter to point to the Java/Android units. | |
| 38 | 38 | ||
| 39 | 39 | ## Building the fpcjres utility | |
| 40 | 40 | ||
| 41 | 41 | This step is optional and is only required for the raw *{\$r xxx}* support. Run the following command in the top-level directory of the checked-out sources: | |
| 42 | 42 | ||
| 43 | 43 | `make all` | |
| 44 | 44 | ||
| 45 | 45 | The compiled *fpcjres* utility will be in *utils/fpcres*. | |
| 46 | 46 | ||
| 47 | 47 | # Additional tools | |
| 48 | 48 | ||
| 49 | 49 | ## Building javapp | |
| 50 | 50 | ||
| 51 | 51 | The tool used to generate Pascal import headers from Java classes is called *javapp*. It is written in Java because it is based on the *javap* utility from the JDK (version 6). | |
| 52 | 52 | ||
| 53 | 53 | The source code for javapp can be found under *utils/javapp* in the FPC source tree. To build it, create a new Eclipse project and import the sources. Then, add *jgrapht.jar* from <http://www.cs.sunysb.edu/~algorith/implement/jgrapht/distrib/> to the project (used for topological sorting to determine the dependencies between the classes). The main class file is *Main.java*. | |
| 54 | 54 | ||
| 55 | 55 | ### Creating the Java RTL headers | |
| 56 | 56 | ||
| 57 | 57 | To create the *rtl/java/java_sysh.inc* and *rtl/java/java_sys.inc* files, run *javapp* as follows: | |
| 58 | 58 | ||
| 59 | 59 | ` java -jar javapp.jar -protected java.lang.System java.lang.Object java.io.Serializable java.io.IOException java.io.IIOException java.lang.Readable java.lang.Float java.lang.Double java.lang.Byte java.lang.Short java.lang.Integer java.lang.Long java.lang.Boolean java.lang.String java.lang.StringBuilder java.lang.StringBuffer java.lang.CharSequence java.lang.AbstractStringBuilder java.lang.Appendable java.lang.Number java.lang.IndexOutOfBoundsException java.lang.RuntimeException java.lang.IllegalArgumentException java.lang.IllegalStateException java.lang.UnsupportedOperationException java.lang.Exception java.lang.Throwable java.lang.NoSuchMethodException java.lang.LinkageError java.lang.Error java.lang.Comparable java.lang.Character java.text.Collator java.lang.Cloneable java.lang.Runtime java.lang.ThreadLocal java.math.BigInteger java.util.Comparator java.lang.reflect.Array java.lang.Class java.lang.reflect.GenericDeclaration java.lang.reflect.Type java.lang.reflect.Method java.lang.reflect.AccessibleObject java.lang.reflect.Member java.lang.reflect.AnnotatedElement java.lang.reflect.InvocationTargetException java.lang.reflect.Field java.util.Arrays java.util.Map java.util.HashMap java.util.Set java.util.Collection java.util.AbstractMap java.util.Calendar java.lang.Iterable java.lang.Enum java.lang.Math java.util.AbstractCollection java.util.AbstractSet java.util.EnumSet java.util.BitSet java.util.Iterator java.nio.Buffer java.nio.ByteBuffer java.nio.CharBuffer java.nio.charset. -i -o java_sys` | |
| 60 | 60 | ||
| 61 | 61 | To create the *rtl/java/jdk15.pas* and *rtl/java/jdk15.inc* files, use | |
| 62 | 62 | ||
| 63 | 63 | ` java -jar javapp.jar -x java.lang.System -x java.lang.Object -x java.io.Serializable -x java.io.IOException -x java.io.IIOException -x java.lang.Readable -x java.lang.Float -x java.lang.Double -x java.lang.Float -x java.lang.Double -x java.lang.Byte -x java.lang.Short -x java.lang.Integer -x java.lang.Long -x java.lang.Boolean -x java.lang.String -x java.lang.StringBuilder -x java.lang.StringBuffer -x java.lang.CharSequence -x java.lang.AbstractStringBuilder -x java.lang.Appendable -x java.lang.Number -x java.lang.IndexOutOfBoundsException -x java.lang.RuntimeException -x java.lang.IllegalArgumentException -x java.lang.IllegalStateException -x java.lang.UnsupportedOperationException -x java.lang.Exception -x java.lang.Throwable -x java.lang.LinkageError -x java.lang.Error -x java.lang.Comparable -x java.lang.Character -x java.text.Collator -x java.lang.Cloneable -x java.lang.Runtime -x java.lang.ThreadLocal -x java.math.BigInteger -x java.util.Comparator -x java.lang.reflect.Array -x java.lang.Class -x java.lang.reflect.GenericDeclaration -x java.lang.reflect.Type -x java.lang.reflect.Method -x java.lang.reflect.AccessibleObject -x java.lang.reflect.Member -x java.lang.reflect.AnnotatedElement -x java.lang.reflect.Field -x java.lang.reflect.InvocationTargetException -x java.util.Arrays -x java.util.Map -x java.util.HashMap -x java.util.Set -x java.util.Collection -x java.util.AbstractMap -x java.util.Calendar -x java.lang.Iterable -x java.lang.Enum -x java.lang.Math -x java.util.AbstractCollection -x java.util.AbstractSet -x java.util.EnumSet -x java.util.BitSet -x java.util.Iterator -x java.nio.Buffer -x java.nio.ByteBuffer -x java.nio.CharBuffer -x java.nio.charset. -a sun. -a com.sun. -a apple. -a java.awt.Dialog -protected java. javax. org. -o jdk15` | |
| 64 | 64 | ||
| 65 | 65 | ### Creating the Android RTL headers | |
| 66 | 66 | ||
| 67 | 67 | To create the *rtl/android/jvm/java_sysh_android.inc* and *rtl/android/jvm/java_sys_android.inc* files, use (same command line as for creating the equivalent Java RTL includes, except for the additional *bootclasspath* and *extdirs* parameters) | |
| 68 | 68 | ||
| 69 | 69 | ` java -jar javapp.jar -bootclasspath /full/path/to/android-sdk/platforms/android-14/android.jar -extdirs . -protected java.lang.System java.lang.Object java.io.Serializable java.io.IOException java.io.IIOException java.lang.Readable java.lang.Float java.lang.Double java.lang.Byte java.lang.Short java.lang.Integer java.lang.Long java.lang.Boolean java.lang.String java.lang.StringBuilder java.lang.StringBuffer java.lang.CharSequence java.lang.AbstractStringBuilder java.lang.Appendable java.lang.Number java.lang.IndexOutOfBoundsException java.lang.RuntimeException java.lang.IllegalArgumentException java.lang.IllegalStateException java.lang.UnsupportedOperationException java.lang.Exception java.lang.Throwable java.lang.NoSuchMethodException java.lang.LinkageError java.lang.Error java.lang.Comparable java.lang.Character java.text.Collator java.lang.Cloneable java.lang.Runtime java.lang.ThreadLocal java.math.BigInteger java.util.Comparator java.lang.reflect.Array java.lang.Class java.lang.reflect.GenericDeclaration java.lang.reflect.Type java.lang.reflect.Method java.lang.reflect.AccessibleObject java.lang.reflect.Member java.lang.reflect.AnnotatedElement java.lang.reflect.InvocationTargetException java.lang.reflect.Field java.util.Arrays java.util.Map java.util.HashMap java.util.Set java.util.Collection java.util.AbstractMap java.util.Calendar java.lang.Iterable java.lang.Enum java.lang.Math java.util.AbstractCollection java.util.AbstractSet java.util.EnumSet java.util.BitSet java.util.Iterator java.nio.Buffer java.nio.ByteBuffer java.nio.CharBuffer java.nio.charset. -i -o java_sys` | |
| 70 | 70 | ||
| 71 | 71 | To create the *rtl/android/jvm/androidr14.pas* and *rtl/android/jvm/androidr14.inc* files, use | |
| 72 | 72 | ||
| 73 | 73 | ` java -jar javapp.jar -bootclasspath /full/path/to/android-sdk/platforms/android-14/android.jar -extdirs . -protected -x java.lang.System -x java.lang.Object -x java.io.Serializable -x java.io.IOException -x java.io.IIOException -x java.lang.Readable -x java.lang.Float -x java.lang.Double -x java.lang.Float -x java.lang.Double -x java.lang.Byte -x java.lang.Short -x java.lang.Integer -x java.lang.Long -x java.lang.Boolean -x java.lang.String -x java.lang.StringBuilder -x java.lang.StringBuffer -x java.lang.CharSequence -x java.lang.AbstractStringBuilder -x java.lang.Appendable -x java.lang.Number -x java.lang.IndexOutOfBoundsException -x java.lang.RuntimeException -x java.lang.IllegalArgumentException -x java.lang.IllegalStateException -x java.lang.UnsupportedOperationException -x java.lang.Exception -x java.lang.Throwable -x java.lang.LinkageError -x java.lang.Error -x java.lang.Comparable -x java.lang.Character -x java.text.Collator -x java.lang.Cloneable -x java.lang.Runtime -x java.lang.ThreadLocal -x java.math.BigInteger -x java.util.Comparator -x java.lang.reflect.Array -x java.lang.Class -x java.lang.reflect.GenericDeclaration -x java.lang.reflect.Type -x java.lang.reflect.Method -x java.lang.reflect.AccessibleObject -x java.lang.reflect.Member -x java.lang.reflect.AnnotatedElement -x java.lang.reflect.Field -x java.lang.reflect.InvocationTargetException -x java.util.Arrays -x java.util.Map -x java.util.HashMap -x java.util.Set -x java.util.Collection -x java.util.AbstractMap -x java.util.Calendar -x java.lang.Iterable -x java.lang.Enum -x java.lang.Math -x java.util.AbstractCollection -x java.util.AbstractSet -x java.util.EnumSet -x java.util.BitSet -x java.util.Iterator -x java.nio.Buffer -x java.nio.ByteBuffer -x java.nio.CharBuffer -x java.nio.charset. -a sun. -a com.sun. -a apple. -a java.awt. java. javax. org. android. junit. -o androidr14` | |
| 74 | 74 | ||
| 75 | 75 | You will have to make several manual changes to the result before it compiles, though: | |
| 76 | 76 | ||
| 77 | 77 | - There is a circular dependency involving the *AVViewGroup.LayoutParams* nested class, which results in javapp being unable to order all classes. You will have to manually extract that class and redeclare it as *AVViewGroup_LayoutParams = class external 'android.view' name 'ViewGroup\$LayoutParams' (JLObject)*, and then replace all references to the original class to this new class | |
| 78 | 78 | - There is a class with a constant field called *CREATE*, which results in javapp generating wrong names for its constructors (*\<init\>_*). Rename the constant to *CREATE_* and the constructors to *Create* | |
| 79 | 79 | - The declaration for *AAActionBar.InnerTab* is missing. Add it as *InnerTab = class abstract external 'android.app' name 'Tab' end;* inside *AAActionBar* | |
| 80 | 80 | ||
| 81 | 81 | ### Creating interfaces for other Java classes | |
| 82 | 82 | ||
| 83 | 83 | Example of creating a unit called *bcel* containing all classes under *org.apache.bcel* that can be found in bcel-6.0-SNAPSHOT.jar: | |
| 84 | 84 | ||
| 85 | 85 | ` java -jar full/path/to/javapp.jar -classpath full/path/to/bcel-6.0-SNAPSHOT.jar -protected -o bcel org.apache.bcel.` | |
| 86 | 86 | ||
| 87 | 87 | The long parameter lists above are due to the split of the classes between the system unit and the jdk15 unit. The extra *-classpath* parameter is required when dumping classes that are not part of the standard JDK and has to point to the jar file(s) and/or directory/ies containing the class hierarchy you want to dump. If they are in the current directory, do not forget to pass explicitly"*-classpath .*" | |
| 88 | 88 | ||
| 89 | 89 | Important: | |
| 90 | 90 | ||
| 91 | 91 | - If an identifier argument to javapp ends in a ".", it is interpreted as a package name, otherwise as a class name (not the '.' at the end of *org.apache.bcel.* in the example above). | |
| 92 | 92 | - In case circular dependencies of inner classes are involved, you must sacrifice one of the classes involved in the cycle by passing it using the *-a* option (anonymous). In that case, this class will be translated as a [[FPC JVM/Language|formal class]] (like *java.awt.Dialog* above, which is involved in a circular dependency with an inner class of *java.awt.Window*). | |
| 93 | 93 | - The *-i* option causes javapp to generate include files. Otherwise, it generates a standalone unit. | |
| 94 | 94 | - Pascal does not support the concept of Java-style *[inner classes](http://download.oracle.com/javase/tutorial/java/javaOO/nested.html)*, but only that of static nested classes. As a result, Java inner classes are not added to the translated headers. | |
| 95 | 95 | ||
| 96 | 96 | The javapp source code is, unfortunately not very clean. The fact that the javap source code could have been cleaner did not help, but the situation has not exactly improved... | |
| 97 | 97 | ||
| 98 | 98 | ### Building javapp from command-line | |
| 99 | 99 | ||
| 100 | 100 | The installation and usage of Eclipse might not be desirable. You can compile javapp using JDK tools only. JDK is a prerequisite. Thus, you should have it installed anyway. | |
| 101 | 101 | ||
| 102 | 102 | To compile, you must call **javac** and compile all .java files in "fpc\utils\javapp\src\fpc\tools\javapp" directory. As mentioned earlier, sources depend on jgrapht-jdk1.5.jar. Thus, the class path must be specified during compilation. | |
| 103 | 103 | ||
| 104 | 104 | Once sources are compiled, all .class files must be gathered into a .jar file. The manifest file must declare the entry point class and the dependency on jgrapht. | |
| 105 | 105 | ||
| 106 | 106 | Below is the Windows batch (.bat) script file that performs the compilation. The script is intended to be run from fpc\utils\javapp folder. Directory referencing JDK and jgrapht location should be adjusted according to your end system configuration. | |
| 107 | 107 | ||
| 108 | 108 | `:: Set environmental variables.`\ | |
| 109 | 109 | `:: If you have the JDK bin folder in your "PATH" environmental variables`\ | |
| 110 | 110 | `:: you can remove the reference to jdkbindir at all`\ | |
| 111 | 111 | `:: but make sure that all slash-separators are also removed`\ | |
| 112 | 112 | `set jdkbindir=C:\Program Files\Java\jdk1.8.0_91\bin`\ | |
| 113 | - | ||
| 113 | + | ||
| 114 | 114 | `:: This is the directory where jgrapht .jar file is located`\ | |
| 115 | 115 | `:: make sure you remove the slash at the end `\ | |
| 116 | 116 | `set jgraphtdir=C:\jgrapht-0.7.2`\ | |
| 117 | - | ||
| 117 | + | ||
| 118 | 118 | `:: This generates a small manifest file template`\ | |
| 119 | 119 | `:: It's needed so, "jar" utility will create a dependency for jgrapht-jdk1.5 library`\ | |
| 120 | 120 | `@echo Class-Path: jgrapht-jdk1.5.jar > manifest.txt`\ | |
| 121 | - | ||
| 121 | + | ||
| 122 | 122 | `::: Compiling sources using Javac`\ | |
| 123 | 123 | `:: -d .\ forces "javac" to put all the class files hierarchy into the current directory`\ | |
| 124 | 124 | `:: once "javac" finished you should have the following file structure created "./fpc/tools/javapp/"`\ | |
| 125 | 125 | `:: The structure is important for .jar file`\ | |
| 126 | 126 | `"%jdkbindir%\javac.exe" ^`\ | |
| 127 | 127 | ` .\src\fpc\tools\javapp*.java ^`\ | |
| 128 | 128 | ` -d .\ ^`\ | |
| 129 | 129 | ` -cp %jgraphtdir%\jgrapht-jdk1.5.jar`\ | |
| 130 | - | ||
| 130 | + | ||
| 131 | 131 | `:: Creating a .jar file for the application`\ | |
| 132 | 132 | `:: Including manifest file (manifest.txt)`\ | |
| 133 | 133 | `:: Specifying entry point (fpc.tools.javapp.Main)`\ | |
| 134 | 134 | `:: "fpc" is the folder where .class files are located`\ | |
| 135 | 135 | `"%jdkbindir%\jar" cfme javapp.jar manifest.txt fpc.tools.javapp.Main fpc`\ | |
| 136 | - | ||
| 136 | + | ||
| 137 | 137 | `copy /Y "%jgraphtdir%\jgrapht-jdk1.5.jar" jgrapht-jdk1.5.jar`\ | |
| 138 | - | ||
| 138 | + | ||
| 139 | 139 | `:: Clean up time!`\ | |
| 140 | 140 | `:: We don't need this file anymore`\ | |
| 141 | 141 | `:: /Q is quite mode`\ | |
| 142 | 142 | `@del /Q manifest.txt`\ | |
| 143 | 143 | `:: Remove the directory structure containing .classes. We don't need them since they should now be part`\ | |
| 144 | 144 | `:: of the .jar file. Removing it, quietly `\ | |
| 145 | 145 | `@rmdir /S /Q fpc` | |
| 146 | 146 | ||
| 147 | 147 | As the result, you'll have two files javapp.jar and jgrapht-jdk1.5.jar. If you need to move javapp.jar to another directory, copy jgrapht-jdk1.5.jar as well. | |
| 148 | 148 | ||
| 149 | 149 | # External tools | |
| 150 | 150 | ||
| 151 | 151 | ## Building Jasmin | |
| 152 | 152 | ||
| 153 | 153 | Jasmin is the compiler's Java byte code assembler to translate the generated assembler files (*.j) into Java class files (*.class). | |
| 154 | 154 | ||
| 155 | 155 | - Download the Jasmin 2.4 source code from <https://sourceforge.net/projects/jasmin/files/> and unzip it | |
| 156 | 156 | - Download the patch from <ftp://ftp.freepascal.org/pub/fpc/contrib/jvm/jasmin24b.patch> and apply it to the Jasmin 2.4 source. That patch does the following things: | |
| 157 | 157 | - Change the Windows-style newlines of the *build.sh* script into Unix-style newlines | |
| 158 | 158 | - Apply a fix for <https://sourceforge.net/p/jasmin/bugs/3/> | |
| 159 | 159 | - Apply a fix for <https://sourceforge.net/p/jasmin/bugs/5/> | |
| 160 | 160 | - Apply a fix for <https://gitlab.com/freepascal.org/fpc/source/-/issues/22807> | |
| 161 | 161 | - Add support for floating point constants encoded in hexadecimal format | |
| 162 | 162 | - Fix the type encoding of 64-bit constants declared with an initialization value that fits in 32-bit | |
| 163 | 163 | - For Unix platforms: build Jasmin by making the *build.sh* script executable (*chmod +x build.sh*) and executing *./build.sh all*. This will generate a new *jasmin.jar* in the current directory. There's also a *build.bat* file that will presumably do the same on Windows. | |
| 164 | 164 | ||
| 165 | 165 | ## Building BCEL | |
| 166 | 166 | ||
| 167 | 167 | BCEL is a Java byte code verification framework that can be used to look for errors in Java class files. See [[FPC JVM/Debugging]] for usage information. | |
| 168 | 168 | ||
| 169 | 169 | - Check out the svn sources using the following command | |
| 170 | 170 | ||
| 171 | 171 | ` svn checkout `[`http://svn.apache.org/repos/asf/commons/sandbox/classscan/trunk/bcel`](http://svn.apache.org/repos/asf/commons/sandbox/classscan/trunk/bcel)` bcel` | |
| 172 | 172 | ||
| 173 | 173 | - Before building, apply the patch at <ftp://ftp.freepascal.org/pub/fpc/contrib/jvm/bcel-r1157681-returntype.patch> to prevent incorrect verification errors about return type mismatches. | |
| 174 | 174 | - To build BCEL, you first have to install [Apache Maven](http://maven.apache.org/) | |
| 175 | 175 | - Once Maven is installed and its *mvn* binary is in your PATH, run *mvn package* in the bcel source directory. The first time you do so, Maven will download and configure many plugins, which takes quite some time. After building, the new version of BCEL will be available as *target/bcel-6.0-SNAPSHOT.jar* | |
| 176 | 176 | ||
| 177 | 177 | --- | |
| 178 | 178 | *From the Free Pascal wiki, page "FPC JVM/Building", as it stood on 2023-08-31 after a change by Peter.Dell, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 179 | 179 | Category: JVM |