• Namhyung Kim's avatar
    perf annotate-data: Copy back variable types after move · 1cfd01eb
    Namhyung Kim authored
    In some cases, compilers don't set the location expression in DWARF
    precisely.  For instance, it may assign a variable to a register after
    copying it from a different register.  Then it should use the register
    for the new type but still uses the old register.  This makes hard to
    track the type information properly.
    
    This is an example I found in __tcp_transmit_skb().  The first argument
    (sk) of this function is a pointer to sock and there's a variable (tp)
    for tcp_sock.
    
      static int __tcp_transmit_skb(struct sock *sk, struct sk_buff *skb,
      				int clone_it, gfp_t gfp_mask, u32 rcv_nxt)
      {
      	...
      	struct tcp_sock *tp;
    
      	BUG_ON(!skb || !tcp_skb_pcount(skb));
      	tp = tcp_sk(sk);
      	prior_wstamp = tp->tcp_wstamp_ns;
      	tp->tcp_wstamp_ns = max(tp->tcp_wstamp_ns, tp->tcp_clock_cache);
      	...
    
    So it basically calls tcp_sk(sk) to get the tcp_sock pointer from sk.
    But it turned out to be the same value because tcp_sock embeds sock as
    the first member.  The sk is located in reg5 (RDI) and tp is in reg3
    (RBX).  The offset of tcp_wstamp_ns is 0x748 and tcp_clock_cache is
    0x750.  So you need to use RBX (reg3) to access the fields in the
    tcp_sock.  But the code used RDI (reg5) as it has the same value.
    
      $ pahole --hex -C tcp_sock vmlinux | grep -e 748 -e 750
    	u64                tcp_wstamp_ns;        /* 0x748   0x8 */
    	u64                tcp_clock_cache;      /* 0x750   0x8 */
    
    And this is the disassembly of the part of the function.
    
      <__tcp_transmit_skb>:
      ...
      44:  mov    %rdi, %rbx
      47:  mov    0x748(%rdi), %rsi
      4e:  mov    0x750(%rdi), %rax
      55:  cmp    %rax, %rsi
    
    Because compiler put the debug info to RBX, it only knows RDI is a
    pointer to sock and accessing those two fields resulted in error
    due to offset being beyond the type size.
    
      -----------------------------------------------------------
      find data type for 0x748(reg5) at __tcp_transmit_skb+0x63
      CU for net/ipv4/tcp_output.c (die:0x817f543)
      frame base: cfa=0 fbreg=6
      scope: [1/1] (die:81aac3e)
      bb: [0 - 30]
      var [0] -0x98(stack) type='struct tcp_out_options' size=0x28 (die:0x81af3df)
      var [5] reg8 type='unsigned int' size=0x4 (die:0x8180ed6)
      var [5] reg2 type='unsigned int' size=0x4 (die:0x8180ed6)
      var [5] reg1 type='int' size=0x4 (die:0x818059e)
      var [5] reg4 type='struct sk_buff*' size=0x8 (die:0x8181360)
      var [5] reg5 type='struct sock*' size=0x8 (die:0x8181a0c)                   <<<--- the first argument ('sk' at %RDI)
      mov [19] reg8 -> -0xa8(stack) type='unsigned int' size=0x4 (die:0x8180ed6)
      mov [20] stack canary -> reg0
      mov [29] reg0 -> -0x30(stack) stack canary
      bb: [36 - 3e]
      mov [36] reg4 -> reg15 type='struct sk_buff*' size=0x8 (die:0x8181360)
      bb: [44 - 63]
      mov [44] reg5 -> reg3 type='struct sock*' size=0x8 (die:0x8181a0c)          <<<--- calling tcp_sk()
      var [47] reg3 type='struct tcp_sock*' size=0x8 (die:0x819eead)              <<<--- new variable ('tp' at %RBX)
      var [4e] reg4 type='unsigned long long' size=0x8 (die:0x8180edd)
      mov [58] reg4 -> -0xc0(stack) type='unsigned long long' size=0x8 (die:0x8180edd)
      chk [63] reg5 offset=0x748 ok=1 kind=1 (struct sock*) : offset bigger than size    <<<--- access with old variable
      final result: offset bigger than size
    
    While it's a fault in the compiler, we could work around this issue by
    using the type of new variable when it's copied directly.  So I've added
    copied_from field in the register state to track those direct register
    to register copies.  After that new register gets a new type and the old
    register still has the same type, it'll update (copy it back) the type
    of the old register.
    
    For example, if we can update type of reg5 at __tcp_transmit_skb+0x47,
    we can find the target type of the instruction at 0x63 like below:
    
      -----------------------------------------------------------
      find data type for 0x748(reg5) at __tcp_transmit_skb+0x63
      ...
      bb: [44 - 63]
      mov [44] reg5 -> reg3 type='struct sock*' size=0x8 (die:0x8181a0c)
      var [47] reg3 type='struct tcp_sock*' size=0x8 (die:0x819eead)
      var [47] copyback reg5 type='struct tcp_sock*' size=0x8 (die:0x819eead)     <<<--- here
      mov [47] 0x748(reg5) -> reg4 type='unsigned long long' size=0x8 (die:0x8180edd)
      mov [4e] 0x750(reg5) -> reg0 type='unsigned long long' size=0x8 (die:0x8180edd)
      mov [58] reg4 -> -0xc0(stack) type='unsigned long long' size=0x8 (die:0x8180edd)
      chk [63] reg5 offset=0x748 ok=1 kind=1 (struct tcp_sock*) : Good!           <<<--- new type
      found by insn track: 0x748(reg5) type-offset=0x748
      final result:  type='struct tcp_sock' size=0xa98 (die:0x819eeb2)
    Signed-off-by: default avatarNamhyung Kim <namhyung@kernel.org>
    Cc: Adrian Hunter <adrian.hunter@intel.com>
    Cc: Athira Rajeev <atrajeev@linux.vnet.ibm.com>
    Cc: Ian Rogers <irogers@google.com>
    Cc: Ingo Molnar <mingo@kernel.org>
    Cc: Jiri Olsa <jolsa@kernel.org>
    Cc: Kan Liang <kan.liang@linux.intel.com>
    Cc: Peter Zijlstra <peterz@infradead.org>
    Link: https://lore.kernel.org/r/20240821232628.353177-5-namhyung@kernel.orgSigned-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
    1cfd01eb
annotate-data.c 45.4 KB