Thursday, 22 September 2016

How to approach a memory leak

Steps to take to get a picture of the memory dump:
  • Get a historic look at the logs.
  • Open the heap dump with VisualVM
  • Look at the objects that using the most memory.
  • Query those objects for information using QQL.

If there are lots of objects then you need to distinguish if the object have the same type of information or they are referenced from the same type of object. It will give you a clearer picture of what type of object is causing the problem and where it is coming from.

QQL has the ability to count objects based on a criteria. For example, you query to count the number of hashmaps that have a certain size.

I have added a OQL project to GitHub. It has advanced OQL queries which you have been tested with a sample program in the project. I have expanded the queries past what is in the visualvm OQL userguide.

https://visualvm.java.net/oqlhelp.html

Sunday, 11 September 2016

Making a simple maven plugin

I had a look around for a how to create simple maven 3 plugins. There is a mixture of maven 2 and maven 3 tutorials doing it different ways. Here is one that just does a simple printout. It can be expanded to anything you can dream of.
The project below creates a maven 2 setup but I have added extra steps to make it maven 3 setup

Running this command to create a plugin project
 
mvn archetype:create -DgroupId=com.naughton \ 
-DartifactId=simple-maven-plugin \ 
-DarchetypeGroupId=org.apache.maven.archetypes \ 
-DarchetypeArtifactId=maven-archetype-mojo

It will create this project structure for you
 .  
 ./src  
 ./src/main  
 ./src/main/java  
 ./src/main/java/com  
 ./src/main/java/com/naughton  
 ./src/main/java/com/naughton/MyMojo.java  
 ./pom.xml  

The pom file should look like this. It will include the maven plugin api as a dependency and packaging will be maven-plugin. That is the only different from a default pom.

 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">  
  <modelVersion>4.0.0</modelVersion>  
  <groupId>com.naughton</groupId>  
  <artifactId>simple-maven-plugin</artifactId>  
  <packaging>maven-plugin</packaging>  
  <version>1.0-SNAPSHOT</version>  
  <name>simple-maven-plugin Maven Mojo</name>  
  <url>http://maven.apache.org</url>  
  <dependencies>  
   <dependency>  
    <groupId>org.apache.maven</groupId>  
    <artifactId>maven-plugin-api</artifactId>  
    <version>2.0</version>  
   </dependency>  
   <dependency>  
    <groupId>junit</groupId>  
    <artifactId>junit</artifactId>  
    <version>3.8.1</version>  
    <scope>test</scope>  
   </dependency>  
  </dependencies>  
 </project>  

Add in the following to the pom.xml to complete the project

This will let you add annotations in your Mojo files
 <dependency>  
       <groupId>org.apache.maven.plugin-tools</groupId>  
       <artifactId>maven-plugin-annotations</artifactId>  
       <version>3.4</version>  
       <scope>provided</scope>  
 </dependency>   

Change the MyMojo.java file to this. I have gotten rid of the Javadoc entries. Previously in maven 2 it got the goal name and phase from the Javadoc. Now you can use annotations in maven 3.
 /**  
  * Goal which prints a sentence.  
  */  
 @Mojo(name = "print",defaultPhase = LifecyclePhase.PACKAGE)  
 public class MyMojo extends AbstractMojo  
 {  
   public void execute() throws MojoExecutionException  
   {  
     getLog().info("It executed the goal by printing this sentence.");  
   }  
 }  

You can see in the build that it will find no javadoc descriptors but one annotation descriptor. That is the annotation named print above.
 [INFO] --- maven-plugin-plugin:3.4:descriptor (default-descriptor) @ simple-maven-plugin ---  
 [WARNING] Using platform encoding (UTF-8 actually) to read mojo metadata, i.e. build is platform dependent!  
 [INFO] Mojo extractor with id: java-javadoc found 0 mojo descriptors.  
 [INFO] Mojo extractor with id: java-annotations found 1 mojo descriptors.  

Add this to generate the descriptor plugin.xml file automatically
 <build>  
     <plugins>  
       <plugin>  
         <groupId>org.apache.maven.plugins</groupId>  
         <artifactId>maven-plugin-plugin</artifactId>  
         <version>3.4</version>  
       </plugin>  
     </plugins>  
   </build>   

