Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Commit

Permalink
Minor refinements to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Vivek Thampi committed Mar 27, 2012
1 parent d3d211e commit 816395a
Showing 1 changed file with 35 additions and 33 deletions.
68 changes: 35 additions & 33 deletions README.md
Expand Up @@ -2,38 +2,35 @@

VProbes is a safe, dynamic technology for transparently instrumenting
a powered-on guest operating system, its currently running processes,
and VMware's virtualization software. VProbes provides, both dynamically
and VMware's virtualization software. VProbes provides both dynamically
and statically defined probes. You can find more detailed documentation
for VProbes at the [community website](http://communities.vmware.com/community/vmtn/developer/forums/vprobes)
for VProbes at the [community website][1].

This Toolkit provides an interactive, programmer-friendly interface to
VProbes. It allows you to write instrumentation scripts using a C-like
high-level language called Emmett as a replacement for the more
primitive VP language native to VProbes.


## License

See License.txt


## Overview

This toolkit consists the following:
high-level language called Emmett which is a replacement for the more
primitive VP language native to VProbes. It includes,

1. Source code for the Emmett compiler (emmett).
2. Example VProbes scripts written in Emmett (cookbook).
3. Some sample scripts that monitor interesting events in Linux
guests (bin).


## License

See License.txt


## Compatibility

This toolkit is compatible with the following products:

VMware Workstation 8
VMware Fusion 4
* [VMware Workstation][2] 8
* [VMware Fusion][3] 4.0, 4.0.1, 4.0.2, 4.1.0, 4.1.1

[2]:http://www.vmware.com/products/workstation/
[3]:http://www.vmware.com/products/fusion/

## Build and Install

Expand All @@ -50,9 +47,9 @@ satisfy before building the toolkit.
Once you have the required software packages, building is as simple
as,

vprobe-toolkit/ $ ./configure
vprobe-toolkit/ $ make
vprobe-toolkit/ $ [sudo] make install
vprobe-toolkit $ ./configure
vprobe-toolkit $ make
vprobe-toolkit $ [sudo] make install


The toolkit files should be installed in the appropriate system
Expand Down Expand Up @@ -95,7 +92,7 @@ quit Fusion. Then add the following line,

vprobe.allow = TRUE

to the following file,
to the file,

/Library/Application\ Support/VMware Fusion/config

Expand Down Expand Up @@ -127,7 +124,7 @@ and quit Workstation. Then add the following line,

vprobe.allow = TRUE

to the following file,
to the file,

/etc/vmware/config

Expand Down Expand Up @@ -175,13 +172,13 @@ forum](http://communities.vmware.com/community/developer/forums/vprobes).

The toolkit uses GNU Make and Autoconf for managing build configuration.
The Autoconf configuration template is: `$(src)/configuration.in`. To
make things convenient, the `configure</code>` script generated by
autoconf is also checked in as part of the source. The assumption is
that `configure.in` will not be modified very often. If it is modified,
you must perform the following steps:
make things convenient, the `configure` script generated by autoconf is
also checked in as part of the source. The assumption is that
`configure.in` will not be modified very often. If it is modified, you
must perform the following steps:

vprobe-toolkit/ $ aclocal -I m4 --force
vprobe-toolkit/ $ autoreconf -I m4 -f -i
vprobe-toolkit $ aclocal -I m4 --force
vprobe-toolkit $ autoreconf -I m4 -f -i

This will generate an updated `configure` script. **Don't forget to
check-in the updated script!**
Expand All @@ -194,9 +191,9 @@ comes with Apple's Xcode development suite, so make sure you have Xcode
installed. To build the package, perform the following commands at the root of
the toolkit source tree,

vprobe-toolkit/ $ ./configure
vprobe-toolkit/ $ make
vprobe-toolkit/ $ make -C installer/macos
vprobe-toolkit $ ./configure
vprobe-toolkit $ make
vprobe-toolkit $ make -C installer/macos

This will build `vprobe-toolkit.pkg` in `$(src)/installer/macos</code>`.

Expand All @@ -217,6 +214,11 @@ untar it into a known location.
Once setup, you can build `emmett.jar` by specifying the path to `ocamljava`
installation.

vprobe-toolkit/ $ ./configure --with-ocamljava=/path/to/ocamljava/install/dir
vprobe-toolkit/ $ make
vprobe-toolkit/ $ [sudo] make install
vprobe-toolkit $ ./configure --with-ocamljava=/path/to/ocamljava/install/dir
vprobe-toolkit $ make
vprobe-toolkit $ [sudo] make install


[1]:http://communities.vmware.com/community/vmtn/developer/forums/vprobes
[2]:http://www.vmware.com/products/workstation/
[3]:http://www.vmware.com/products/fusion/

0 comments on commit 816395a

Please sign in to comment.