├── target
    └── sizeof-0.3.jar
├── .gitignore
├── README.txt
├── releaseNotes.txt
├── src
    ├── test
    │   └── java
    │   │   └── net
    │   │       └── sourceforge
    │   │           └── sizeof
    │   │               └── TestSizeOf.java
    └── main
    │   └── java
    │       └── net
    │           └── sourceforge
    │               └── sizeof
    │                   └── SizeOf.java
├── pom.xml
└── license.txt


/target/sizeof-0.3.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/afeinberg/sizeof/HEAD/target/sizeof-0.3.jar


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | *.ipr
3 | *.iws
4 | target/classes
5 | target/test-classes
6 | target/surefire*
7 | target/log.txt
8 | 
9 | 


--------------------------------------------------------------------------------
/README.txt:
--------------------------------------------------------------------------------
 1 | SizeOf is a simple java agent what can be used to calculate the memory
 2 | size of java objects.  The agent is implemented with the
 3 | java.lang.instrument introduced with java 5.
 4 | 
 5 | Here is a simple howto:
 6 | 
 7 | 1) use the class SizeOf in your code to test the size of your java object:
 8 | 
 9 | 	// calculate object size
10 | 	SizeOf.sizeOf(<your object>)
11 | 	SizeOf.deepSizeOf(<your object>)
12 | 
13 | Optionally, configure SizeOf's behavior with
14 | SizeOf.skipStaticField(false) or SizeOf.skipFlyWeightObject(true)
15 | (defaults are true and false, respectively).
16 | 	
17 | 2) start the jvm with the argument: -javaagent:<path to>/SizeOf.jar
18 | 
19 | Improvements and suggestions are welcome!
20 | 


--------------------------------------------------------------------------------
/releaseNotes.txt:
--------------------------------------------------------------------------------
 1 | *** NOTE ***
 2 | 
 3 | This project was originally available only as an archive on
 4 | Sourceforge. I decided to import the project into github (for easier
 5 | contributions), introduce some commonly used Java tools (junit, maven)
 6 | and make a few stylistic changes in an effort to revive the project.
 7 | 
 8 | Most of the development, however, was done by the original
 9 | team. Unfortunately there is no VCS history available for this (it was
10 | released as a zip file), so original author information is not
11 | available in the git repository.
12 | 
13 | - Alex Feinberg (November 2010)
14 | 
15 | 
16 | 
17 | 0.3 (2011-2-19)
18 | ===============
19 | 
20 | - fix size calculation of inherited fields
21 | - added support for sizing very deeply nested objects
22 | - removed support for skipping final fields
23 | - cleaned up test suite
24 | 
25 | 
26 | 0.2.2 (2010-11-18)
27 | ==================
28 | 
29 | - mavenized the build, initial attempt at junit integration
30 | - cleaned up the Javadoc, reformatted code
31 | 
32 | 
33 | 0.2.1 (2007-10-13)
34 | ==================
35 | 
36 | - fixed a bug in recognising already processed object (thanks to
37 |   Saverio Miroddi)
38 | - added ant file in the source distribution
39 | 
40 | 
41 | 0.2 (2007-04-09)
42 | ================
43 | 
44 | - improved usability: the new method deepSizeOf doesn't throw any
45 |   checked exception
46 | - added support for (known) flyweight objects (many thanks to
47 |   Dr. Heinz Kabutz - www.javaspecialists.co.za)
48 | 
49 | 
50 | 0.1 (June 2006)
51 | ===============
52 | 
53 | Initial release
54 | 


