[Qemu-commits] [qemu/qemu] c72e3e: trace: fix simpletrace doc mismerge

[Peter Maydell]

  Branch: refs/heads/staging
  Home:   https://github.com/qemu/qemu
  Commit: c72e3e48420864af6c688ae6b9bc6f159c916598
      
https://github.com/qemu/qemu/commit/c72e3e48420864af6c688ae6b9bc6f159c916598
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/tracing.txt

  Log Message:
  -----------
  trace: fix simpletrace doc mismerge

The simpletrace documentation section was accidentally split when the
ftrace section was introduced. Move the simpletrace-specific
documentation back into the simpletrace section.

Fixes: e64dd5efb2c6d522a3bc9d096cd49a4e53f0ae10 ("trace: document ftrace 
backend")
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20201216160923.722894-2-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: e50caf4a5c0cb8d478e0c80b11d5a8a9306a89fd
      
https://github.com/qemu/qemu/commit/e50caf4a5c0cb8d478e0c80b11d5a8a9306a89fd
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/index.rst
    A docs/devel/tracing.rst
    R docs/devel/tracing.txt

  Log Message:
  -----------
  tracing: convert documentation to rST

This is a simple rST conversion of the documentation.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20201216160923.722894-3-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 7e46d5f317b3f792b449d8f875c5c21ee423d4ea
      
https://github.com/qemu/qemu/commit/7e46d5f317b3f792b449d8f875c5c21ee423d4ea
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/tracing.rst

  Log Message:
  -----------
  trace: recommend "log" backend for getting started with tracing

The "simple" backend is actually more complicated to use than the "log"
backend. Update the quickstart documentation to feature the "log"
backend instead of the "simple" backend.

Suggested-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20201216160923.722894-4-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 9f4e519fd7acbdb027d22e13e4f1cd8e79969dec
      
https://github.com/qemu/qemu/commit/9f4e519fd7acbdb027d22e13e4f1cd8e79969dec
  Author: Laurent Vivier <lvivier@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M scripts/tracetool/format/log_stap.py

  Log Message:
  -----------
  tracetool: fix "PRI" macro decoding

macro is not reset after use, so the format decoded is always the
one of the first "PRI" in the format string.

For instance:

  vhost_vdpa_set_config(void *dev, uint32_t offset, uint32_t size, \
                        uint32_t flags) "dev: %p offset: %"PRIu32" \
                        size: %"PRIu32" flags: 0x%"PRIx32

generates:

  printf("%d@%d vhost_vdpa_set_config dev: %p offset: %u size: %u \
          flags: 0x%u\n", pid(), gettimeofday_ns(), dev, offset, \
          size, flags)

for the "flags" parameter, we can see a "0x%u" rather than a "0x%x"
because the first macro was "PRIu32" (for offset).

In the loop, macro becomes "PRIu32PRIu32PRIx32", and c_macro_to_format()
returns always macro[3] ('u' in this case). This patch resets macro after
the format has been decoded.

Signed-off-by: Laurent Vivier <lvivier@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-id: 20210105191721.120463-3-lvivier@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 09612de7e9adbe9666a8fa4cc60bab0a29a68ed1
      
https://github.com/qemu/qemu/commit/09612de7e9adbe9666a8fa4cc60bab0a29a68ed1
  Author: Daniel P. Berrangé <berrange@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M scripts/tracetool/format/log_stap.py

  Log Message:
  -----------
  tracetool: also strip %l and %ll from systemtap format strings

All variables are 64-bit and so %l / %ll are not required, and the
latter is actually invalid:

  $ sudo stap -e 'probe begin{printf ("BEGIN")}'  -I .
  parse error: invalid or missing conversion specifier
          saw: operator ',' at ./qemu-system-x86_64-log.stp:15118:101
       source:     printf("%d@%d vhost_vdpa_set_log_base dev: %p base: 0x%x 
size: %llu
refcnt: %d fd: %d log: %p\n", pid(), gettimeofday_ns(), dev, base, size, 
refcnt, fd, log)

                       ^

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Laurent Vivier <lvivier@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Tested-by: Laurent Vivier <lvivier@redhat.com>
Message-id: 20210106130239.1004729-1-berrange@redhat.com

[Fixed "simiarly" typo found by Laurent Vivier <lvivier@redhat.com>
--Stefan]

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 0572d6cd29d6434de166ce67a29fc8ff64777218
      
https://github.com/qemu/qemu/commit/0572d6cd29d6434de166ce67a29fc8ff64777218
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M meson.build
    M trace/meson.build

  Log Message:
  -----------
  trace: add meson custom_target() depend_files for tracetool

Re-generate tracetool output when the tracetool source code changes. Use
the same approach as qapi_gen_depends and introduce a tracetool_depends
files list so meson is aware of the dependencies.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20210125110958.214017-1-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 651d588f030097c4950331f8fffb9d442f89ba11
      
https://github.com/qemu/qemu/commit/651d588f030097c4950331f8fffb9d442f89ba11
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M include/qemu/error-report.h
    M softmmu/vl.c
    M util/qemu-error.c

  Log Message:
  -----------
  error: rename error_with_timestamp to message_with_timestamp

The -msg timestamp=on|off option controls whether a timestamp is printed
with error_report() messages. The "-msg" name suggests that this option
has a wider effect than just error_report(). The next patch extends it
to the 'log' trace backend, so rename the variable from
error_with_timestamp to message_with_timestamp.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Tested-by: BALATON Zoltan <balaton@eik.bme.hu>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210125113507.224287-2-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 418ed14268f797a5142b60cd557cd598eb548c66
      
https://github.com/qemu/qemu/commit/418ed14268f797a5142b60cd557cd598eb548c66
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/tracing.rst
    M scripts/tracetool/backend/log.py

  Log Message:
  -----------
  trace: make the 'log' backend timestamp configurable

Timestamps in tracing output can be distracting. Make it possible to
control tid/timestamp printing with -msg timestamp=on|off. The default
is no tid/timestamps. Previously they were always printed.

Suggested-by: BALATON Zoltan <balaton@eik.bme.hu>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Tested-by: BALATON Zoltan <balaton@eik.bme.hu>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210125113507.224287-3-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: c6e93c9d62c47d628d993db482839a4fd38d603f
      
https://github.com/qemu/qemu/commit/c6e93c9d62c47d628d993db482839a4fd38d603f
  Author: Volker Rümelin <vr_qemu@t-online.de>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M scripts/simpletrace.py

  Log Message:
  -----------
  simpletrace: build() missing 2 required positional arguments

Commit 4e66c9ef64 "tracetool: add input filename and line number to
Event" forgot to add a line number and a filename argument at one
build method call site.

Traceback (most recent call last):
  File "./scripts/simpletrace.py", line 261, in <module>
    run(Formatter())
  File "./scripts/simpletrace.py", line 236, in run
    process(events, sys.argv[2], analyzer, read_header=read_header)
  File "./scripts/simpletrace.py", line 177, in process
    dropped_event =
      Event.build("Dropped_Event(uint64_t num_events_dropped)")
TypeError: build() missing 2 required positional arguments:
  'lineno' and 'filename'

Add the missing arguments.

Signed-off-by: Volker Rümelin <vr_qemu@t-online.de>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-id: 20210131173415.3392-1-vr_qemu@t-online.de
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 3faf22ef4465d064617dee524c97afa8d4400d9c
      
https://github.com/qemu/qemu/commit/3faf22ef4465d064617dee524c97afa8d4400d9c
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/tracing.rst

  Log Message:
  -----------
  trace: document how to specify multiple --trace patterns

It is possible to repeat the --trace option to specify multiple
patterns. This may be preferrable to users who do not want to create a
file with a list of patterns.

Suggested-by: BALATON Zoltan <balaton@eik.bme.hu>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210112165859.225534-2-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: 0dfb3ca73c54fc105ab78e37e31ab05bed1360aa
      
https://github.com/qemu/qemu/commit/0dfb3ca73c54fc105ab78e37e31ab05bed1360aa
  Author: Stefan Hajnoczi <stefanha@redhat.com>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/tracing.rst

  Log Message:
  -----------
  trace: update docs with meson build information

The documentation still refers to the makefile and the old sub-directory
layout. Meson works differently: tracetool output is placed into the
builddir with mangled filenames like <builddir>/trace/trace-accel_kvm.h
for the accel/kvm/ trace.h definition.

This meson setup also requires a manually-created accel/kvm/trace.h file
that #includes the <builddir>/trace/trace-accel_kvm.h file. Document
this!

Reported-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20210112165859.225534-3-stefanha@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>


  Commit: cf7ca7d5b9faca13f1f8e3ea92cfb2f741eb0c0e
      
https://github.com/qemu/qemu/commit/cf7ca7d5b9faca13f1f8e3ea92cfb2f741eb0c0e
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2021-02-01 (Mon, 01 Feb 2021)

  Changed paths:
    M docs/devel/index.rst
    A docs/devel/tracing.rst
    R docs/devel/tracing.txt
    M include/qemu/error-report.h
    M meson.build
    M scripts/simpletrace.py
    M scripts/tracetool/backend/log.py
    M scripts/tracetool/format/log_stap.py
    M softmmu/vl.c
    M trace/meson.build
    M util/qemu-error.c

  Log Message:
  -----------
  Merge remote-tracking branch 
'remotes/stefanha-gitlab/tags/tracing-pull-request' into staging

Pull request

# gpg: Signature made Mon 01 Feb 2021 15:46:52 GMT
# gpg:                using RSA key 8695A8BFD3F97CDAAC35775A9CA4ABB381AB73C8
# gpg: Good signature from "Stefan Hajnoczi <stefanha@redhat.com>" [full]
# gpg:                 aka "Stefan Hajnoczi <stefanha@gmail.com>" [full]
# Primary key fingerprint: 8695 A8BF D3F9 7CDA AC35  775A 9CA4 ABB3 81AB 73C8

* remotes/stefanha-gitlab/tags/tracing-pull-request:
  trace: update docs with meson build information
  trace: document how to specify multiple --trace patterns
  simpletrace: build() missing 2 required positional arguments
  trace: make the 'log' backend timestamp configurable
  error: rename error_with_timestamp to message_with_timestamp
  trace: add meson custom_target() depend_files for tracetool
  tracetool: also strip %l and %ll from systemtap format strings
  tracetool: fix "PRI" macro decoding
  trace: recommend "log" backend for getting started with tracing
  tracing: convert documentation to rST
  trace: fix simpletrace doc mismerge

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>


Compare: https://github.com/qemu/qemu/compare/74208cd252c5...cf7ca7d5b9fa