Subject: [PATCH v4 00/14] Trace2 tracing facility

From: "Jeff Hostetler via GitGitGadget" <[email-masked]>
Date: Wed, 30 Jan 2019 12:56:20 -0800 (PST)

Sorry to spam the list, but here is V4. After building V3 on 3 platforms
without error and submitting, the compilers on platforms 4 and 5 complained
about a variable declaration. (sigh) [] fix declaration after first
statement [] add -DNO_UNIX_SOCKETS to BASIC_CFLAGS when NO_UNIX_SOCKETS is
defined in the Makefile.

----------------------------------------------------------------------------

V3 addresses: [] re-fix the trace2 tests using an inline environment
variable rather than exporting and unsetting. [] overhaul the design
document to include prototype declarations and more file format information.
[] incorporate most of the suggestions from clang-format. [] add ability to
trace to a unix domain socket. [] added forward declarations suggested by
Ramsay. [] rebased onto current master to fixup conflict with
sb/submodule-recursive-fetch-gets-the-tip that was merged yesterday.

----------------------------------------------------------------------------

V2 addresses: [] "jh/trace2" bad interaction with "js/vsts-ci" in "pu". []
coccinelle warnings in trace2/tr2_tgt_perf.c reported during CI testing.

----------------------------------------------------------------------------

This patch series contains a greatly refactored version of my original
Trace2 series [1] from August 2018.

A new design doc in Documentation/technical/api-trace2.txt (in the first
commit) explains the relationship of Trace2 to the current tracing facility.
Calls to the current tracing facility have not been changed, rather new
trace2 calls have been added so that both continue to work in parallel for
the time being.

[1] https://public-inbox.org/git/[email-masked]/

Cc: [email-masked]: [email-masked]: [email-masked]

Derrick Stolee (1):
  pack-objects: add trace2 regions

Jeff Hostetler (13):
  trace2: Documentation/technical/api-trace2.txt
  trace2: create new combined trace facility
  trace2: collect platform-specific process information
  trace2:data: add trace2 regions to wt-status
  trace2:data: add editor/pager child classification
  trace2:data: add trace2 sub-process classification
  trace2:data: add trace2 transport child classification
  trace2:data: add trace2 hook classification
  trace2:data: add trace2 instrumentation to index read/write
  trace2:data: add subverb to checkout command
  trace2:data: add subverb to reset command
  trace2:data: add subverb for rebase
  trace2: t/helper/test-trace2, t0210.sh, t0211.sh, t0212.sh

 Documentation/technical/api-trace2.txt | 1347 ++++++++++++++++++++++++
 Makefile                               |   15 +-
 builtin/am.c                           |    1 +
 builtin/checkout.c                     |    7 +
 builtin/pack-objects.c                 |   16 +-
 builtin/rebase.c                       |   17 +
 builtin/receive-pack.c                 |    4 +
 builtin/reset.c                        |    6 +
 builtin/submodule--helper.c            |    9 +-
 builtin/worktree.c                     |    1 +
 cache.h                                |    1 +
 common-main.c                          |   13 +-
 compat/mingw.c                         |   11 +-
 compat/mingw.h                         |    3 +-
 compat/win32/ancestry.c                |  101 ++
 config.c                               |    2 +
 config.mak.uname                       |    2 +
 connect.c                              |    3 +
 editor.c                               |    1 +
 exec-cmd.c                             |    2 +
 git-compat-util.h                      |    7 +
 git.c                                  |   65 ++
 pager.c                                |    1 +
 read-cache.c                           |   51 +-
 remote-curl.c                          |    7 +
 repository.c                           |    2 +
 repository.h                           |    3 +
 run-command.c                          |   59 +-
 run-command.h                          |   13 +-
 sequencer.c                            |    2 +
 sh-i18n--envsubst.c                    |    3 +
 sub-process.c                          |    1 +
 submodule.c                            |   11 +-
 t/helper/test-parse-options.c          |    3 +
 t/helper/test-tool.c                   |    4 +
 t/helper/test-tool.h                   |    1 +
 t/helper/test-trace2.c                 |  274 +++++
 t/t0001-init.sh                        |    1 +
 t/t0210-trace2-normal.sh               |  135 +++
 t/t0210/scrub_normal.perl              |   48 +
 t/t0211-trace2-perf.sh                 |  153 +++
 t/t0211/scrub_perf.perl                |   76 ++
 t/t0212-trace2-event.sh                |  234 ++++
 t/t0212/parse_events.perl              |  251 +++++
 trace2.c                               |  807 ++++++++++++++
 trace2.h                               |  380 +++++++
 trace2/tr2_cfg.c                       |   90 ++
 trace2/tr2_cfg.h                       |   19 +
 trace2/tr2_dst.c                       |  197 ++++
 trace2/tr2_dst.h                       |   36 +
 trace2/tr2_sid.c                       |   67 ++
 trace2/tr2_sid.h                       |   18 +
 trace2/tr2_tbuf.c                      |   32 +
 trace2/tr2_tbuf.h                      |   23 +
 trace2/tr2_tgt.h                       |  131 +++
 trace2/tr2_tgt_event.c                 |  590 +++++++++++
 trace2/tr2_tgt_normal.c                |  325 ++++++
 trace2/tr2_tgt_perf.c                  |  536 ++++++++++
 trace2/tr2_tls.c                       |  164 +++
 trace2/tr2_tls.h                       |   97 ++
 trace2/tr2_verb.c                      |   30 +
 trace2/tr2_verb.h                      |   24 +
 transport-helper.c                     |    2 +
 transport.c                            |    1 +
 usage.c                                |   31 +
 wt-status.c                            |   24 +-
 66 files changed, 6569 insertions(+), 22 deletions(-)
 create mode 100644 Documentation/technical/api-trace2.txt
 create mode 100644 compat/win32/ancestry.c
 create mode 100644 t/helper/test-trace2.c
 create mode 100755 t/t0210-trace2-normal.sh
 create mode 100644 t/t0210/scrub_normal.perl
 create mode 100755 t/t0211-trace2-perf.sh
 create mode 100644 t/t0211/scrub_perf.perl
 create mode 100755 t/t0212-trace2-event.sh
 create mode 100644 t/t0212/parse_events.perl
 create mode 100644 trace2.c
 create mode 100644 trace2.h
 create mode 100644 trace2/tr2_cfg.c
 create mode 100644 trace2/tr2_cfg.h
 create mode 100644 trace2/tr2_dst.c
 create mode 100644 trace2/tr2_dst.h
 create mode 100644 trace2/tr2_sid.c
 create mode 100644 trace2/tr2_sid.h
 create mode 100644 trace2/tr2_tbuf.c
 create mode 100644 trace2/tr2_tbuf.h
 create mode 100644 trace2/tr2_tgt.h
 create mode 100644 trace2/tr2_tgt_event.c
 create mode 100644 trace2/tr2_tgt_normal.c
 create mode 100644 trace2/tr2_tgt_perf.c
 create mode 100644 trace2/tr2_tls.c
 create mode 100644 trace2/tr2_tls.h
 create mode 100644 trace2/tr2_verb.c
 create mode 100644 trace2/tr2_verb.h

