Click here to close now.

Welcome!

Java IoT Authors: Carmen Gonzalez, Plutora Blog, Liz McMillan, Dana Gardner, Pat Romanski

Related Topics: Java IoT

Java IoT: Article

Calling Java From C

A framework for easier JNI

Though most Java developers think of the Java Native Interface (JNI) as a framework for developing native libraries that can be called from Java, relatively few know that JNI also supports communication in the reverse direction: it provides native programs written in C with the ability to call Java objects. However, the coding is thorny; logic that can be coded readily in a few lines of Java requires several times more lines of C, thanks to JNI's granular programming model and peculiar approaches to exception handling and garbage collection. This article explores the nature and typical use of the C-to-Java JNI interface and presents the design of a framework that eases the programming effort.

The JNI Architecture
As Figure 1 illustrates, JNI is actually a pair of APIs:

  • "JNI Proper" supports the manipulation of Java objects and classes, such as the ability to call object methods.
  • The Invocation API is a smaller C library that enables C programs to create and destroy a Java Virtual Machine (JVM).
A C-to-Java program (that is, a C program that uses Java) calls the Invocation API to create a JVM, and calls JNI Proper to use Java objects. As for the Java-to-C direction (not discussed in this article), Java code calls a native method, which is implemented as a C native library function; the C code uses JNI to interpret its Java input types and build its Java output types.

The JVM is packaged as a shared library ("jvm.dll" in the Sun SDK on Windows platforms and "libjvm.so" on Solaris) and exposes JNI Proper and the Invocation API as public exports. As a runtime entity, a JVM is really just the JVM library linked to an executable C program. Any Java developer can code such a program, e.g., "myCtoJProgram.exe", shown in Figure 2. Interestingly, the famed SDK C program known as the "launcher" (java.exe on Windows, Java on Solaris) is written in just the same way (for more, see sidebar JNI Case Study: Java Launcher). Completing the picture are native libraries, such as "myNative.dll", whose functions can be called from Java; these libraries are linked to the runtime process alongside the JVM.

A C-to-Java JNI Design: The Zip Example
The launcher is the best-known example of a C program that uses the JNI's C-to-Java interface; its purpose is to house a JVM and bootstrap a Java application on the JVM by calling the application's main method. Other, less obvious examples are C programs that require functionality whose best or only implementation is Java objects that must be called "in process." Examples include programs that:

  • Create, extract, or list the contents of zip files. The Java SDK java.util.zip package is the most suitable API available.
  • Transform XML to XML, HTML, or PDF. Though C XML APIs exist, Java's support for XML is vastly superior. Launching a JVM to do XML with Java is a plausible strategy for a C program.
  • Call an Enterprise JavaBean (EJB). The C program uses JNI to execute standard EJB client-side logic.
The example of listing the contents of a zip file highlights the coding challenge of C-to-Java JNI. (Source code for this article can be downloaded from www.sys-con.com/java/sourcec.cfm.) The Java code to perform this logic, shown in Listing 1, is trivial: line 4 instantiates the class ZipFile in java.util.zip, passing the zip file name to the constructor; lines 5-9 loop over a java.util.Enumeration of java.util.zip.ZipEntry objects getting, in line 8, the name of each entry in the zip file.

Developing the equivalent logic in C requires hundreds of lines of code. The main steps are summarized in Table 1. Listing 2 shows the code for steps 7 and 8; the JNI calls in lines 5, 10, 15, and 21 are followed by calls in lines 7, 11, 16, and 22 to the checkException() function (implementation not shown), which in turn calls the JNI exception handling functions ExceptionCheck(), ExceptionDescribe(), and ExceptionClear() to swallow and report Java exceptions triggered by the JNI calls.

The C code in the zip example can be made easier and less cumbersome by using two design patterns:

  1. Java Proxy: Put the hard code where it belongs, on the Java side. Develop a Java object, called a proxy, that performs complex logic on behalf of the C code. The C code need only call the proxy.
  2. C Façade: Hide JNI's peculiar programming model in a C façade library. Have the C program call the façade rather than JNI directly. In addition, build proxy support into the façade; expose façade functions to call the proxy.
