Commit 7d48cf81 authored by Peter Maydell's avatar Peter Maydell
Browse files

Merge remote-tracking branch 'remotes/stefanha/tags/tracing-pull-request' into staging 



Pull request

Fixes for inconsistencies in the trace event format strings, broken
trace_event_get_state() usage, and handle_qmp_command() fix.

# gpg: Signature made Tue 01 Aug 2017 14:16:05 BST
# gpg:                using RSA key 0x9CA4ABB381AB73C8
# gpg: Good signature from "Stefan Hajnoczi <stefanha@redhat.com>"
# gpg:                 aka "Stefan Hajnoczi <stefanha@gmail.com>"
# Primary key fingerprint: 8695 A8BF D3F9 7CDA AC35  775A 9CA4 ABB3 81AB 73C8

* remotes/stefanha/tags/tracing-pull-request:
  monitor: Reduce handle_qmp_command() tracing overhead
  trace-events: fix code style: print 0x before hex numbers
  checkpatch: check trace-events code style
  trace-events: fix code style: %# -> 0x%
  coding_style: add point about 0x in trace-events
  trace: add trace_event_get_state_backends()
  trace: add TRACE_<event>_BACKEND_DSTATE()
  trace: ensure unique function / variable names per .stp file
  trace: ensure .stp files are rebuilt if trace tool source changes

Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
parents 5619c179 bd6952a3

CODING_STYLE

+35 −0
Original line number Diff line number Diff line
@@ -123,3 +123,38 @@ We use traditional C-style /* */ comments and avoid // comments. 


Rationale: The // form is valid in C99, so this is purely a matter of

consistency of style. The checkpatch script will warn you about this.



8. trace-events style



8.1 0x prefix



In trace-events files, use a '0x' prefix to specify hex numbers, as in:



some_trace(unsigned x, uint64_t y) "x 0x%x y 0x" PRIx64



An exception is made for groups of numbers that are hexadecimal by

convention and separated by the symbols '.', '/', ':', or ' ' (such as

PCI bus id):



another_trace(int cssid, int ssid, int dev_num) "bus id: %x.%x.%04x"



However, you can use '0x' for such groups if you want. Anyway, be sure that

it is obvious that numbers are in hex, ex.:



data_dump(uint8_t c1, uint8_t c2, uint8_t c3) "bytes (in hex): %02x %02x %02x"



Rationale: hex numbers are hard to read in logs when there is no 0x prefix,

especially when (occasionally) the representation doesn't contain any letters

and especially in one line with other decimal numbers. Number groups are allowed

to not use '0x' because for some things notations like %x.%x.%x are used not

only in Qemu. Also dumping raw data bytes with '0x' is less readable.



8.2 '#' printf flag



Do not use printf flag '#', like '%#x'.



Rationale: there are two ways to add a '0x' prefix to printed number: '0x%...'

and '%#...'. For consistency the only one way should be used. Arguments for

'0x%' are:

 - it is more popular

 - '%#' omits the 0x for the value 0 which makes output inconsistent

Makefile.target

+6 −3
Original line number Diff line number Diff line
@@ -48,7 +48,10 @@ else 
TARGET_TYPE=system

endif



$(QEMU_PROG).stp-installed: $(BUILD_DIR)/trace-events-all

tracetool-y = $(SRC_PATH)/scripts/tracetool.py

tracetool-y += $(shell find $(SRC_PATH)/scripts/tracetool -name "*.py")



$(QEMU_PROG).stp-installed: $(BUILD_DIR)/trace-events-all $(tracetool-y)

	$(call quiet-command,$(TRACETOOL) \

		--group=all \

		--format=stap \
@@ -58,7 +61,7 @@ $(QEMU_PROG).stp-installed: $(BUILD_DIR)/trace-events-all 
		--target-type=$(TARGET_TYPE) \

		$< > $@,"GEN","$(TARGET_DIR)$(QEMU_PROG).stp-installed")



$(QEMU_PROG).stp: $(BUILD_DIR)/trace-events-all

$(QEMU_PROG).stp: $(BUILD_DIR)/trace-events-all $(tracetool-y)

	$(call quiet-command,$(TRACETOOL) \

		--group=all \

		--format=stap \
@@ -68,7 +71,7 @@ $(QEMU_PROG).stp: $(BUILD_DIR)/trace-events-all 
		--target-type=$(TARGET_TYPE) \

		$< > $@,"GEN","$(TARGET_DIR)$(QEMU_PROG).stp")



$(QEMU_PROG)-simpletrace.stp: $(BUILD_DIR)/trace-events-all

