---
name: "dtrace_tcp"
section: "4freebsd"
platform: "linux"
package: "freebsd-manpages"
version: "12.2-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/dtrace_tcp/4freebsd"
---

# dtrace\_tcp(4freebsd)

a DTrace provider for tracing events related to the tcp(4) protocol

## NAME

**dtrace\_tcp** – a DTrace provider for tracing events related to the [tcp(4)](/tcp/4.md) protocol

## SYNOPSIS

**tcp:::accept-established**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::accept-refused**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::connect-established**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::connect-refused**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::connect-request**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::receive**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::send**(*pktinfo\_t \**, *csinfo\_t \**, *ipinfo\_t \**, *tcpsinfo\_t \**, *tcpinfo\_t \**);

**tcp:::state-change**(*void \**, *csinfo\_t \**, *void \**, *tcpsinfo\_t \**, *void \**, *tcplsinfo\_t \**);

## DESCRIPTION

The DTrace **tcp** provider allows users to trace events in the [tcp(4)](/tcp/4.md) protocol implementation. This provider is similar to the [dtrace\_ip(4)](/dtrace_ip/4.md) and [dtrace\_udp(4)](/dtrace_udp/4.md) providers, but additionally contains probes corresponding to protocol events at a level higher than packet reception and transmission. All **tcp** probes except for **tcp:::state-change**() have the same number and type of arguments. The last three arguments are used to describe a TCP segment: the *ipinfo\_t* argument exposes the version-agnostic fields of the IP header, while the *tcpinfo\_t* argument exposes the TCP header, and the *tcpsinfo\_t* argument describes details of the corresponding TCP connection state, if any. Their fields are described in the ARGUMENTS section.

The **tcp:::accept-established**() probe fires when a remotely-initiated active TCP open succeeds. At this point the new connection is in the ESTABLISHED state, and the probe arguments expose the headers associated with the final ACK of the three-way handshake. The **tcp:::accept-refused**() probe fires when a SYN arrives on a port without a listening socket. The probe arguments expose the headers associated with the RST to be transmitted to the remote host in response to the SYN segment.

The **tcp:::connect-established**(), **tcp:::connect-refused**(), and **tcp:::connect-request**() probes are similar to the ‘accept’ probes, except that they correspond to locally-initiated TCP connections. The **tcp:::connect-established**() probe fires when the SYN-ACK segment of a three-way handshake is received from the remote host and a final ACK is prepared for transmission. This occurs immediately after the local connection state transitions from SYN-SENT to ESTABLISHED. The probe arguments describe the headers associated with the received SYN-ACK segment. The **tcp:::connect-refused**() probe fires when the local host receives a RST segment in response to a SYN segment, indicating that the remote host refused to open a connection. The probe arguments describe the IP and TCP headers associated with the received RST segment. The **tcp:::connect-request**() probe fires as the kernel prepares to transmit the initial SYN segment of a three-way handshake.

The **tcp:::send**() and **tcp:::receive**() probes fire when the host sends or receives a TCP packet, respectively. As with the [dtrace\_udp(4)](/dtrace_udp/4.md) provider, **tcp** probes fire only for packets sent by or to the local host; forwarded packets are handled in the IP layer and are only visible to the [dtrace\_ip(4)](/dtrace_ip/4.md) provider.

The **tcp:::state-change**() probe fires upon local TCP connection state transitions. Its first, third and fifth arguments are currently always NULL. Its last argument describes the from-state in the transition, and the to-state can be obtained from args\[3\]-\>tcps\_state.

## ARGUMENTS

The *pktinfo\_t* argument is currently unimplemented and is included for compatibility with other implementations of this provider. Its fields are:

- *uinptr\_t* *pkt\_addr*

  Always set to 0.

The *csinfo\_t* argument is currently unimplemented and is included for compatibility with other implementations of this provider. Its fields are:

- *uintptr\_t* *cs\_addr*

  Always set to 0.

- *uint64\_t* *cs\_cid*

  A pointer to the *struct* *inpcb* for this packet, or NULL.

- *pid\_t* *cs\_pid*

  Always set to 0.