The proxy and façade constitute an abstract framework for use in any program resembling the zip program. Java proxies implement the interface shown in Listing 3; the execute() method is defined generically as accepting an input, performing some action or set of actions, and returning an output. Listing 4 shows the proxy implementation for the zip example. The execute() method expects as input a string specifying the name of the zip file (line 26); it implements logic similar to that in Listing 1 to enumerate the entries in the zip file (lines 26-33) and returns a string containing the name of the entries in a pipe-delimited list (see lines 30-32 and 35). The method could also have returned an array or Java collection type, but the calling C program is likely happier parsing a string than contending with JNI array or collection class iteration logic.

If the C zip program were to call the proxy using JNI directly, its length would be shorter but the complexity of JNI would remain. Using the façade reduces the length even further and shields the code from JNI oddities. A design for the façade is depicted in Figure 3. The façade consists of a set of data types, modeled as C structures, and a set of functions. The data types represent entities such as JVM (cjJVM_t), class (cjClass_t), method (cjMethod_t), and object (cjObject_t). The functions are operations performed on the entities (e.g., cjJVMConnect() and cjJVMDisconnect() performed on the JVM), and a special set of proxy operations. Table 2 describes and lists the JNI usage of each of the C functions.

Listing 5 is the complete source code of the C zip program that uses the proxy and façade. (Listing 5 can be downloaded from www.sys-con.com/java/sourcec.cfm.) The program launches a JVM (line 26), gets a reference to the proxy class (line 29), instantiates it (line 33), and calls the execute() method (line 36). The remaining code (lines 40-50) cleans up the proxy object and class and destroys the JVM.

Conclusion
Hosting the hard logic in a Java proxy and wrapping JNI calls to the proxy in a C façade reduces the complexity of C-to-Java programming with JNI.