This is what a plugin.xml file looks like. It includes the goals that the plugins supports. This is the file maven reads to understand your plugin.
 <plugin>  
  <name>simple-maven-plugin Maven Mojo</name>  
  <description></description>  
  <groupId>com.naughton</groupId>  
  <artifactId>simple-maven-plugin</artifactId>  
  <version>1.0-SNAPSHOT</version>  
  <goalPrefix>simple</goalPrefix>  
  <isolatedRealm>false</isolatedRealm>  
  <inheritedByDefault>true</inheritedByDefault>  
  <mojos>  
   <mojo>  
    <goal>print</goal>  
    <description>Goal which touches a timestamp file.</description>  
    <requiresDirectInvocation>false</requiresDirectInvocation>  
    <requiresProject>true</requiresProject>  
    <requiresReports>false</requiresReports>  
    <aggregator>false</aggregator>  
    <requiresOnline>false</requiresOnline>  
    <inheritedByDefault>true</inheritedByDefault>  
    <phase>package</phase>  
    <implementation>com.naughton.MyMojo</implementation>  
    <language>java</language>  
    <instantiationStrategy>per-lookup</instantiationStrategy>  
    <executionStrategy>once-per-session</executionStrategy>  
    <threadSafe>false</threadSafe>  
    <parameters/>  
   </mojo>  
  </mojos>  
  <dependencies>  
   <dependency>  
    <groupId>org.apache.maven</groupId>  
    <artifactId>maven-plugin-api</artifactId>  
    <type>jar</type>  
    <version>2.0</version>  
   </dependency>  
  </dependencies>  
 </plugin>  

Structure of the plugin jar file

You can see that the plugin.xml is generated by the pluging plugin.
 META-INF/  
 META-INF/MANIFEST.MF  
 META-INF/maven/  
 META-INF/maven/com.naughton/  
 META-INF/maven/com.naughton/simple-maven-plugin/  
 com/  
 com/naughton/  
 META-INF/maven/com.naughton/simple-maven-plugin/plugin-help.xml  
 META-INF/maven/plugin.xml  
 com/naughton/MyMojo.class  
 META-INF/maven/com.naughton/simple-maven-plugin/pom.xml  
 META-INF/maven/com.naughton/simple-maven-plugin/pom.properties  

How to test your new plugin

Quickest way to test is your plugin it though a command line call to one of the goals defined in the new plugin. You must first install the plugin in to your local .m2 repo by running this command in the root plugin project.

mvn install

Example: 
mvn com.naughton:simple-maven-plugin:1.0-SNAPSHOT:print


 [INFO] Scanning for projects...  
 [INFO]                                      
 [INFO] ------------------------------------------------------------------------  
 [INFO] Building simple-maven-plugin Maven Mojo 1.0-SNAPSHOT  
 [INFO] ------------------------------------------------------------------------  
 [INFO]  
 [INFO] --- simple-maven-plugin:1.0-SNAPSHOT:print (default-cli) @ simple-maven-plugin ---  
 [INFO] It executed the goal by printing this sentence.  
 [INFO] ------------------------------------------------------------------------  
 [INFO] BUILD SUCCESS  
 [INFO] ------------------------------------------------------------------------  
 [INFO] Total time: 0.238 s  
 [INFO] Finished at: 2016-09-11T19:38:39+01:00  
 [INFO] Final Memory: 7M/110M  
 [INFO] ------------------------------------------------------------------------  

How to test your plugin in another project.

Your plugin should now be in your local .m2 repository after mvn install.  To use the simple plugin use this in plugin entry in the other project pom.xml

 <build>  
   <plugins>  
    <plugin>  
     <groupId>com.naughton</groupId>  
     <artifactId>simple-maven-plugin</artifactId>  
     <version>1.0-SNAPSHOT</version>  
     <executions>  
      <execution>  
       <goals>  
        <goal>print</goal>  
       </goals>  
      </execution>  
     </executions>  
    </plugin>  
   </plugins>  
  </build>  


I have added the simple maven plugin to github to hack around with: 


References:

Thursday, 8 September 2016

A look at haskell

Recently I got some time on my hands so I started looking at programming in Haskell. I have heard of haskell a few times from academic people but never truly understood the syntax. Last week I was at a programming language debate. Haskell did have some good points so I thought I would at least understand the basics of the syntax. Just in case it was useful in the future and improve my pure functional programming skills

How I approached learning it
First I always try the hello world example. I learn two things this way. How to compile and execute  and how to print out to standard out. Printing to standard out helps with debugging. When learning a new language putting a few debugging message helps you see the flow of the program. It also shows where the program was before the failure and the values of the variables.

Next I try a few simple maths equations. Then I jump in to calling functions or methods.
  • First with no return type or arguments
  • Then with a return type. Usually returning an integer for simplicity.
  • Then with a return type and arguments. The are not linked. Just to avoid any computation problem. More concerned with getting the in and out correct first.
  • The with a return and arguments. The return is based on the arguments supplied.
Once I mastered the above then I have a basic know the of the syntax and how everything runs. I am no master at this point but a good foundation.

