qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Stefan Hajnoczi <stefanha@redhat.com>
To: "Daniel P. Berrangé" <berrange@redhat.com>
Cc: Mads Ynddal <mads@ynddal.dk>,
	qemu-devel@nongnu.org, John Snow <jsnow@redhat.com>,
	Cleber Rosa <crosa@redhat.com>
Subject: Re: [PATCH v4 12/14] simpletrace: added simplified Analyzer2 class
Date: Wed, 20 Sep 2023 16:21:55 -0400	[thread overview]
Message-ID: <20230920202155.GK1094271@fedora> (raw)
In-Reply-To: <ZPg+/DwZQOVeYVgz@redhat.com>

[-- Attachment #1: Type: text/plain, Size: 2353 bytes --]

On Wed, Sep 06, 2023 at 09:57:32AM +0100, Daniel P. Berrangé wrote:
> On Wed, Sep 06, 2023 at 10:32:14AM +0200, Mads Ynddal wrote:
> > 
> > > AFAIK, we don't consider simpletrace.py python code to be a
> > > supported public API, just a command line tool.
> > > 
> > > IOW, we can change the python code at will, as long as the
> > > command line doesn't alter its behaviour. Thus I don't see
> > > a need to add new classes, just change the existing ones.
> > > 
> > > 
> > > With regards,
> > > Daniel
> > > -- 
> > > |: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
> > > |: https://libvirt.org         -o-            https://fstop138.berrange.com :|
> > > |: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
> > > 
> > 
> > This was based on feedback from Stefan in v2. I don't have strong opinions
> > about the one or the other. But now that the work has already been done,
> > I'd think the easiest would be to follow-through on the two versions.
> > 
> > https://lore.kernel.org/qemu-devel/20230504180326.GB581920@fedora/
> 
> I don't really agree with that feedback. We never document simpletrace.py
> as being a public facing Python API, only its usage as a CLI tool. It is
> also never installed into any Python library path, nor packaged as a PyPI
> module AFAIK.
> 
> If someone is none the less importing simpletrace.py from their app
> then they should copy the file wholesale into that code and take the
> responsibility for their usage.
> 
> I don't think QEMU should take on the burden of maintaining API
> compatibility for something we have never presented as a public API.

I wrote about the simpletrace API here in 2011:
http://blog.vmsplice.net/2011/03/how-to-write-trace-analysis-scripts-for.html

It was intended as an API and I don't think we should break people's
scripts unless there is a strong reason.

I don't know how many users there are, but it feels wrong to break
existing scripts without a strong reason to do so.

Stefan

> 
> With regards,
> Daniel
> -- 
> |: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
> |: https://libvirt.org         -o-            https://fstop138.berrange.com :|
> |: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

  reply	other threads:[~2023-09-20 20:22 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <CGME20230823085439eucas1p2d351b168833b9206cee2bbc8af9df1ac@eucas1p2.samsung.com>
2023-08-23  8:54 ` [PATCH v4 00/14] simpletrace: refactor and general improvements Mads Ynddal
2023-08-23  8:54   ` [PATCH v4 01/14] simpletrace: add __all__ to define public interface Mads Ynddal
2023-09-14 21:06     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 02/14] simpletrace: annotate magic constants from QEMU code Mads Ynddal
2023-09-14 21:09     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 03/14] simpletrace: improve parsing of sys.argv; fix files never closed Mads Ynddal
2023-09-20 18:57     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 04/14] simpletrace: changed naming of edict and idtoname to improve readability Mads Ynddal
2023-09-20 19:46     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 05/14] simpletrace: update code for Python 3.11 Mads Ynddal
2023-09-05 11:30     ` Philippe Mathieu-Daudé
2023-08-23  8:54   ` [PATCH v4 06/14] simpletrace: improved error handling on struct unpack Mads Ynddal
2023-09-05 11:34     ` Philippe Mathieu-Daudé
2023-09-20 19:49     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 07/14] simpletrace: define exception and add handling Mads Ynddal
2023-09-20 20:08     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 08/14] simpletrace: made Analyzer into context-manager Mads Ynddal
2023-09-20 20:11     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 09/14] simpletrace: refactor to separate responsibilities Mads Ynddal
2023-09-20 20:16     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 10/14] simpletrace: move logic of process into internal function Mads Ynddal
2023-09-20 20:16     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 11/14] simpletrace: move event processing to Analyzer class Mads Ynddal
2023-09-05 11:37     ` Philippe Mathieu-Daudé
2023-09-20 20:18     ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 12/14] simpletrace: added simplified Analyzer2 class Mads Ynddal
2023-09-05 12:19     ` Mads Ynddal
2023-09-05 12:42     ` Daniel P. Berrangé
2023-09-06  8:32       ` Mads Ynddal
2023-09-06  8:57         ` Daniel P. Berrangé
2023-09-20 20:21           ` Stefan Hajnoczi [this message]
2023-09-20 20:28     ` Stefan Hajnoczi
2023-09-26 10:40       ` Mads Ynddal
2023-08-23  8:54   ` [PATCH v4 13/14] MAINTAINERS: add maintainer of simpletrace.py Mads Ynddal
2023-09-05 11:38     ` Philippe Mathieu-Daudé
2023-09-20 20:37     ` Stefan Hajnoczi
2023-09-26 10:26       ` Mads Ynddal
2023-09-26 13:45         ` Stefan Hajnoczi
2023-08-23  8:54   ` [PATCH v4 14/14] scripts/analyse-locks-simpletrace.py: changed iteritems() to items() Mads Ynddal
2023-09-05 11:39     ` Philippe Mathieu-Daudé
2023-09-20 20:38     ` Stefan Hajnoczi
2023-09-05 10:46   ` [PATCH v4 00/14] simpletrace: refactor and general improvements Mads Ynddal
2023-09-20 20:39   ` Stefan Hajnoczi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230920202155.GK1094271@fedora \
    --to=stefanha@redhat.com \
    --cc=berrange@redhat.com \
    --cc=crosa@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=mads@ynddal.dk \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).