libtracececmd 1.0.0

From:		Steven Rostedt <rostedt-AT-goodmis.org>
To:		LKML <linux-kernel-AT-vger.kernel.org>, "linux-trace-devel-AT-vger.kernel.org" <linux-trace-devel-AT-vger.kernel.org>, Linux-trace Users <linux-trace-users-AT-vger.kernel.org>
Subject:		[ANNOUNCE] libtracececmd 1.0.0
Date:		Sat, 10 Apr 2021 09:54:31 -0400
Message-ID:		<20210410095431.2935816f@oasis.local.home>
Cc:		Zamir SUN <sztsian-AT-gmail.com>, Arnaldo Carvalho de Melo <acme-AT-kernel.org>, Jiri Olsa <jolsa-AT-redhat.com>, zsun-AT-redhat.com, Vitaly Chikunov <vt-AT-altlinux.org>, Tzvetomir Stoyanov <tstoyanov-AT-vmware.com>, Yordan Karadzhov <ykaradzhov-AT-vmware.com>, Ben Hutchings <ben-AT-decadent.org.uk>, Sudip Mukherjee <sudipm.mukherjee-AT-gmail.com>, Tony Jones <tonyj-AT-suse.de>, John Kacur <jkacur-AT-redhat.com>, Clark Williams <williams-AT-redhat.com>, Al Stone <ahs3-AT-debian.org>, Mauro Carvalho Chehab <mchehab+huawei-AT-kernel.org>, Jes Sorensen <jes.sorensen-AT-gmail.com>
Archive-link:		Article

This is the initial official release of libtracecmd 1.0.0. This is
needed by KernelShark in order to be in a stand alone repository:

  https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-sha...

All new development for KernelShark now takes place in the above
repository, which will depend on this library. The code that exists
currently in the trace-cmd.git repository for KernelShark will be
removed.

This library lives (and will always live) with the trace-cmd repository.

  https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd....
  https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd....

The purpose of his library is to be able to create and read the
trace.dat file that trace-cmd produces. It may also include
functionality to start trace recordings and other features provided by
trace-cmd itself. But for this release, it only contains the bare
necessities that a stand alone KernelShark requires.

The current API for this release are:

 - APIs to open and close a trace.dat file
    tracecmd_open()
    tracecmd_open_head()
    tracecmd_open_fd()
    tracecmd_close()

 - APIs to initialize and read tracing records from a trace.dat file
    tracecmd_init_data()
    tracecmd_read_cpu_first()
    tracecmd_read_data()
    tracecmd_read_at()
    tracecmd_free_record()

 - APIs to retrieve the libtracevent tep handler
    tracecmd_get_tep()

 - APIs to manage host and guest data mappings
    tracecmd_get_traceid()
    tracecmd_get_guest_cpumap()

 - APIs to manage the different instances existing in a trace.dat file
    tracecmd_buffer_instances()
    tracecmd_buffer_instance_name()
    tracecmd_buffer_instance_handle()

Many more APIs will come in later releases.

Enjoy!

-- Steve