Thoughts on haskell while learning from scratch:
  • Has 2 ways of defining and calling functions. Makes it confusing when looking at different tutorials
  • For a beginner haskell has a lot of builtin functions. There is no way to tell the difference between defined function and a builtin which knowing the builtin functions. In java you can check were the import came to see if it came from the core library.
  • The compiler errors are hard to decipher for a beginners. It is better to start with a correct program with customizing and constant compiling. 
  • I  am not a big fan white spaces to separate arguments. I prefer to have parentheses for better readability. Also I prefer curly braces to group information instead of indentation. You can do these in haskell but white spaces and indentation seem to be the normal for less verbose code.

Here are 2 resources that I found useful.

http://book.realworldhaskell.org/read/
https://lotz84.github.io/haskellbyexample/

 I uploaded my small haskell programs. It might help a beginner.
https://github.com/martinnaughton/haskellexamples

 

Saturday, 16 July 2016

Findbug : Unusual equals method (EQ_UNUSUAL)

I came across this find bug issue in my code recently. It appeared on the all the equals methods that had overidden the objects equals. The equals method that was there look fine to me.

Definition of the issue.

http://findbugs.sourceforge.net/bugDescriptions.html#EQ_UNUSUAL
This class doesn't do any of the patterns we recognize for checking that the type of the argument is compatible with the type of the this object. There might not be anything wrong with this code, but it is worth reviewing.


What patterns does find bug look for? 

Here is the source code for the equals pattern detection.


