Skip to content

Commit

Permalink
First commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hiroshi KAZATO committed Nov 24, 2013
0 parents commit 3d54c8a
Show file tree
Hide file tree
Showing 12 changed files with 1,246 additions and 0 deletions.
202 changes: 202 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
149 changes: 149 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
# YEBISU

**YEBISU** (**YE**t another **B**ytecode **I**nstrumentation agent for **S**oftware **U**nderstanding) is a toolkit for conducting dynamic analysis on Java applications.
It observes runtime behavior of a subject application and records execution events to a trace log.

## How it works

### On-the-fly bytecode instrumentation

The agent is implemented based on `java.lang.instrument` API.
It hooks to Java Virtual Machine (JVM) and intercept each Java class being loaded.

When a class being loaded is of interest, event notification calls are instrumented by using bytecode transformation technique.
This transformation is done on the fly; **classes (*.class) and JAR files on the file system are not modified** by the agent.

### Execution Events

When the instrumented classes are executed, the following events are notified back to the agent and recoded in trace log files.

* `ClassLoad (classId, className)`:
Notifies a class being loaded to the virtual machine. A unique identifier and a fully qualified name of the class are given as parameters.

* `MethodInstrument (classId, methodId, methodName)`:
Notifies a method of a class is being instrumented. Unique identifiers of the class and the methods and a fully qualified name of the method are given as parameters.

* `MethodEntry (methodId, context, arguments)`:
Notifies execution of an instrumented method has begun.
The context of the method (i.e. `this` object) and the arguments of the invocation are given as parameters.

* `MethodExit (methodId, returnValue)`
Notifies execution of an instrumented method has just finished.
The context of the method (i.e. `this` object) and the return value are given as parameters.

* `JVMShutdown`:
Notifies the virtual machine is shutting down. After recording this event, trace log file is closed.
No parameter is given with this event.

## System Requirements

* Java Runtime Environment (JRE) 1.5 or higher

## Install

You will find the follwing two files in the distribution.
Their location does not matter: place them anywhere you like.

* `yebisu.jar` : JAR library containing the agent
* `yebisu properties` : configuration file for the agent

## Usage

### Configuring the agent

Open the `yebisu.properties` file in your text editor and modify configurations for the agent.
In many cases you may want to change the following items.

* Location of trace log files

Specify a location and a file name pattern for the trace log file.
A relative path is traversed from the working (current) directory of the `java` command.
By default, startup time of the agent is shown as a part of the file name.

yebisu.event.csv.file.pattern=./yebisu-event-{0,date,yyyyMMddHHmmss}.csv

* Prefixes of class names to be observed

Observing all classes in an application may cause too much overhead and make applications unacceptably slow.
To limit the number of classes/methods to be observed, you had better specify package names of your interest.

yebisu.include.prefix.0=my.application.package.

* Prefixes of class names **NOT** to be observed

Specify package names that are not of your interest.
By default, the agent ignores classes in YEBISU (`yebusu.jar`), JRE runtime library and other 3rd party libraries.
Observing them may cause JVM crash or produce too much logs.
Some commercial libraries are not allowed to be modified by their terms and conditions.

yebisu.exclude.prefix.0=jp.ac.titech.cs.se.yebisu.
yebisu.exclude.prefix.1=java.
yebisu.exclude.prefix.2=javax.
yebisu.exclude.prefix.3=sun.
yebisu.exclude.prefix.4=com.sun.
yebisu.exclude.prefix.5=apple.
yebisu.exclude.prefix.6=com.apple.


### Observing a standalone application

To analyze a Java application, run `java` command with additional `-javaagent` option to give the location of `yebisu.jar`.

java -javaagent:/path/to/yebisu.jar Main

Here, `Main` is a main class of your application.
By default, yebisu.properties file is read from working (current) directory of the `java` command.
Instead, you can tell the agent to use a property file in the other location:

java -javaagent:/path/to/yebisu.jar=/foo/bar/yebisu.properties Main

### Observing a web application

The agent can observe Java EE web applications, by adding `-javaagent` option to startup scripts of application servers.
The location of startup scripts to be modified depends on your server products.

#### Apache Tomcat

For example, [Apache Tomcat](http://tomcat.apache.org/) sources `${CATALINA_HOME}/bin/setenv.sh` (or `setenv.bat` in Windows) in its startup script.
You can specify the `-javaagent` option in the setenv script.

* UNIX, Linux and Mac: ${CATALINA_HOME}/bin/setenv.sh

export JAVA_OPTS="-javaagent:/path/to/yebisu.jar=/foo/bar/yebisu.properties"

* Windows: ${CATALINA_HOME}/bin/setenv.bat

@echo off
set JAVA_OPTS="-javaagent:C:\path\to\yebisu.jar=C:\foo\bar\yebisu.properties"

### Obtaining execution traces

Observed events are recorded in the trace log file specified in the `yebisu.properties` file.
Trace logs conforms CSV (comma separeted values) format and currently we do not bundle any analysis tool for them.
Write your own log parsers to fit your needs.

## Compile and build

YEBISU is built by using [Apache Maven](http://maven.apache.org/).
Before you proceed, download Maven and configure the environment variable `M2_HOME` properly.

1. Fork (or download) the source code.
2. Open your terminal or command prompt, move to the directory containing pom.xml and hit `mvn package` there.
3. After maven build succeeds, you will find `yebisu.jar` and `yebisu.properties` in `target/` subdirectory.

## References

YEBISU is designed for stimulating researchers in software engineering.
Feel free to use it in your research and publications.
Please cite the following article as its source:

* Hiroshi Kazato, Shinpei Hayashi, Tsuyoshi Oshima, Shunsuke Miyata, Takashi Hoshino, Motoshi Saeki: "Extracting and Visualizing Implementation Structure of Features". In Proceedings of the 20th Asia-Pacific Software Engineering Conference (APSEC 2013). Bangkok, Thailand, dec, 2013.

## Copyright and license

Copyright (c) 2010-2012 [Saeki Lab.](http://www.se.cs.titech.ac.jp/) at [Tokyo Institute of Technology](http://www.titech.ac.jp/).
YEBISU is an open source software, licensed under the [Apache Licese, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

## Acknowledgment

This software includes [Javassisst](http://www.csg.ci.i.u-tokyo.ac.jp/~chiba/javassist/) developed by [Shigeru Chiba](http://www.csg.ci.i.u-tokyo.ac.jp/~chiba/site/).
Loading

0 comments on commit 3d54c8a

Please sign in to comment.