$(QEMU_PROG)-simpletrace.stp: $(BUILD_DIR)/trace-events-all $(tracetool-y)

	$(call quiet-command,$(TRACETOOL) \

		--group=all \

		--format=simpletrace-stap \

accel/tcg/trace-events

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 
# cpu-exec.c

disable exec_tb(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR

disable exec_tb_nocache(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR

disable exec_tb_exit(void *last_tb, unsigned int flags) "tb:%p flags=%x"

disable exec_tb_exit(void *last_tb, unsigned int flags) "tb:%p flags=0x%x"



# translate-all.c

translate_block(void *tb, uintptr_t pc, uint8_t *tb_code) "tb:%p, pc:0x%"PRIxPTR", tb_code:%p"

audio/trace-events

+2 −2
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
# audio/alsaaudio.c

alsa_revents(int revents) "revents = %d"

alsa_pollout(int i, int fd) "i = %d fd = %d"

alsa_set_handler(int events, int index, int fd, int err) "events=%#x index=%d fd=%d err=%d"

alsa_set_handler(int events, int index, int fd, int err) "events=0x%x index=%d fd=%d err=%d"

alsa_wrote_zero(int len) "Failed to write %d frames (wrote zero)"

alsa_read_zero(long len) "Failed to read %ld frames (read zero)"

alsa_xrun_out(void) "Recovering from playback xrun"
@@ -13,5 +13,5 @@ alsa_resume_in(void) "Resuming suspended input stream" 
alsa_no_frames(int state) "No frames available and ALSA state is %d"



# audio/ossaudio.c

oss_version(int version) "OSS version = %#x"

oss_version(int version) "OSS version = 0x%x"

oss_invalid_available_size(int size, int bufsize) "Invalid available size, size=%d bufsize=%d"

block/trace-events

+14 −14
Original line number Diff line number Diff line 
# See docs/devel/tracing.txt for syntax documentation.



# block.c

bdrv_open_common(void *bs, const char *filename, int flags, const char *format_name) "bs %p filename \"%s\" flags %#x format_name \"%s\""

bdrv_open_common(void *bs, const char *filename, int flags, const char *format_name) "bs %p filename \"%s\" flags 0x%x format_name \"%s\""

bdrv_lock_medium(void *bs, bool locked) "bs %p locked %d"



# block/block-backend.c

blk_co_preadv(void *blk, void *bs, int64_t offset, unsigned int bytes, int flags) "blk %p bs %p offset %"PRId64" bytes %u flags %x"

blk_co_pwritev(void *blk, void *bs, int64_t offset, unsigned int bytes, int flags) "blk %p bs %p offset %"PRId64" bytes %u flags %x"

blk_co_preadv(void *blk, void *bs, int64_t offset, unsigned int bytes, int flags) "blk %p bs %p offset %"PRId64" bytes %u flags 0x%x"

blk_co_pwritev(void *blk, void *bs, int64_t offset, unsigned int bytes, int flags) "blk %p bs %p offset %"PRId64" bytes %u flags 0x%x"



# block/io.c

bdrv_co_readv(void *bs, int64_t sector_num, int nb_sector) "bs %p sector_num %"PRId64" nb_sectors %d"

bdrv_co_writev(void *bs, int64_t sector_num, int nb_sector) "bs %p sector_num %"PRId64" nb_sectors %d"

bdrv_co_pwrite_zeroes(void *bs, int64_t offset, int count, int flags) "bs %p offset %"PRId64" count %d flags %#x"

bdrv_co_pwrite_zeroes(void *bs, int64_t offset, int count, int flags) "bs %p offset %"PRId64" count %d flags 0x%x"

bdrv_co_do_copy_on_readv(void *bs, int64_t offset, unsigned int bytes, int64_t cluster_offset, unsigned int cluster_bytes) "bs %p offset %"PRId64" bytes %u cluster_offset %"PRId64" cluster_bytes %u"



# block/stream.c
@@ -54,19 +54,19 @@ paio_submit_co(int64_t offset, int count, int type) "offset %"PRId64" count %d t 
paio_submit(void *acb, void *opaque, int64_t offset, int count, int type) "acb %p opaque %p offset %"PRId64" count %d type %d"



# block/qcow2.c

qcow2_writev_start_req(void *co, int64_t offset, int bytes) "co %p offset %" PRIx64 " bytes %d"

qcow2_writev_start_req(void *co, int64_t offset, int bytes) "co %p offset 0x%" PRIx64 " bytes %d"

qcow2_writev_done_req(void *co, int ret) "co %p ret %d"

qcow2_writev_start_part(void *co) "co %p"

qcow2_writev_done_part(void *co, int cur_bytes) "co %p cur_bytes %d"

qcow2_writev_data(void *co, uint64_t offset) "co %p offset %" PRIx64

qcow2_pwrite_zeroes_start_req(void *co, int64_t offset, int count) "co %p offset %" PRIx64 " count %d"

qcow2_pwrite_zeroes(void *co, int64_t offset, int count) "co %p offset %" PRIx64 " count %d"

qcow2_writev_data(void *co, uint64_t offset) "co %p offset 0x%" PRIx64

qcow2_pwrite_zeroes_start_req(void *co, int64_t offset, int count) "co %p offset 0x%" PRIx64 " count %d"

qcow2_pwrite_zeroes(void *co, int64_t offset, int count) "co %p offset 0x%" PRIx64 " count %d"



# block/qcow2-cluster.c

qcow2_alloc_clusters_offset(void *co, uint64_t offset, int bytes) "co %p offset %" PRIx64 " bytes %d"

qcow2_handle_copied(void *co, uint64_t guest_offset, uint64_t host_offset, uint64_t bytes) "co %p guest_offset %" PRIx64 " host_offset %" PRIx64 " bytes %" PRIx64

qcow2_handle_alloc(void *co, uint64_t guest_offset, uint64_t host_offset, uint64_t bytes) "co %p guest_offset %" PRIx64 " host_offset %" PRIx64 " bytes %" PRIx64

qcow2_do_alloc_clusters_offset(void *co, uint64_t guest_offset, uint64_t host_offset, int nb_clusters) "co %p guest_offset %" PRIx64 " host_offset %" PRIx64 " nb_clusters %d"

qcow2_alloc_clusters_offset(void *co, uint64_t offset, int bytes) "co %p offset 0x%" PRIx64 " bytes %d"

qcow2_handle_copied(void *co, uint64_t guest_offset, uint64_t host_offset, uint64_t bytes) "co %p guest_offset 0x%" PRIx64 " host_offset 0x%" PRIx64 " bytes 0x%" PRIx64

qcow2_handle_alloc(void *co, uint64_t guest_offset, uint64_t host_offset, uint64_t bytes) "co %p guest_offset 0x%" PRIx64 " host_offset 0x%" PRIx64 " bytes 0x%" PRIx64

qcow2_do_alloc_clusters_offset(void *co, uint64_t guest_offset, uint64_t host_offset, int nb_clusters) "co %p guest_offset 0x%" PRIx64 " host_offset 0x%" PRIx64 " nb_clusters %d"

qcow2_cluster_alloc_phys(void *co) "co %p"

qcow2_cluster_link_l2(void *co, int nb_clusters) "co %p nb_clusters %d"
@@ -77,7 +77,7 @@ qcow2_l2_allocate_write_l1(void *bs, int l1_index) "bs %p l1_index %d" 
qcow2_l2_allocate_done(void *bs, int l1_index, int ret) "bs %p l1_index %d ret %d"



# block/qcow2-cache.c

qcow2_cache_get(void *co, int c, uint64_t offset, bool read_from_disk) "co %p is_l2_cache %d offset %" PRIx64 " read_from_disk %d"

qcow2_cache_get(void *co, int c, uint64_t offset, bool read_from_disk) "co %p is_l2_cache %d offset 0x%" PRIx64 " read_from_disk %d"

qcow2_cache_get_replace_entry(void *co, int c, int i) "co %p is_l2_cache %d index %d"

qcow2_cache_get_read(void *co, int c, int i) "co %p is_l2_cache %d index %d"

qcow2_cache_get_done(void *co, int c, int i) "co %p is_l2_cache %d index %d"
@@ -100,7 +100,7 @@ qed_need_check_timer_cb(void *s) "s %p" 
qed_start_need_check_timer(void *s) "s %p"

qed_cancel_need_check_timer(void *s) "s %p"

qed_aio_complete(void *s, void *acb, int ret) "s %p acb %p ret %d"

qed_aio_setup(void *s, void *acb, int64_t sector_num, int nb_sectors, void *opaque, int flags) "s %p acb %p sector_num %"PRId64" nb_sectors %d opaque %p flags %#x"

qed_aio_setup(void *s, void *acb, int64_t sector_num, int nb_sectors, void *opaque, int flags) "s %p acb %p sector_num %"PRId64" nb_sectors %d opaque %p flags 0x%x"

qed_aio_next_io(void *s, void *acb, int ret, uint64_t cur_pos) "s %p acb %p ret %d cur_pos %"PRIu64

qed_aio_read_data(void *s, void *acb, int ret, uint64_t offset, size_t len) "s %p acb %p ret %d offset %"PRIu64" len %zu"

qed_aio_write_data(void *s, void *acb, int ret, uint64_t offset, size_t len) "s %p acb %p ret %d offset %"PRIu64" len %zu"