References

  • "Java Native Interface Specification," Sun Microsystems: java.sun.com/j2se/1.5.0/guide/jni/spec/jniTOC.html
  • "Tutorial on JNI," Sun Microsystems: java.sun.com/docs/books/tutorial/native1.1/concepts/index.html

    SIDEBAR

    JNI Case Study: Java Launcher
    Every Java developer who uses the Sun SDK is grateful for the C program known as the launcher (its executable name is "java"), which uses the JNI Invocation API to create a JVM, load a Java class into the JVM, and call its main() method, thereby launching a Java application on behalf of the caller. If the launcher did not exist, a good C developer with JNI knowledge could write an equivalent program in less than a week.

    The launcher's source code is available from Sun and is packaged with the SDK (version 1.4.2_04, which can be downloaded from java.sun.com/j2se/1.4.2/download.html). In the base directory of the installed SDK is a file called src.zip. If you extract that file, the exploded "launcher" directory contains the four source files that constitute the launcher program: java.h, java.c, java_md.h, and java_md.c. The launcher's source code is unmistakably C: murky, idiomatic, and circuitous. On the other hand, the end result is a functional program that has been run successfully innumerable times by innumerable users. Understanding how it works is a case study in the use of JNI.

    Suppose there is a class called Hi in the package com.mike that has a public main() method and thus can be started as a Java application through the launcher. The following is the source code:

    
    1	package com.mike;
    2	
    3	Public class Hi
    4	{
    5	   public static void main(String args[])
    6	   {
    7	      ...
    8	   }
    9	}
    

    The Hi application is started under SDK 1.4.2_04 on Windows 2000 with the following commands:

    1 set JAVA_HOME=c:\j2sdk1.4.2_04
    2 set _JAVA_LAUNCHER_DEBUG=true
    3 %JAVA_HOME%\bin\java -classpath src -Xms32m -Xmx64m -Dmy.property=1 com.mike.Hi arg1 arg2

    Line 3 calls the launcher executable Java in the bin directory of my SDK (which, as line 1 indicates, is c:\j2sdk1.4.2_04). The arguments passed to the launcher are:

    • -classpath src: Look for my "Hi" class in the directory src.
    • -Xms32m: Set its minimum heap size to 32MB.
    • -Xmx64m: Set the maximum heap size to 64MB.
    • -Dmy.property=1: Make a property available to the application with the key my.property and value 1.
    • com.mike.Hi: Run the application in this class.
    • arg1 arg2: Pass arguments "arg1" and "arg2" to the application's main method.
    Line 2 sets an environment variable called _JAVA_LAUNCHER_DEBUG, which causes the launcher to generate debugging output to the console at runtime:

    
    1	----_JAVA_LAUNCHER_DEBUG----
    2	JRE path is c:\j2sdk1.4.2_04\jre
    3	jvm.cfg[0] = ->-client<-
    4	jvm.cfg[1] = ->-server<-
    5	jvm.cfg[2] = ->-hotspot<-
    6	jvm.cfg[3] = ->-classic<-
    7	jvm.cfg[4] = ->-native<-
    8	jvm.cfg[5] = ->-green<-
    9	1306 micro seconds to parse jvm.cfg
    10	JVM path is c:\j2sdk1.4.2_04\jre\bin\client\jvm.dll
    11	5571 micro seconds to LoadJavaVM
    12	JavaVM args:
    13	    version 0x00010002, ignoreUnrecognized is JNI_FALSE, nOptions is 6
    14	    option[ 0] = '-Djava.class.path=.'
    15	    option[ 1] = '-Djava.class.path=src'
    16	    option[ 2] = '-Xms32m'
    17	    option[ 3] = '-Xmx64m'
    18	    option[ 4] = '-Dmy.property=1'
    19	    option[ 5] = '-Dsun.java.command=com.mike.Hi arg1 arg2'
    20	125113 micro seconds to InitializeJVM
    21	Main-Class is 'com.mike.Hi'
    22	Apps' argc is 2
    23	    argv[ 0] = 'arg1'
    24	    argv[ 1] = 'arg2'
    25	32937 micro seconds to load main class
    26	----_JAVA_LAUNCHER_DEBUG----
    

    The launcher begins by finding the JRE (line 2) and the right JVM (lines 3-10), and then loads the JVM dynamically (line 11); as we'll see, this logic is platform dependent. In this case, because we didn't name a specific JVM when calling the launcher, the launcher defaults to "client" (more on this below). Lines 12-19 show the arguments that the launcher will pass to the JVM; these correspond to the arguments passed to the launcher. In line 20, the launcher starts the JVM. The class whose main method that launcher will call is given on line 21; the arguments passed to it are shown in lines 22-24.

    The launcher's logical design (as of version 1.4.2_04) is depicted in Figure 4.

    The launcher consists of two modules: java.c, which contains the main function of the launcher program as well as platform-independent helper functions, and java_md.c, which houses platform-specific functions. The modules share a bidirectional dependency: func-tions in java.c call java_md.c and vice versa; for example, main() in java.c calls CreateExecutionEnvironment() in java_md.c, which in turn calls ReadKnownVMs() in java.c.

    The source code in java_md.c is different for each SDK platform release. For example, the Windows SDK has the Windows version of java_md.c but does not have the Solaris version. If you want to see both (as I did as I was writing this article), you must download both releases.

    The main steps in the launcher's processing are the following:

    1.  Create the execution environment: The CreateExecutionEnvironment() function, implemented in java_md.c, is a platform-specific search for the JRE path, JVM path, and JVM type for use by the launcher. The Windows version looks up the JRE path in the registry (on my machine, the registry key HKEY_LOCAL_MACHINE\Software\JavaSoft\Java Runtime Edition\1.4\JavaHome is C:\Program Files\Java\j2re1.4.2_04), and then checks whether the JVM type selected by the caller (corresponding to "-client" or "-server" launcher command-line options) is one of the allowable types listed in the file JREPath\lib\Arch\jvm.cfg (on my machine "Arch" is "i386"). If the caller did not specify a JVM type, the launcher defaults to the first type listed in jvm.cfg (on my machine it's "client"). The JVM path on Windows is JREPath\bin\JVMType\jvm.dll (e.g., JREPath\bin\client\jvm.dll for the client JVM).

    2.  Load the JVM dynamically: Whereas most programs let the operating system implicitly link shared libraries to their processes, the launcher, which allows the user to specify at runtime which version of the JVM library to use (the "-client" or "-server" command-line arguments to the launcher), explicitly loads the JVM library using a platform-specific interface. The logic resides in java_md.c's LoadJavaVM() function. On Windows, this function calls the Win32 LoadLibrary() to load the JVM DLL and link it to the launcher process, and then calls the Win32 GetProcAddress() function to get a pointer to the invocation API function JNI_CreateJavaVM() used in step 4.

    3.  Prepare JVM runtime options based on command-line options passed to the launcher: Command-line options such as -D, -X, and -classpath are assembled into an array to be passed to the JVM. The launcher adds an additional property for use by the JVM of the form -Djava.sun.command=class arg1 arg2 ..., where class is the fully qualified name of the target class and "arg1 arg2 ..." is the list of command-line arguments to be passed to its main method.

    4.  Create the JVM: The launcher calls the JVM's JNI_Create-JavaVM() function, passing the options prepared above.

    5.  Load the target class into the JVM by calling the JNI FindClass() method: The launcher first replaces dots with slashes in the class name (e.g., it converts com.mike.Hi to com/mike/Hi) because the JVM expects slashes instead of dots.

    6.  Call the main method of the target class: First, the launcher gets a reference to the main() method by calling the JNI GetStaticMethodID() function, passing the class reference acquired in step 5, the method name ("main"), and the signature ("([Ljava/lang/String;)V", the JVM's peculiar representation of a void method that accepts an array of java.lang.String objects). Second, the launcher calls the method via CallStaticVoidMethod(). The launcher prepares the string array method input using some of the JNI's array functions (NewObjectArray(), SetObjectArrayElement()), and handles exceptions in the main method using JNI's ExceptionOccurred(), ExceptionDescribe(), and ExceptionClear().

    7.  Shutdown the JVM: This is done by calling the JNI DetachCurrent-Thread() and DestroyJavaVM() functions.

    A mystery to many Java developers, the launcher is nothing more than a little C program that uses the JNI to initiate a Java application.

  • More Stories By Michael Havey

    Michael Havey is a Chordiant consultant with 10 years of industry experience, mostly with application integration. Michael's book Essential Business Process Modeling was published by O'Reilly in August 2005.

    Comments (5) View Comments

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


    Most Recent Comments
    Bubb 07/26/07 08:47:36 PM EDT

    I got file not found when I accessed
    www.sys-con.com/java/sourcec.cfm

    DHAYANITHI R 03/23/05 03:01:47 AM EST

    Hi,
    Your matirial is good, But still now I can't understand how i call java function from C. Can u give some model source code, it is very usefull for me

    Michael 10/13/04 09:30:30 AM EDT

    It is really great article!!
    Is it possible to run on the Unix?

    Thanks,
    Michael

    pete 09/22/04 04:02:15 AM EDT

    it indeed is a very nice article.it helped me a lot for my assignment

    Jesse Barnum 08/21/04 10:45:44 PM EDT

    Thanks for this tutorial - it's exactly what I've been looking for. Everything that I see on JNI is for calling C from Java - this article is the other way around, which is just what I need to do.

    @ThingsExpo Stories
    17th Cloud Expo, taking place Nov 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterprises are using some form of XaaS – software, platform, and infrastructure as a service.
    The 4th International Internet of @ThingsExpo, co-located with the 17th International Cloud Expo - to be held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA - announces that its Call for Papers is open. The Internet of Things (IoT) is the biggest idea since the creation of the Worldwide Web more than
    The 17th International Cloud Expo has announced that its Call for Papers is open. 17th International Cloud Expo, to be held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, brings together Cloud Computing, APM, APIs, Microservices, Security, Big Data, Internet of Things, DevOps and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportunity. Submit your speaking proposal today!
    Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Architect for the Internet of Things and Intelligent Systems, described how to revolutionize your archit...
    The 5th International DevOps Summit, co-located with 17th International Cloud Expo – being held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits, DevOps is corr...
    SYS-CON Events announced today that Secure Infrastructure & Services will exhibit at SYS-CON's 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Secure Infrastructure & Services (SIAS) is a managed services provider of cloud computing solutions for the IBM Power Systems market. The company helps mid-market firms built on IBM hardware platforms to deploy new levels of reliable and cost-effective computing and high availability solutions, leveraging the cloud and the benefits of Infrastructure-as-a-Service (IaaS...
    To many people, IoT is a buzzword whose value is not understood. Many people think IoT is all about wearables and home automation. In his session at @ThingsExpo, Mike Kavis, Vice President & Principal Cloud Architect at Cloud Technology Partners, discussed some incredible game-changing use cases and how they are transforming industries like agriculture, manufacturing, health care, and smart cities. He will discuss cool technologies like smart dust, robotics, smart labels, and much more. Prepare to be blown away with a glimpse of the future.
    SYS-CON Events announced today that ProfitBricks, the provider of painless cloud infrastructure, will exhibit at SYS-CON's 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. ProfitBricks is the IaaS provider that offers a painless cloud experience for all IT users, with no learning curve. ProfitBricks boasts flexible cloud servers and networking, an integrated Data Center Designer tool for visual control over the cloud and the best price/performance value available. ProfitBricks was named one of the coolest Clo...
    Internet of Things is moving from being a hype to a reality. Experts estimate that internet connected cars will grow to 152 million, while over 100 million internet connected wireless light bulbs and lamps will be operational by 2020. These and many other intriguing statistics highlight the importance of Internet powered devices and how market penetration is going to multiply many times over in the next few years.
    The basic integration architecture, as defined by ESBs, hasn’t changed for more than a decade. Most cloud integration providers still rely on an ESB architecture and their proprietary connectors. As a result, enterprise integration projects suffer from constraints of availability and reliability of these connectors that are not re-usable across other integration vendors. However, the rapid adoption of APIs and almost ubiquitous availability of APIs amongst most SaaS and Cloud applications are rapidly redefining traditional integration approaches and their reliance on proprietary connectors. ...
    SYS-CON Events announced today that Dyn, the worldwide leader in Internet Performance, will exhibit at SYS-CON's 17th International Cloud Expo®, which will take place on November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Dyn is a cloud-based Internet Performance company. Dyn helps companies monitor, control, and optimize online infrastructure for an exceptional end-user experience. Through a world-class network and unrivaled, objective intelligence into Internet conditions, Dyn ensures traffic gets delivered faster, safer, and more reliably than ever.
    "We have a tagline - "Power in the API Economy." What that means is everything that is built in applications and connected applications is done through APIs," explained Roberto Medrano, Executive Vice President at Akana, in this SYS-CON.tv interview at 16th Cloud Expo, held June 9-11, 2015, at the Javits Center in New York City.
    WebRTC converts the entire network into a ubiquitous communications cloud thereby connecting anytime, anywhere through any point. In his session at WebRTC Summit,, Mark Castleman, EIR at Bell Labs and Head of Future X Labs, will discuss how the transformational nature of communications is achieved through the democratizing force of WebRTC. WebRTC is doing for voice what HTML did for web content.
    Today air travel is a minefield of delays, hassles and customer disappointment. Airlines struggle to revitalize the experience. GE and M2Mi will demonstrate practical examples of how IoT solutions are helping airlines bring back personalization, reduce trip time and improve reliability. In their session at @ThingsExpo, Shyam Varan Nath, Principal Architect with GE, and Dr. Sarah Cooper, M2Mi’s VP Business Development and Engineering, will explore the IoT cloud-based platform technologies driving this change including privacy controls, data transparency and integration of real time context wi...
    Buzzword alert: Microservices and IoT at a DevOps conference? What could possibly go wrong? In this Power Panel at DevOps Summit, moderated by Jason Bloomberg, the leading expert on architecting agility for the enterprise and president of Intellyx, panelists peeled away the buzz and discuss the important architectural principles behind implementing IoT solutions for the enterprise. As remote IoT devices and sensors become increasingly intelligent, they become part of our distributed cloud environment, and we must architect and code accordingly. At the very least, you'll have no problem fillin...
    The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists addressed this very serious issue of profound change in the industry.
    Internet of Things (IoT) will be a hybrid ecosystem of diverse devices and sensors collaborating with operational and enterprise systems to create the next big application. In their session at @ThingsExpo, Bramh Gupta, founder and CEO of robomq.io, and Fred Yatzeck, principal architect leading product development at robomq.io, discussed how choosing the right middleware and integration strategy from the get-go will enable IoT solution developers to adapt and grow with the industry, while at the same time reduce Time to Market (TTM) by using plug and play capabilities offered by a robust IoT ...
    It is one thing to build single industrial IoT applications, but what will it take to build the Smart Cities and truly society-changing applications of the future? The technology won’t be the problem, it will be the number of parties that need to work together and be aligned in their motivation to succeed. In his session at @ThingsExpo, Jason Mondanaro, Director, Product Management at Metanga, discussed how you can plan to cooperate, partner, and form lasting all-star teams to change the world and it starts with business models and monetization strategies.
    SYS-CON Events announced today that BMC will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. BMC delivers software solutions that help IT transform digital enterprises for the ultimate competitive business advantage. BMC has worked with thousands of leading companies to create and deliver powerful IT management services. From mainframe to cloud to mobile, BMC pairs high-speed digital innovation with robust IT industrialization – allowing customers to provide amazing user experiences with optimized IT per...
    There will be 150 billion connected devices by 2020. New digital businesses have already disrupted value chains across every industry. APIs are at the center of the digital business. You need to understand what assets you have that can be exposed digitally, what their digital value chain is, and how to create an effective business model around that value chain to compete in this economy. No enterprise can be complacent and not engage in the digital economy. Learn how to be the disruptor and not the disruptee.