Last commit for README.md: 733dd937ef86464b79f6437b2088dd20adf5adbc

Updated README to reference new jar

Jonathan Bell [2012-12-02 17:46:28]
Updated README to reference new jar
  1. ChroniclerJ [Chronicler implemented in Java]
  2. =======
  3.  
  4. *Lightweight Recording of Nondeterministic Inputs to Reproduce Field Failures*
  5.  
  6. **ChroniclerJ** is a system for recording buggy program executions in the field and reproducing them in the lab. **ChroniclerJ** is our Java implementation of **Chronicler**, a generalized record and replay approach for VM-based languages.
  7.  
  8. This repository contains the source and a [runnable binary](https://github.com/Programming-Systems-Lab/chroniclerj/blob/master/chroniclerj-0.4.1.jar) for **ChroniclerJ**.
  9.  
  10. ###For more information
  11. Please see our Technical Report:
  12. <http://mice.cs.columbia.edu/getTechreport.php?techreportID=1512&format=pdf>, or email [Jonathan Bell](mailto:jbell@cs.columbia.edu)
  13.  
  14. Running
  15. -----
  16. ### Instrumenting your code
  17. Before deploying your code, you need to run the **ChroniclerJ** instrumenter, which will produce two copies of your program: one for deployment (with logging code), and one for replay purposes (with code that reads back from the log).
  18.  
  19. To run the instrumenter, use the command `java -jar chroniclerj-0.4.1.jar -instrument {-mxLogN} input ouputLocationDeploy outputLocationReplay`, where:
  20. * `{-mxLogN}` is an optional parameter indiciating that at most `N` items should be stored in the in-memory logfile before it is flushed to disk
  21. * `input` is the path that contains the .class files, .jar files, etc that need to be instrumented (e.g. what you would be deploying normally)
  22. * `outputLocationDeploy` is where you would like the generated code (for deployment) to be placed
  23. * `outputLocationReplay` is where you would like the generated code (for running replays) to be placed
  24.  
  25. It is important that *all* libraries that you plan to deploy with your application are instrumented. We suggest running the instrumenter at the top level folder that you were going to deploy, which might contain several jar files, several class files, etc.
  26.  
  27. ### Collecting test cases
  28. Deploy your code as you normally would, but deploy the code that was instrumented and placed in `outputLocationDeploy` rather than your original, uninstrumented code. Make sure that the **ChroniclerJ** jar is in your classpath too.
  29.  
  30. When an uncaught exception ocurrs, **ChroniclerJ** generates a test case. You can manually invoke this process (e.g. from your own exception handler) by calling the method `ChroniclerJExceptionRunner.genTestCase()`. Users are notified that a test case was generated, which is placed in the current working directory and has the name format chroniclerj-crash-*currenttime*.test. The test case file contains all logs necessary to replay the execution.
  31.  
  32. ### Replaying test cases
  33. To replay the failed executions, run the command `java -jar chroniclerj-0.4.1.jar -replay testCase {classpath}`, where
  34. * `testCase` is the test case to run
  35. * `{classpath}` is a space-delimited classpath passed to your program when it starts to replay
  36.  
  37. Building
  38. -----
  39. **ChroniclerJ** is an eclipse project, and should simply be added to eclipse, and built as a Java project.
  40.  
  41. ###Packaging
  42. To create the **ChroniclerJ** jar, first run the `unpackLibs.sh` command to unpack the libraries that **ChroniclerJ** depends on, then `makeJar.sh` to generate a jar file with **ChroniclerJ** and its libraries embedded.
  43.  
  44. License
  45. ------
  46. This software is released under the MIT license.
  47.  
  48. Copyright (c) 2012, by The Trustees of Columbia University in the City of New York.
  49.  
  50. Permission is hereby granted, free of charge, to any person obtaining
  51. a copy of this software and associated documentation files (the
  52. "Software"), to deal in the Software without restriction, including
  53. without limitation the rights to use, copy, modify, merge, publish,
  54. distribute, sublicense, and/or sell copies of the Software, and to
  55. permit persons to whom the Software is furnished to do so, subject to
  56. the following conditions:
  57.  
  58. The above copyright notice and this permission notice shall be
  59. included in all copies or substantial portions of the Software.
  60.  
  61. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  62. EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  63. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  64. NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  65. LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  66. OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  67. WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  68.  
  69.  
  70. Acknowledgements
  71. -----
  72. This project makes use of the following libraries:
  73. * [ASM](http://asm.ow2.org/license.html), (c) 2000-2011 INRIA, France Telecom, [license](http://asm.ow2.org/license.html)
  74. * [Cloning](https://code.google.com/p/cloning/), (c) 2009 Konstantinos Kougios, released under the Apache License 2.0
  75. * [KXML2](http://kxml.sourceforge.net/kxml2/), (c) 1999-2005, Stefan Haustein, released under the BSD license
  76. * [Objenesis](http://code.google.com/p/objenesis/), © 2006-2012, Joe Walnes, Henri Tremblay and Leonardo Mesquita, released under the Apache License 2.0
  77. * [Log4j](http://logging.apache.org/log4j/), (c) 1999-2012, Apache Software Foundation, released under the Apache License 2.0
  78. * [XStream](http://xstream.codehaus.org/, (c) 2003-2006, Joe Walnes and (c) 2006-2009, 2011 XStream Committers, released under [a BSD license](http://xstream.codehaus.org/license.html)
  79.  
  80. The authors of this software are [Jonathan Bell](http://jonbell.net), [Nikhil Sarda](https://github.com/diffoperator/) and [Gail Kaiser](http://www.cs.columbia.edu/~kaiser/). The authors are members of the [Programming Systems Laboratory](http://www.psl.cs.columbia.edu/), funded in part by NSF CCF-1161079, NSF CNS-0905246 and NIH 2 U54 CA121852-06.