In the method visit() there is a nested if else statement. This method is checking what equals pattern was found by method sawOpcode(). At the end of the nested if statement is this code:


 else {  
         if (AnalysisContext.currentAnalysisContext().isApplicationClass(getThisClass())) {  
           bugReporter  
           .reportBug(new BugInstance(this, "EQ_UNUSUAL", Priorities.NORMAL_PRIORITY).addClassAndMethod(this));  
 }  

This code will flag the "Unusual equals method" issue since it has checked your code against every pattern it knows.

Does your code have an issue?

Probably not since it has checked all other possible issues you could of had with your code. Like the 2 issues below. It will make you think about your equals method thought. Wondering for ages why FindBug does not like your equals method.

Some patterns it is looking for

Patterns it does not like
EQ_ALWAYS_FALSE and EQ_ALWAYS_TRUE pattern is when it is returning a boolean and the previous opcode was ICONST_0 or ICONST_1. That means the equals method always returns the same boolean regardless of input so this is flagged as EQ_ALWAYS_FALSE or EQ_ALWAYS_TRUE in findbug.

EQ_GETCLASS_AND_CLASS_CONSTANT is when you are comparing the class to another class but you are using the class name instead of "this" variable. Subclasses will be broken if they are inherit this equals.


Patterns findbug likes in an equals method
A method call to compare
An Instanceof check
A method call to getClass

Saturday, 9 July 2016

Hand carving your own wireless configurations

After Debian 6 "squeeze" network manager does not handle interfaces that  are in /etc/network/interfaces by default. You update the network manager configuration to inform it to handle those interfaces. Network Manager is included in many Linux distros. Its reason for living is to make Linux networking just work.

Network Manager will infinitely display a loading logo sign in Gnome if it does not handle the wireless interface.

There is no fun network manager handling all the juicy configuration.


What is involved when making your own wireless configurations:
  • Scanning all the wireless networks on the command line using iw
  • Looking at the details of wireless access point I want to connect to. I need to know if the authentication process it uses such as if its PSK (Pre shared key) or EAP (Extensible Authentician Protocol). I also need to know if there is a cipher required on top of the protocol.
  •  Once you have the information you can then add it to the wpa_supplicant.
 wpa_supplicant is just for the WPA protocol. For the WEP (Wired Equivalant Protocol) you use another application.  Reason is that nobody wants to touch the WEP application again. No one is using it because of the way you can sniff the packets and figure out the pre shared key being used which makes WEP unsecured.

Network Manager code

https://wiki.gnome.org/Projects/NetworkManager/Hacking

You can browse the code to see how it decides what information it needs for every network configuration.

What are the cipher used for?

TKIP and CCMP are used to encrypt your data from the computer to access point. They make sure no see what you are browsing. They use the pre shared key to encrypt the data to the router.



Here is an example of wireless printout from iwlist. It is a WPA2 router.
      Cell 06 - Address: 5C:DC:96:56:4F:F3  
           Channel:11  
           Frequency:2.462 GHz (Channel 11)  
           Quality=54/70 Signal level=-56 dBm   
           Encryption key:on  
           ESSID:"SSID"  
           Bit Rates:1 Mb/s; 2 Mb/s; 5.5 Mb/s; 11 Mb/s; 18 Mb/s  
                24 Mb/s; 36 Mb/s; 54 Mb/s  
           Bit Rates:6 Mb/s; 9 Mb/s; 12 Mb/s; 48 Mb/s  
           Mode:Master  
           Extra:tsf=0000000b307e393e  
           Extra: Last beacon: 28ms ago  
           IE: Unknown: 000B4254487562352D4A354A37  
           IE: Unknown: 010882848B962430486C  
           IE: Unknown: 03010B  
           IE: Unknown: 0706474220010D14  
           IE: Unknown: 2A0106  
           IE: Unknown: 2F0106  
           IE: IEEE 802.11i/WPA2 Version 1  
             Group Cipher : CCMP  
             Pairwise Ciphers (1) : CCMP  
             Authentication Suites (1) : PSK  

 Information you need from this print out
  • ESSID
  • Group Cipher
  • Pairwise Cipher
  • Authentication Suites
You can then add this to /etc/wpa_supplicant/wpa_supplicant.conf
 network={  
     ssid="SSID"  
     key_mgmt=WPA-PSK  
     pairwise=CCMP   
     group=CCMP  
     psk=<your psk passphrase produced by wpa_passphrase>  
     priority=1  
 }  


That is a general over view to make your own wireless configurations.

I GIT you now

My relationship with GIT is a love/hate relationship. Comparing it with SVN I have all love for GIT.

I remember the first time setting up SVN that I wanted to use with my project. I did not want the project online and I did not have a running server so I had to host the repository on my computer.  On my windows machine I thought this would be no problem but from memory you could not have the client and repository on the same machine with out a hack. SVN did not like the way I was going to set it up. I just remember giving up on SVN then.

Then came GIT with its local check in which I thought was a god send. Now development was easier to keep track of.

GIT is at version 2.9.0 now and it has a lot of features. If you look through the man pages for GIT there is a lot of options. This makes it very powerful but also colossal. Like my oven that has 20 different features, I only use 2 of them from day to day. I do not use all the  fancy features of GIT.

I like the positive flow of GIT. When all you checkins are correct. I just hate when I have a negative flow. A negative flow is when you have messed up a commit message, accidentally checked in, merged from the work branch etc. They are simple negative flows. There are harder negative flows to come back from which you need google and some one that deeply knows git.

I was at a conference recently and there was a GIT presentation. The presenter focused how to fix negative flows to return to a positive flow. Most presentations about GIT are what it is and what it does. This was a refreshing presentation. What was thought provoking was even though GIT was improving all the time the foundation GIT is built on has not changed. Blob objects, tree objects and commits are the foundation. Understand those deeply and you can figure out how to come back to a positive flow. You just need to find the command that allows to do it. Instead of not know how to come back and finding a post to explain it to you along with the command to do it.

In the future I will post my GIT negative flow conquests.

Saturday, 4 June 2016

Building Eclipse from Scratch

I read a mailing list that outlines the reason why Debian unstable still has a Eclipse version that is 4 years old. No one has been able to package it up fully and maintain it since version 3.8 of Eclipse. The latest version of eclipse is 4.5 (Mars)
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=681726

Then I thought that I have never built Eclipse from scratch previously. I wondered how hard it would be.

Thankfully they have made it easy by using a git repo that has a list of sub modules. Everything you need is in the platform aggregator repo.

By follow Section 13.4 in this tutorial you can build Eclipse 4.x. Previously the build was done differently. The new way to build is with Tycho.
http://www.vogella.com/tutorials/EclipsePlatformDevelopment/article.html

Run this command and you will see the GIT project is made up of all other projects that together form the Eclipse Java Develop Tool IDE.


 ~/eclipsebuild/eclipse.platform.releng.aggregator$ git config --file .gitmodules --name-only --get-regexp path  
 submodule.eclipse.jdt.path  
 submodule.eclipse.jdt.core.path  
 submodule.eclipse.jdt.core.binaries.path  
 submodule.eclipse.jdt.debug.path  
 submodule.eclipse.jdt.ui.path  
 submodule.eclipse.pde.path  
 submodule.eclipse.pde.build.path  
 submodule.eclipse.pde.ui.path  
 submodule.eclipse.platform.path  
 submodule.eclipse.platform.common.path  
 submodule.eclipse.platform.debug.path  
 submodule.eclipse.platform.releng.path  
 submodule.eclipse.platform.resources.path  
 submodule.eclipse.platform.runtime.path  
 submodule.eclipse.platform.swt.path  
 submodule.eclipse.platform.swt.binaries.path  
 submodule.eclipse.platform.team.path  
 submodule.eclipse.platform.text.path  
 submodule.eclipse.platform.ua.path  
 submodule.eclipse.platform.ui.path  
 submodule.rt.equinox.binaries.path  
 submodule.rt.equinox.bundles.path  
 submodule.rt.equinox.framework.path  
 submodule.rt.equinox.p2.path  
 submodule.eclipse.platform.ui.tools.path