LTTng

h1. Google Summer of Code 2013

Google Summer of Code is a global program that offers students stipends to write code for open source projects. 

This would be the first year of participation for the LTTng project.

h1. Guidelines for students applying to GSoC

Here a few guidelines and advices for aspiring applicants to GSoC:

* Submit your application to Google by *May 3 2013 19:00 UTC*.

* Join the IRC #lttng channel on OFTC (irc://irc.oftc.net/lttng) to discuss your application and project ideas.

  Since IRC and the "mailing list":http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev are our usual means of communications, applicants who have shown initiative in communicating with the community will be favoured in the applications review.

* Subscribe to the lttng-dev "mailing list":http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev.

* Impress us! Try submitting a patch for simple issues such as typos, documentation improvements, simple bug fixes (a good starting point would be to look at the LTTng bug tracker: "issues":http://bugs.lttng.org/projects/lttng/issues?sort=priority%2Cid%3Adesc). Or you could try the whole toolchain on some of your personal projects and come up with a problematic situation (performance issue, ease of debugging, etc.) that *your* project idea could potentially solve.

* Don''t panic! Some portion of the LTTng project can be quite complex and technically challenging, we don''t expect applicants to be familiar with all the concepts behind the LTTng codebase.

* Additional tips for a successful application: "The DOs and DON’Ts of Google Summer of Code: Student Edition":http://google-opensource.blogspot.de/2011/03/dos-and-donts-of-google-summer-of-code.html

h1. Project Ideas

The following ideas are only a starting point for applicants. Feel free to submit your own idea to the community!

h2. Babeltrace python bindings

*Brief explanation*:

Provide Python bindings to the Babeltrace APIs to provide a complete CTF reading/writting infrastructure to Python programmers.

Most of the public Babeltrace API is currently mapped using SWIG. However, a more “Pythonic” set of wrapper classes will make trace reading and writing more accessible than using the current native API. The production and interpretation of CTF traces in a high level language such as Python will ease the development of custom trace analysis solutions. It will also provide a convenient language in which to implement trace conversion plugins.

*Expected results*: A set of "Pythonic" bindings, tests, code examples and documentation. 

*Complementary information*:

The Common Trace Format (CTF) specifies a trace format based on the requirements of the industry (through collaboration with the Multicore Association) and the Linux community.

Babeltrace is a trace conversion library that aims to provide a convenient to read and convert trace files between different formats.  It currently supports CTF, the trace format outputted by the LTTng 2.0 tracers, and provides the CTF reference implementation.

*Skill level*: Easy - Medium

*Prerequisite Knowledge*: Python, OO development

*Mentors*: Jérémie Galarneau (jgalar)

h2. Trace probe support in C++

*Brief explanation*:

The LTTng userspace tracing relies on the instrumentation of target applications with tracepoint probes. Currently, the only way to use tracepoints in C++ applications is by compiling a stand-alone C library linked to liblttng-ust which is then linked to the target C++ application. 

While this method is functional, it introduces significant development time overhead and confusion for new users. This project aims at making the UST tracepoint probe code compatible with C++ compilers to enable compilation of the providers within the application. The necessary modifications should not be too complex but are an excellent introductory project.

*Expected results*: Probe can be compiled in a C++ application. Examples and documentation of the usage of probes in C++.

*Complementary information*:

Issue #338

*Skill level*: Easy - Medium

*Prerequisite Knowledge*: C++ development, C development, build environments

*Mentors*: Jérémie Galarneau (jgalar)

h2. Development of an strace-like wrapper

*Brief explanation*:

The LTTng kernel tracer should provide all the functionality required to emulate the behaviour of the strace utility. The goal of this project is the development of an strace drop-in replacement based on the LTTng tracing toolchain that shall provide the user with the functionality of strace and the performance characteristics of the LTTng kernel tracer. This should ensure backward compatibility with tools based on the strace output format.

This should be implemented as a Babeltrace trace converter plug-in used in “live mode” -- an upcoming Babeltrace feature currently being developped by Julien Desfossez. The resulting plug-in will enable seamless interoperability between CTF and strace-based tools.

*Expected results*: A wrapper/script or an additional command line switch to the lttng binary mimicking strace behavior. Tests and documentation of the new functionality.

*Complementary information*:

Issue #15

*Skill level*: Medium

*Prerequisite Knowledge*:  C development, scripting

*Mentors*: Julien Desfossez (jdesfossez), David Goulet (dgoulet)

h2. Improvement of liblttng-ust-libc-wrapper''s coverage of libc''s functions

*Brief explanation*:

liblttng-ust-libc-wrapper is a library that currently provides a wrapper around libc to instrument malloc() and free() with UST tracepoint probes. This project aims to provide a full coverage of the standard libc functions.

This library is typically “LD_PRELOAD”-ed when debugging an application to override malloc() and free() symbols. The underlying libc symbol is then looked-up and called. The resulting trace can then be analyzed to identify memory allocation issues. Gaining a better libc coverage will provide LTTng users with even better debugging capabilities.

As an extension to this project, one could also develop a tool to automatically generate static tracepoints for arbitrary libraries from the header files.

*Expected results*: A patchset implementing instrumentation in libc functions. Trace samples of program with their libc completely instrumented. Documentation and tests.

*Skill level*: Easy - Hard

*Prerequisite Knowledge*: C development, parser knowledge, scripting

*Mentors*: Christian Babeux (cbab)

h2. Dynamic instrumentation support in UST

*Brief explanation*:

The current UST tracer relies on static tracepoint probes manually inserted in the traced application’s source code. This project aims at providing dynamic instrumentation capabilities in arbitrary applications.

The Dyninst project already provides a great API to dynamically modify code which may come in handy in this project. This is a great opportunity to initiate a collaboration between both projects.

*Expected results*: TBD (Depends on the proposed approach to dynamically instrument userspace applications)

*Skill level*: Hard

*Prerequisite Knowledge*: C++ development, C development, Assembly

*Mentors*: Christian Babeux (cbab), Yannick Brosseau (scientist)

h2. Android port

*Brief explanation*:

Port the LTTng infrastructure to the Android platform. The exact scope of this project will need to be reassessed based on the conclusions of the team currently working on this project as part of their undergrad project at École Polytechnique de Montréal.

This project presents a number of uncertain technical hurdles but some effort has already been made in most key areas.

* The userspace part of the LTTng project relies on glibc features not present in Bionic -- Google''s libc implementation used on Android.

  - Glibc is now available on Android thanks to the efforts made by the cyborgstack project.

* System V IPC mechanisms are heavily relied-upon.

  - The Ericsson port makes use of temporary files.

  - Glibc on Android should provide such mechanisms.

* Userspace RCU must be ported and tested on the Android platform.

  - Ported by Ericsson, not mainlined.

*Expected results*: A working port of the kernel or userspace tracer running on an Android device.

*Complementary information*:

http://lists.lttng.org/pipermail/lttng-dev/2012-February/017626.html

*Skill level*: Hard

*Prerequisite Knowledge*: C development, kernel internals, Android development

*Mentors*: Christian Babeux (cbab), Jérémie Galarneau (jgalar), Yannick Brosseau (scientist)

h2. Instrumenting Open Source projects using UST

*Brief explanation*:

This project has a broad goal of instrumenting popular open source applications that have demanding performance constraints and that would benefit from using LTTng''s tracing infrastructure. Wine is just one example of such a project. Perhaps other projects could benefit from LTTng and provide a great test-bed that will drive wider adoption of LTTng in open source projects.

This project represents a great opportunity to instigate a collaboration between multiple open source projects. The intern will get the chance to experience the complete process of understanding an open source project''s codebase and contributing to its evolution.

*Expected results*: A patchset instrumenting the proposed open source project.

*Skill level*: Easy - Hard

*Prerequisite Knowledge*: Project dependent

*Mentors*: Yannick Brosseau (scientist)