The *ipinfo\_t* type is a version-agnostic representation of fields from an IP header. Its fields are described in the [dtrace\_ip(4)](/dtrace_ip/4.md) manual page.

The *tcpsinfo\_t* type is used to provide a stable representation of TCP connection state. Some **tcp** probes, such as **tcp:::accept-refused**(), fire in a context where there is no TCP connection; this argument is NULL in that case. Its fields are:

- *uintptr\_t* *tcps\_addr*

  The address of the corresponding TCP control block. This is currently a pointer to a *struct* *tcpcb*.

- *int* *tcps\_local*

  A boolean indicating whether the connection is local to the host. Currently unimplemented and always set to -1.

- *int* *tcps\_active*

  A boolean indicating whether the connection was initiated by the local host. Currently unimplemented and always set to -1.

- *uint16\_t* *tcps\_lport*

  Local TCP port.

- *uint16\_t* *tcps\_rport*

  Remote TCP port.

- *string* *tcps\_laddr*

  Local address.

- *string* *tcps\_raddr*

  Remote address.

- *int32\_t* *tcps\_state*

  Current TCP state. The valid TCP state values are given by the constants prefixed with ‘TCPS\_’ in */usr/lib/dtrace/tcp.d*.

- *uint32\_t* *tcps\_iss*

  Initial send sequence number.

- *uint32\_t* *tcps\_suna*

  Initial sequence number of sent but unacknowledged data.

- *uint32\_t* *tcps\_snxt*

  Next sequence number for send.

- *uint32\_t* *tcps\_rack*

  Sequence number of received and acknowledged data.

- *uint32\_t* *tcps\_rnxt*

  Next expected sequence number for receive.

- *u\_long* *tcps\_swnd*

  TCP send window size.

- *int32\_t* *tcps\_snd\_ws*

  Window scaling factor for the TCP send window.

- *u\_long* *tcps\_rwnd*

  TCP receive window size.

- *int32\_t* *tcps\_rcv\_ws*

  Window scaling factor for the TCP receive window.

- *u\_long* *tcps\_cwnd*

  TCP congestion window size.

- *u\_long* *tcps\_cwnd\_ssthresh*

  Congestion window threshold at which slow start ends and congestion avoidance begins.

- *uint32\_t* *tcps\_sack\_fack*

  Last sequence number selectively acknowledged by the receiver.

- *uint32\_t* *tcps\_sack\_snxt*

  Next selectively acknowledge sequence number at which to begin retransmitting.

- *uint32\_t* *tcps\_rto*

  Round-trip timeout, in milliseconds.

- *uint32\_t* *tcps\_mss*

  Maximum segment size.

- *int* *tcps\_retransmit*

  A boolean indicating that the local sender is retransmitting data.

- *int* *tcps\_srtt*

  Smoothed round-trip time.

The *tcpinfo\_t* type exposes the fields in a TCP segment header in host order. Its fields are:

- *uint16\_t* *tcp\_sport*

  Source TCP port.

- *uint16\_t* *tcp\_dport*

  Destination TCP port.

- *uint32\_t* *tcp\_seq*

  Sequence number.

- *uint32\_t* *tcp\_ack*

  Acknowledgement number.

- *uint8\_t* *tcp\_offset*

  Data offset, in bytes.

- *uint8\_t* *tcp\_flags*

  TCP flags.

- *uint16\_t* *tcp\_window*

  TCP window size.

- *uint16\_t* *tcp\_checksum*

  Checksum.

- *uint16\_t* *tcp\_urgent*

  Urgent data pointer.

- *struct* *tcphdr* *\*tcp\_hdr*

  A pointer to the raw TCP header.

The *tcplsinfo\_t* type is used by the **tcp:::state-change**() probe to provide the from-state of a transition. Its fields are:

- *int32\_t* *tcps\_state*

  A TCP state. The valid TCP state values are given by the constants prefixed with ‘TCPS\_’ in */usr/lib/dtrace/tcp.d*.

## FILES

- */usr/lib/dtrace/tcp.d*

  DTrace type and translator definitions for the **tcp** provider.

## EXAMPLES

The following script logs TCP segments in real time:

