Skip to content

README.md

Latest commit

 

History

History
217 lines (162 loc) · 5.54 KB

README.md

File metadata and controls

217 lines (162 loc) · 5.54 KB

Java’s Project Panama for Newbies

One Day Workshop (Setting up Development Environment)

NOTE: Project Panama currently supports MacOS (Intel), Linux, Windows. Project Panama does not support the new Apple M1 chips (Arm64) at this time.

In the steps below you will be downloading the EA build of the OpenJDK containing the jextract tool. You will also, download additional tools for later lab examples.

To install required software do the following:

  1. Setup OpenJDK with Panama (jextract)
  2. Clone this workshop project from GitHub
  3. Install C compiler for your operating system
  4. Install 3rd party Libraries

1. Setup OpenJDK with Panama

Download the OpenJDK that will contain the jextract tool.

Step 1: Download OpenJDK from https://jdk.java.net/panama/ download: Build 19-panama+1-13 (2022/1/18)

Step 2: Untar or unzip into a directory

Linux

tar -xvf openjdk-19-panama+1-13_linux-x64_bin.tar.gz

MacOS

tar -xvf openjdk-19-panama+1-13_macos-x64_bin.tar.gz

Windows

unzip openjdk-19-panama+1-13_windows-x64_bin.zip

Step 3: Set JAVA_HOME and PATH environment variables

Linux

export JAVA_HOME=<untarred_dir>/jdk-19
export PATH=$JAVA_HOME/bin:$PATH

MacOS

export JAVA_HOME=<untarred_dir>/jdk-19.jdk/Contents/Home
export PATH=$JAVA_HOME/bin:$PATH

Windows

set JAVA_HOME=<untarred_dir>\jdk-19
set PATH=%JAVA_HOME%\bin;%PATH%

Note: To make environment variables permanent you can set these in your .bashrc, .bash_profile files on Linux or MacOS respectively.

Step 4: Verify OpenJDK is installed

Enter the following:

java -version

The output should display the version info shown below:

openjdk version "19-panama" 2022-09-20
OpenJDK Runtime Environment (build 19-panama+1-13)
OpenJDK 64-Bit Server VM (build 19-panama+1-13, mixed mode, sharing)

Step 5: Verify the jextract tool exists

Enter the following:

jextract -h

The output should display the help menu shown below:

Option                         Description                              
------                         -----------                              
-?, -h, --help                 print help                               
-C <String>                    pass through argument for clang          
-I <String>                    specify include files path               
-d <String>                    specify where to place generated files   
--dump-includes <String>       dump included symbols into specified file
--header-class-name <String>   name of the header class                 
--include-function <String>    name of function to include              
--include-macro <String>       name of constant macro to include        
--include-struct <String>      name of struct definition to include     
--include-typedef <String>     name of type definition to include       
--include-union <String>       name of union definition to include      
--include-var <String>         name of global variable to include       
-l <String>                    specify a library                        
--source                       generate java sources                    
-t, --target-package <String>  target package for specified header files

2. Clone workshop project from GitHub

Step 1: Fork and Clone project from the following: Java's Panama for Newbies Workshop

git clone git@github.com:<you_user_name>/java-panama-workshop.git

Or

git clone https://github.com/carldea/java-panama-workshop.git

Step 2: Optionally modify and source the setup.sh file (On Mac or Linux)

vim setup.sh
source setup.sh

3. Install C compiler for your operating system

Step 1: Install C compiler

MacOS Installing a C compiler:

xcode-select —install

Password:

Linux

sudo apt update
sudo apt install build-essential

Windows

Download Mingw at: https://sourceforge.net/projects/mingw-w64/

Step 2: To verify type the following:

gcc --version

4. Install 3rd party libraries

Step 1: Download SDL2 library

MacOS Installing Brew:

/bin/bash -c “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)”
brew install sdl2

Linux

sudo apt install freeglut3-dev libsdl2-dev

Windows

Download SDL2 from: https://www.libsdl.org/download-2.0.php After file is downloaded expand and move directory to your root C:\ directory.

Place in C:\ directory. It should look like C:\SDL2.

Step 2: Note the location of the include and lib directories for later use when specifying the java.library.path.

Linux

Include directories: C_INCLUDE_PATH and SDL2.

/usr/include
/usr/include/SDL2

The installed libraries should exist in the following directories:

/usr/lib
/usr/lib/x86_64-linux-gnu

MacOS Include directories: C_INCLUDE_PATH and SDL2.

/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include
/usr/local/include/SDL2

The actually libraries should exist in the following directory:

/usr/local/lib

Windows Please verify the following. Some locations are different depending on where things are installed. Any lab assignments with cmd shell scripts modification maybe needed.

Include directories: C_INCLUDE_PATH and SDL2.

C:\MinGW\include
C:\SDL2\include

The actually libraries should exist in the following directory:

C:\MinGW\lib
C:\SDL2\lib

Finished Setting up Dev Environment

You should be READY to go!