--------------------------------------------------------------------------------
/src/test/java/net/sourceforge/sizeof/TestSizeOf.java:
--------------------------------------------------------------------------------
  1 | package net.sourceforge.sizeof;
  2 | 
  3 | import org.junit.Test;
  4 | 
  5 | import java.util.ArrayList;
  6 | import java.util.HashMap;
  7 | import java.util.LinkedHashMap;
  8 | import java.util.concurrent.ConcurrentSkipListMap;
  9 | import java.util.concurrent.locks.ReentrantReadWriteLock;
 10 | 
 11 | import static junit.framework.Assert.assertEquals;
 12 | import static net.sourceforge.sizeof.SizeOf.*;
 13 | 
 14 | /**
 15 |  * A simple class to test SizeOf behavior
 16 |  */
 17 | public class TestSizeOf {
 18 |     private static final int EMPTY_ARRAY_SIZE = 24;
 19 | 
 20 |     @Test
 21 |     public void testPrimitives() {
 22 |         assertEquals(16, sizeOf(new Object()));
 23 |         assertEquals(16, deepSizeOf(new Object()));
 24 | 
 25 |         assertEquals(24, sizeOf(new Integer(0)));
 26 |         assertEquals(24, deepSizeOf(new Integer(0)));
 27 | 
 28 |         assertEquals(40, sizeOf(""));
 29 |         assertEquals(40 + EMPTY_ARRAY_SIZE, deepSizeOf(""));
 30 |         assertEquals(40, sizeOf("a"));
 31 |         assertEquals(40 + EMPTY_ARRAY_SIZE + 8, deepSizeOf("a"));
 32 | 
 33 |         assertEquals(EMPTY_ARRAY_SIZE, sizeOf(new Object[0]));
 34 |         Object[] objects = new Object[100];
 35 |         assertEquals(EMPTY_ARRAY_SIZE + 8 * 100, sizeOf(objects));
 36 |         assertEquals(EMPTY_ARRAY_SIZE + 8 * 100, deepSizeOf(objects));
 37 |         for(int i = 0; i < objects.length; i++) {
 38 |             objects[i] = new Object();
 39 |         }
 40 |         assertEquals(EMPTY_ARRAY_SIZE + 8 * 100 + 16 * 100, deepSizeOf(objects));
 41 |     }
 42 | 
 43 |     @Test
 44 |     public void testCycle() {
 45 |         Recursive dummy = new Recursive();
 46 |         assertEquals(32, sizeOf(dummy));
 47 |         assertEquals(32, deepSizeOf(dummy));
 48 |         dummy.child = dummy;
 49 |         assertEquals(32, deepSizeOf(dummy));
 50 |     }
 51 | 
 52 |     @Test
 53 |     public void testInheritance() {
 54 |         assertEquals(24, sizeOf(new Parent()));
 55 |         assertEquals(24, deepSizeOf(new Parent()));
 56 |         assertEquals(32, sizeOf(new Child()));
 57 |         assertEquals(32, deepSizeOf(new Child()));
 58 |     }
 59 | 
 60 |     @Test
 61 |     public void testCollections() {
 62 |         assertEquals(144, deepSizeOf(new ArrayList()));
 63 |         assertEquals(216, deepSizeOf(new HashMap()));
 64 |         assertEquals(296, deepSizeOf(new LinkedHashMap()));
 65 |         assertEquals(176, deepSizeOf(new ReentrantReadWriteLock()));
 66 |         assertEquals(192, deepSizeOf(new ConcurrentSkipListMap()));
 67 |     }
 68 | 
 69 |     @Test
 70 |     public void testFlyweights() {
 71 |         skipFlyweightObject(true);
 72 |         assertEquals(0, sizeOf(Thread.State.TERMINATED));
 73 |         assertEquals(0, sizeOf(Boolean.TRUE));
 74 |         assertEquals(0, sizeOf(Integer.valueOf(0)));
 75 |         skipFlyweightObject(false);
 76 |     }
 77 | 
 78 |     @Test
 79 |     public void testDeep() {
 80 |         Recursive root = new Recursive();
 81 |         Recursive recursive = root;
 82 |         for (int i = 0; i < 100000; i++) {
 83 |             recursive.child = new Recursive();
 84 |             recursive = recursive.child;
 85 |         }
 86 |         assertEquals(32 * 100001, deepSizeOf(root));
 87 |     }
 88 | 
 89 |     private static class Parent {
 90 |         private int i;
 91 |     }
 92 | 
 93 |     private static class Child extends Parent {
 94 |         private int j;
 95 |     }
 96 | 
 97 |     private static class Recursive {
 98 |         int i;
 99 |         Recursive child = null;
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 5 |     <modelVersion>4.0.0</modelVersion>
 6 |     <groupId>net.sourceforge.sizeof</groupId>
 7 |     <artifactId>sizeof</artifactId>
 8 |     <name>SizeOf</name>
 9 |     <description>
10 |         java.SizeOf is a simple java agent what can be used to calculate the
11 |         memory size of java objects. The agent is implemented with the
12 |         java.lang.instrument introduced with java 5.
13 |     </description>
14 |     <version>0.3</version>
15 |     <url>http://sourceforge.net/projects/sizeof</url>
16 | 
17 |     <build>
18 |         <pluginManagement>
19 |             <plugins>
20 |                 <plugin>
21 |                     <artifactId>maven-compiler-plugin</artifactId>
22 |                     <configuration>
23 |                         <source>1.5</source>
24 |                         <target>1.5</target>
25 |                         <showWarnings>true</showWarnings>
26 |                         <showDeprecation>true</showDeprecation>
27 |                     </configuration>
28 |                 </plugin>
29 |                 <plugin>
30 |                     <groupId>org.apache.maven.plugins</groupId>
31 |                     <artifactId>maven-jar-plugin</artifactId>
32 |                     <version>2.1</version>
33 |                     <configuration>
34 |                         <archive>
35 |                             <manifestEntries>
36 |                                 <Premain-Class>net.sourceforge.sizeof.SizeOf</Premain-Class>
37 |                                 <Can-Redefine-Classes>true</Can-Redefine-Classes>
38 |                             </manifestEntries>
39 |                         </archive>
40 |                     </configuration>
41 |                 </plugin>
42 |                 <plugin>
43 |                     <groupId>org.apache.maven.plugins</groupId>
44 |                     <artifactId>maven-surefire-plugin</artifactId>
45 |                     <configuration>
46 | 
47 |                         <forkMode>pertest</forkMode>
48 |                         <argLine>-javaagent:${basedir}/target/sizeof-${project.version}.jar</argLine>
49 |                         <workingDirectory>${basedir}/target</workingDirectory>
50 |                         <useSystemClassLoader>true</useSystemClassLoader>
51 | 
52 |                     </configuration>
53 |                 </plugin>
54 |                 <plugin>
55 |                     <groupId>org.apache.maven.plugins</groupId>
56 |                     <artifactId>maven-dependency-plugin</artifactId>
57 |                     <executions>
58 |                         <execution>
59 |                             <id>copy</id>
60 |                             <phase>process-resources</phase>
61 |                             <goals>
62 |                                 <goal>copy</goal>
63 |                             </goals>
64 |                             <configuration>
65 |                                 <artifactItems>
66 |                                     <artifactItem>
67 |                                         <groupId>net.sourceforge.sizeof</groupId>
68 |                                         <artifactId>sizeof</artifactId>
69 |                                         <version>${project.version}</version>
70 |                                         <outputDirectory>${project.build.directory}</outputDirectory>
71 |                                     </artifactItem>
72 |                                 </artifactItems>
73 |                             </configuration>
74 |                         </execution>
75 |                     </executions>
76 |                 </plugin>
77 |             </plugins>
78 |         </pluginManagement>
79 |     </build>
80 | 
81 |     <dependencies>
82 |     <dependency>
83 |       <groupId>junit</groupId>
84 |       <artifactId>junit</artifactId>
85 |       <version>4.8.1</version>
86 |       <scope>test</scope>
87 |     </dependency>
88 |     </dependencies>
89 | </project>
90 | 


--------------------------------------------------------------------------------
/src/main/java/net/sourceforge/sizeof/SizeOf.java:
--------------------------------------------------------------------------------
  1 | package net.sourceforge.sizeof;
  2 | 
  3 | import java.io.IOException;
  4 | import java.io.OutputStream;
  5 | import java.lang.instrument.*;
  6 | import java.lang.reflect.Field;
  7 | import java.lang.reflect.Modifier;
  8 | import java.util.*;
  9 | 
 10 | /**
 11 |  * A simple implementation of C++ keyword sizeof for Java 5+
 12 |  *
 13 |  * @author Nicola Santi
 14 |  * @author Marco Rosi
 15 |  * @version 0.2.2
 16 |  * @see java.lang.instrument.Instrumentation
 17 |  */
 18 | public class SizeOf {
 19 |     private static OutputStream out = System.out;
 20 | 
 21 |     /**
 22 |      * Instance of java.lang.instrument.Instrument injected by the Java VM
 23 |      *
 24 |      * @see #premain(String options, Instrumentation inst)
 25 |      */
 26 |     private static Instrumentation inst;
 27 | 
 28 |     private static long MIN_CLASS_SIZE_TO_LOG = Long.MAX_VALUE;
 29 |     private static boolean SKIP_STATIC_FIELD = true;
 30 |     private static boolean SKIP_FLYWEIGHT_FIELD = false;
 31 |     private static boolean debug = false;
 32 | 
 33 |     /**
 34 |      * Callback method used by the Java VM to inject the java.lang.instrument.Instrument
 35 |      * instance
 36 |      */
 37 |     public static void premain(String options, Instrumentation inst) {
 38 |         SizeOf.inst = inst;
 39 |     }
 40 | 
 41 |     /**
 42 |      * Calls java.lang.instrument.Instrument.getObjectSize(object).
 43 |      *
 44 |      * @param object the object to size
 45 |      * @return an implementation-specific approximation of the amount of storage consumed
 46 |      *         by the specified object.
 47 |      * @see java.lang.instrument.Instrumentation#getObjectSize(Object objectToSize)
 48 |      */
 49 |     public static long sizeOf(Object object) {
 50 |         if(inst == null)
 51 |             throw new IllegalStateException("Instrumentation is null");
 52 | 
 53 |         if(SKIP_FLYWEIGHT_FIELD && isSharedFlyweight(object))
 54 |             return 0;
 55 | 
 56 |         return inst.getObjectSize(object);
 57 |     }
 58 | 
 59 |     private static String[] unit = {"b", "Kb", "Mb"};
 60 | 
 61 |     /**
 62 |      * Format size in a human readable format
 63 |      *
 64 |      * @param size
 65 |      * @return a string representation of the size argument followed by
 66 |      *         b for byte, Kb for kilobyte or Mb for megabyte
 67 |      */
 68 |     public static String humanReadable(long size) {
 69 |         int i;
 70 |         double dSize = size;
 71 |         for(i = 0; i < 3; ++i) {
 72 |             if(dSize < 1024)
 73 |                 break;
 74 |             dSize /= 1024;
 75 |         }
 76 | 
 77 |         return dSize + unit[i];
 78 |     }
 79 | 
 80 |     /**
 81 |      * @deprecated use deepSizeOf
 82 |      */
 83 |     public static long iterativeSizeOf(Object objectToSize) throws IllegalArgumentException,
 84 |                                                                    IllegalAccessException, IOException {
 85 |         return deepSizeOf(objectToSize);
 86 |     }
 87 | 
 88 |     /**
 89 |      * Compute an implementation-specific approximation of the amount of storage consumed
 90 |      * by objectToSize and by all the objects reachable from it
 91 |      *
 92 |      * @param object
 93 |      * @return an implementation-specific approximation of the amount of storage consumed
 94 |      *         by objectToSize and by all the objects reachable from it
 95 |      */
 96 |     public static long deepSizeOf(Object object) {
 97 |         if(object == null) {
 98 |             if(debug)
 99 |                 print("null\n");
100 |             return 0;
101 |         }
102 | 
103 |         Map<Object, Object> seen = new IdentityHashMap<Object, Object>();
104 |         Stack<Object> stack = new Stack<Object>();
105 |         stack.push(object);
106 |         long size = 0;
107 |         while (!stack.isEmpty()) {
108 |             Object current = stack.pop();
109 |             assert current != null;
110 | 
111 |             if(seen.containsKey(current)) {
112 |                 if(debug)
113 |                     print("\n%s already included\n");
114 |                 continue;
115 |             }
116 |             seen.put(current, null);
117 |             size += sizeOf(current);
118 | 
119 |             if(debug)
120 |                 print("\n{ %s\n", current.getClass().getName());
121 | 
122 |             if(current instanceof Object[]) {
123 |                 int i = 0;
124 |                 for(Object child : (Object[]) current) {
125 |                     if(debug)
126 |                         print("[%d] = %s", i++, child);
127 |                     if (child != null)
128 |                         stack.push(child);
129 |                 }
130 |             } else {
131 |                 Class cls = current.getClass();
132 |                 while(cls != null)
133 |                 {
134 |                     for(Field field : cls.getDeclaredFields()) {
135 |                         field.setAccessible(true);
136 |                         Object child;
137 |                         try {
138 |                             child = field.get(current);
139 |                         } catch(IllegalArgumentException e) {
140 |                             throw new RuntimeException(e);
141 |                         } catch(IllegalAccessException e) {
142 |                             throw new RuntimeException(e);
143 |                         }
144 | 
145 |                         if(isDeep(field)) {
146 |                             if(debug)
147 |                                 print("%s = %s", field.getName(), child);
148 |                             if (child != null)
149 |                                 stack.push(child);
150 |                         } else {
151 |                             if(debug)
152 |                                 print("skipping %s = %s\n", field.getName(), child);
153 |                         }
154 |                     }
155 | 
156 |                     cls = cls.getSuperclass();
157 |                 }
158 |             }
159 |         }
160 | 
161 |         if(debug)
162 |             print("%s} size = %s\n", humanReadable(size));
163 | 
164 |         if(size >= MIN_CLASS_SIZE_TO_LOG)
165 |             print("Found big object: %s@%s size: %s\n",
166 |                   object.getClass().getName(), System.identityHashCode(object), humanReadable(size));
167 | 
168 |         return size;
169 |     }
170 | 
171 |     /**
172 |      * Return true if the specified class is a primitive type
173 |      *
174 |      * @param clazz
175 |      */
176 |     private static boolean isAPrimitiveType(Class clazz) {
177 |         if(clazz == java.lang.Boolean.TYPE)
178 |             return true;
179 | 
180 |         if(clazz == java.lang.Character.TYPE)
181 |             return true;
182 | 
183 |         if(clazz == java.lang.Byte.TYPE)
184 |             return true;
185 | 
186 |         if(clazz == java.lang.Short.TYPE)
187 |             return true;
188 | 
189 |         if(clazz == java.lang.Integer.TYPE)
190 |             return true;
191 | 
192 |         if(clazz == java.lang.Long.TYPE)
193 |             return true;
194 | 
195 |         if(clazz == java.lang.Float.TYPE)
196 |             return true;
197 | 
198 |         if(clazz == java.lang.Double.TYPE)
199 |             return true;
200 | 
201 |         if(clazz == java.lang.Void.TYPE)
202 |             return true;
203 | 
204 |         return false;
205 |     }
206 | 
207 |     /**
208 |      * @param field
209 |      * @return true if the field must be computed
210 |      */
211 |     private static boolean isDeep(Field field) {
212 |         int modificatori = field.getModifiers();
213 | 
214 |         if(isAPrimitiveType(field.getType()))
215 |             return false;
216 |         else if(SKIP_STATIC_FIELD && Modifier.isStatic(modificatori))
217 |             return false;
218 |         else
219 |             return true;
220 |     }
221 | 
222 |     /**
223 |      * Returns true if this is a well-known shared flyweight.
224 |      * For example, Booleans and cached Number objects.
225 |      *
226 |      * We do NOT check for interned strings since there is no API to do so harmlessly.
227 |      * <p/>
228 |      * thanks to Dr. Heinz Kabutz
229 |      * see http://www.javaspecialists.co.za/archive/Issue142.html
230 |      */
231 |     private static boolean isSharedFlyweight(Object obj) {
232 |         // optimization - all of our flyweights are Comparable
233 |         if(obj instanceof Comparable) {
234 |             if(obj instanceof Enum) {
235 |                 return true;
236 |             } else if(obj instanceof Boolean) {
237 |                 return (obj == Boolean.TRUE || obj == Boolean.FALSE);
238 |             } else if(obj instanceof Integer) {
239 |                 return (obj == Integer.valueOf((Integer) obj));
240 |             } else if(obj instanceof Short) {
241 |                 return (obj == Short.valueOf((Short) obj));
242 |             } else if(obj instanceof Byte) {
243 |                 return (obj == Byte.valueOf((Byte) obj));
244 |             } else if(obj instanceof Long) {
245 |                 return (obj == Long.valueOf((Long) obj));
246 |             } else if(obj instanceof Character) {
247 |                 return (obj == Character.valueOf((Character) obj));
248 |             }
249 |         }
250 |         return false;
251 |     }
252 | 
253 |     /**
254 |      * The objects processed by deepSizeOf are logged to the log output stream if
255 |      * their size (in byte) is greater than this value.
256 |      * The default value is 1024*1024 (1 megabyte), 0 turn off logging
257 |      */
258 |     public static void setMinSizeToLog(long min_class_size_to_log) {
259 |         MIN_CLASS_SIZE_TO_LOG = min_class_size_to_log;
260 |     }
261 | 
262 |     /**
263 |      * If true deepSizeOf() doesn't compute the static fields of an object.
264 |      * Default value is false.
265 |      */
266 |     public static void skipStaticField(boolean skip_static_field) {
267 |         SKIP_STATIC_FIELD = skip_static_field;
268 |     }
269 | 
270 |     /**
271 |      * If true flyweight objects has a size of 0.
272 |      * Default value is false.
273 |      */
274 |     public static void skipFlyweightObject(boolean skip) {
275 |         SKIP_FLYWEIGHT_FIELD = skip;
276 |     }
277 | 
278 |     static void print(String s) {
279 |         try {
280 |             out.write(s.getBytes());
281 |         } catch(IOException e) {
282 |             throw new RuntimeException(e);
283 |         }
284 |     }
285 | 
286 |     private static void print(String s, Object... args) {
287 |         try {
288 |             out.write(String.format(s, args).getBytes());
289 |         } catch(IOException e) {
290 |             throw new RuntimeException(e);
291 |         }
292 |     }
293 | 
294 |     /**
295 |      * Sets the OutputStream to use for logging.
296 |      * The default OutputStream is System.out
297 |      *
298 |      * @param o
299 |      */
300 |     public static void setLogOutputStream(OutputStream o) {
301 |         if(o == null)
302 |             throw new IllegalArgumentException("Can't use a null OutputStream");
303 | 
304 |         out = o;
305 |     }
306 | 
307 |     /**
308 |      * Turn on debugging information
309 |      */
310 |     public static void turnOnDebug() {
311 |         debug = true;
312 |     }
313 | 
314 |     /**
315 |      * Turn off debugging information
316 |      */
317 |     public static void turnOffDebug() {
318 |         debug = false;
319 |     }
320 | }
321 | 


--------------------------------------------------------------------------------
/license.txt:
--------------------------------------------------------------------------------
  1 |   GNU GENERAL PUBLIC LICENSE
  2 | 		       Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
  5 |  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 | 			    Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 | 		    GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 | 			    NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 | 		     END OF TERMS AND CONDITIONS
281 | 
282 | 	    How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     <one line to give the program's name and a brief idea of what it does.>
294 |     Copyright (C) <year>  <name of author>
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License
307 |     along with this program; if not, write to the Free Software
308 |     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
309 | 
310 | 
311 | Also add information on how to contact you by electronic and paper mail.
312 | 
313 | If the program is interactive, make it output a short notice like this
314 | when it starts in an interactive mode:
315 | 
316 |     Gnomovision version 69, Copyright (C) year name of author
317 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318 |     This is free software, and you are welcome to redistribute it
319 |     under certain conditions; type `show c' for details.
320 | 
321 | The hypothetical commands `show w' and `show c' should show the appropriate
322 | parts of the General Public License.  Of course, the commands you use may
323 | be called something other than `show w' and `show c'; they could even be
324 | mouse-clicks or menu items--whatever suits your program.
325 | 
326 | You should also get your employer (if you work as a programmer) or your
327 | school, if any, to sign a "copyright disclaimer" for the program, if
328 | necessary.  Here is a sample; alter the names:
329 | 
330 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
332 | 
333 |   <signature of Ty Coon>, 1 April 1989
334 |   Ty Coon, President of Vice
335 | 
336 | This General Public License does not permit incorporating your program into
337 | proprietary programs.  If your program is a subroutine library, you may
338 | consider it more useful to permit linking proprietary applications with the
339 | library.  If this is what you want to do, use the GNU Lesser General
340 | Public License instead of this License.
341 | 


--------------------------------------------------------------------------------