```
#pragma D option quiet
#pragma D option switchrate=10hz
dtrace:::BEGIN
{
        printf(" %3s %15s:%-5s      %15s:%-5s %6s  %s\n", "CPU",
            "LADDR", "LPORT", "RADDR", "RPORT", "BYTES", "FLAGS");
}
tcp:::send
{
        this->length = args[2]->ip_plength - args[4]->tcp_offset;
        printf(" %3d %16s:%-5d -> %16s:%-5d %6d  (", cpu, args[2]->ip_saddr,
            args[4]->tcp_sport, args[2]->ip_daddr, args[4]->tcp_dport,
            this->length);
        printf("%s", args[4]->tcp_flags & TH_FIN ? "FIN|" : "");
        printf("%s", args[4]->tcp_flags & TH_SYN ? "SYN|" : "");
        printf("%s", args[4]->tcp_flags & TH_RST ? "RST|" : "");
        printf("%s", args[4]->tcp_flags & TH_PUSH ? "PUSH|" : "");
        printf("%s", args[4]->tcp_flags & TH_ACK ? "ACK|" : "");
        printf("%s", args[4]->tcp_flags & TH_URG ? "URG|" : "");
        printf("%s", args[4]->tcp_flags == 0 ? "null " : "");
        printf(";
}
tcp:::receive
{
        this->length = args[2]->ip_plength - args[4]->tcp_offset;
        printf(" %3d %16s:%-5d <- %16s:%-5d %6d  (", cpu,
            args[2]->ip_daddr, args[4]->tcp_dport, args[2]->ip_saddr,
            args[4]->tcp_sport, this->length);
        printf("%s", args[4]->tcp_flags & TH_FIN ? "FIN|" : "");
        printf("%s", args[4]->tcp_flags & TH_SYN ? "SYN|" : "");
        printf("%s", args[4]->tcp_flags & TH_RST ? "RST|" : "");
        printf("%s", args[4]->tcp_flags & TH_PUSH ? "PUSH|" : "");
        printf("%s", args[4]->tcp_flags & TH_ACK ? "ACK|" : "");
        printf("%s", args[4]->tcp_flags & TH_URG ? "URG|" : "");
        printf("%s", args[4]->tcp_flags == 0 ? "null " : "");
        printf(";
}
```

The following script logs TCP connection state changes as they occur:

```
#pragma D option quiet
#pragma D option switchrate=25hz
int last[int];
dtrace:::BEGIN
{
        printf("   %12s %-20s    %-20s %s\n",
            "DELTA(us)", "OLD", "NEW", "TIMESTAMP");
}
tcp:::state-change
{
        this->elapsed = (timestamp - last[args[1]->cs_cid]) / 1000;
        printf("   %12d %-20s -> %-20s %d\n", this->elapsed,
            tcp_state_string[args[5]->tcps_state],
            tcp_state_string[args[3]->tcps_state], timestamp);
        last[args[1]->cs_cid] = timestamp;
}
tcp:::state-change
/last[args[1]->cs_cid] == 0/
{
        printf("   %12s %-20s -> %-20s %d\n", "-",
            tcp_state_string[args[5]->tcps_state],
            tcp_state_string[args[3]->tcps_state], timestamp);
        last[args[1]->cs_cid] = timestamp;
}
```

## COMPATIBILITY

This provider is compatible with the **tcp** provider in Solaris.

## SEE ALSO

[dtrace(1)](/dtrace/1.md), [dtrace\_ip(4)](/dtrace_ip/4.md), [dtrace\_sctp(4)](/dtrace_sctp/4.md), [dtrace\_udp(4)](/dtrace_udp/4.md), [dtrace\_udplite(4)](/dtrace_udplite/4.md), [tcp(4)](/tcp/4.md), [SDT(9)](/SDT/9.md)

## HISTORY

The **tcp** provider first appeared in FreeBSD 10.0.

## AUTHORS

This manual page was written by Mark Johnston ⟨*markj@FreeBSD.org*⟩.

## BUGS

The *tcps\_local* and *tcps\_active* fields of *tcpsinfo\_t* are not filled in by the translator.