base-commit: b5101f929789889c2e536d915698f58d5c5c6b7a
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-108%2Fjeffhostetler%2Fcore-trace2-2019-v0-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-108/jeffhostetler/core-trace2-2019-v0-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/108

Range-diff vs v3:

  1:  60b56d6a8f =  1:  60b56d6a8f trace2: Documentation/technical/api-trace2.txt
  2:  bfe2fe0bbe !  2:  8c9687830e trace2: create new combined trace facility
     @@ -52,6 +52,17 @@
       LIB_OBJS += trailer.o
       LIB_OBJS += transport.o
       LIB_OBJS += transport-helper.o
     +@@
     + 	LIB_OBJS += compat/inet_pton.o
     + 	BASIC_CFLAGS += -DNO_INET_PTON
     + endif
     +-ifndef NO_UNIX_SOCKETS
     ++ifdef NO_UNIX_SOCKETS
     ++	BASIC_CFLAGS += -DNO_UNIX_SOCKETS
     ++else
     + 	LIB_OBJS += unix-socket.o
     + 	PROGRAM_OBJS += credential-cache.o
     + 	PROGRAM_OBJS += credential-cache--daemon.o
      
       diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
       --- a/builtin/submodule--helper.c
     @@ -2154,6 +2165,8 @@
      +
      +void tr2_dst_write_line(struct tr2_dst *dst, struct strbuf *buf_line)
      +{
     ++	int fd = tr2_dst_get_trace_fd(dst);
     ++
      +	strbuf_complete_line(buf_line); /* ensure final NL on buffer */
      +
      +	/*
     @@ -2171,9 +2184,6 @@
      +	 *
      +	 * If we get an IO error, just close the trace dst.
      +	 */
     -+
     -+	int fd = tr2_dst_get_trace_fd(dst);
     -+
      +	if (write(fd, buf_line->buf, buf_line->len) >= 0)
      +		return;
      +
  3:  e8b8226640 =  3:  6167aba76c trace2: collect platform-specific process information
  4:  0d59a6f2eb =  4:  3624c6cbd9 trace2:data: add trace2 regions to wt-status
  5:  2513091f77 =  5:  638fdb294f trace2:data: add editor/pager child classification
  6:  785f6f866e =  6:  f4f0453e6b trace2:data: add trace2 sub-process classification
  7:  b7e6644f4b =  7:  660b83c453 trace2:data: add trace2 transport child classification
  8:  52aace533b =  8:  ab26888126 trace2:data: add trace2 hook classification
  9:  a2bcc6fd28 =  9:  87a73af338 trace2:data: add trace2 instrumentation to index read/write
 10:  d508322638 = 10:  be707ea960 pack-objects: add trace2 regions
 11:  33e431be88 = 11:  b4c8ff53dd trace2:data: add subverb to checkout command
 12:  e46e92bc7c = 12:  ed1d612006 trace2:data: add subverb to reset command
 13:  0a05e15978 = 13:  4f55f33624 trace2:data: add subverb for rebase
 14:  aeaf990b1b = 14:  8d47cd71ed trace2: t/helper/test-trace2, t0210.sh, t0211.sh, t0212.sh

-- 
gitgitgadget