Internet-Draft HTTP Datagram PING and TIMESTAMP May 2022
Schwartz Expires 27 November 2022 [Page]
Workgroup:
masque
Internet-Draft:
draft-schwartz-masque-h3-datagram-ping-02
Published:
Intended Status:
Standards Track
Expires:
Author:
B. Schwartz
Google LLC

HTTP Datagram PING and TIMESTAMP

Abstract

This draft defines new mechanisms for measuring the functionality and performance of an HTTP Datagram path. These mechanisms can be used with CONNECT-UDP, CONNECT-IP, or any other instantiation of the Capsule Protocol.

Discussion Venues

This note is to be removed before publishing as an RFC.

Discussion of this document takes place on the mailing list (masque@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/masque/.

Source for this draft and an issue tracker can be found at https://github.com/bemasc/h3-datagram-ping.

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."

This Internet-Draft will expire on 27 November 2022.

Table of Contents

1. Conventions and Definitions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

2. PING

PING Datagrams can be used to characterize and monitor the end-to-end HTTP Datagram path associated with an HTTP request. For example, HTTP endpoints can easily use PING Datagrams to estimate the round-trip time and loss rate of the HTTP Datagram path.

PING Datagrams are also suitable for use as DPLPMTUD Probe Packets [RFC8899]. This enables endpoints to estimate the HTTP Datagram MTU of each request-response pair, in order to avoid sending HTTP Datagrams that will be dropped.

Note that these path characteristics can differ from those inferred from the underlying transport (e.g. QUIC), if the HTTP request traverses one or more HTTP intermediaries (see Section 3.7 of [I-D.draft-ietf-httpbis-semantics]).

2.1. Registration

Endpoints indicate support for the PING Datagram type using the Item Structured Field "DG-Ping" in the HTTP Request and Response headers. Its value MUST be an integer indicating the Context ID allocated for PING datagrams. (See Section 3.3.1 of [RFC8941] for information about the integer format.)

Endpoints MUST NOT allocate more than one Context ID for PING Datagrams. As a side effect, this means that only the HTTP client can choose the Context ID used for PING Datagrams.

2.2. Format

PING Datagrams have the following format:

PING Datagram {
  Context ID (i),
  Sequence Number (i),
  Opaque Data (..),
}

All Sequence Number and Opaque Data values are potentially valid.

2.3. Use

The sender emits a PING Datagram with any even Sequence Number and any Opaque Data. Upon receiving a PING Datagram with an even Sequence Number, the recipient MUST reply with a PING Datagram whose Sequence Number is one larger, with empty Opaque Data.

Intermediaries MUST forward PING Datagrams without modification, just like any other HTTP Datagram.

3. TIMESTAMP

The TIMESTAMP Datagram extension allows marking any datagram with a timestamp indicating the time that it was sent. Where PING allows measurement of the round-trip time between peers, TIMESTAMP allows peers to observe changes in the one-way latency. Increasing one-way latency can indicate congestion on that path, informing peers' congestion control decisions.

3.1. Registration

Endpoints indicate support for TIMESTAMP Datagram type by including the boolean-valued Item Structured Field "DG-Timestamp: ?1" in the HTTP Request and Response headers. (See Section 3.3.6 of [RFC8941] for information about the boolean format.)

A TIMESTAMP Datagram context is opened by a REGISTER_TIMESTAMP_CONTEXT Capsule with the following structure:

REGISTER_TIMESTAMP_CONTEXT Capsule {
  Context ID (i)
  Inner Context ID (i)
  Short Format (1)
}

"Inner Context ID" specifies how to interpret the payload after the timestamp. It MUST be smaller than "Context ID", and MUST already be registered (although that registration does not need to have been confirmed yet).

If "Short Format" is 1 (i.e. true), timestamps MUST use the NTP Short Format (Section 6 of [RFC5905]). Otherwise, the full NTP Timestamp Format MUST be used.

Registration is confirmed by an ACK_TIMESTAMP_CONTEXT Capsule:

ACK_TIMESTAMP_CONTEXT Capsule {
  Context ID (i)
  Error Code (i)
}

Error Code 0 means registration succeeded. Error Code 1 means registration failed. All other error code values also mean failure, but they are reserved for future use.

Registrations can be closed by a CLOSE_TIMESTAMP_CONTEXT Capsule:

CLOSE_TIMESTAMP_CONTEXT Capsule {
  Context ID (i)
}

Endpoints SHOULD close any TIMESTAMP context before closing its Inner Context. If the Inner Context is closed first, datagrams subsequently received on the TIMESTAMP context MUST be dropped.

3.2. Format

TIMESTAMP Datagrams have the following format:

TIMESTAMP Datagram {
  Context ID (i),
  Timestamp (32..64),
  Inner Data (..),
}

"Timestamp" is an NTP timestamp in the short or full format, as specified at registration. The NTP Short Format occupies 4 bytes and provides a resolution of 15 microseconds; the full NTP Timestamp Format occupies 8 bytes and provides a resolution of 232 picoseconds.

"Inner Data" is a payload to be interpreted in accordance with this context's "Inner Context ID".

4. Examples

This example shows the PING and TIMESTAMP types used in combination. Note that the client is using a "false start" pattern, creating and using two registrations before either is confirmed.

Client                                                          Origin

# Headers
Capsule-Protocol: ?1
DG-Timestamp: ?1
DG-Ping: 42

# Capsules
REGISTER_TIMESTAMP_CONTEXT(Context ID = 6, Inner ID = 42, Short = 1) ==>

# Datagrams
[Context ID(6) + Timestamp(X) + Sequence Number(0) + Opaque Data] --->

# Headers
                                                   Capsule-Protocol: ?1
                                                   DG-Timestamp: ?1
                                                   DG-Ping: 42

# Capsules
              <== ACK_TIMESTAMP_CONTEXT(Context ID = 6, Error Code = 0)

# Datagrams
               <--- [Context ID(6) + Timestamp(Y) + Sequence Number(1)]
Figure 1: TIMESTAMP and PING example

TIMESTAMP can also be applied to other payload types, such as UDP packets. In CONNECT-UDP, these are pre-allocated with Context ID 0. This example similarly shows a "false start" pattern, sending a datagram before its context registration, or support for this format, is confirmed.

Client                                               CONNECT-UDP Server

# Headers
:method = CONNECT
:protocol = connect-udp
Capsule-Protocol: ?1
DG-Timestamp: ?1

# Capsules
REGISTER_TIMESTAMP_CONTEXT(Context ID = 2, Inner ID = 0, Short = 1) ==>

# Datagrams
[Context ID(2) + Timestamp(X) + UDP Payload] --->

# Headers
                                                   Capsule-Protocol: ?1
                                                   DG-Timestamp: ?1

# Capsules
              <== ACK_TIMESTAMP_CONTEXT(Context ID = 2, Error Code = 0)

# ... server waits for a UDP response packet.
# Datagrams
                      <--- [Context ID(2) + Timestamp(Y) + UDP Payload]
Figure 2: TIMESTAMP and UDP example

5. IANA considerations

5.1. Capsule types

IANA is directed to add the following entries to the "HTTP Capsule Types" registry:

Table 1
Capsule Type Value Specification
REGISTER_TIMESTAMP_CONTEXT TBD (This document)
ACK_TIMESTAMP_CONTEXT TBD (This document)
CLOSE_TIMESTAMP_CONTEXT TBD (This document)

5.2. HTTP headers

IANA is directed to add the following entries to the "Hypertext Transfer Protocol (HTTP) Field Name Registry":

Table 2
Field Name Template Status Reference Comments
DG-Ping   permanent (This document)  
DG-Timestamp   permanent (This document)  

6. References

6.1. Normative References

[RFC2119]
Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <https://www.rfc-editor.org/rfc/rfc2119>.
[RFC5905]
Mills, D., Martin, J., Ed., Burbank, J., and W. Kasch, "Network Time Protocol Version 4: Protocol and Algorithms Specification", RFC 5905, DOI 10.17487/RFC5905, , <https://www.rfc-editor.org/rfc/rfc5905>.
[RFC8174]
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <https://www.rfc-editor.org/rfc/rfc8174>.
[RFC8941]
Nottingham, M. and P-H. Kamp, "Structured Field Values for HTTP", RFC 8941, DOI 10.17487/RFC8941, , <https://www.rfc-editor.org/rfc/rfc8941>.

6.2. Informative References

[I-D.draft-ietf-httpbis-semantics]
Fielding, R. T., Nottingham, M., and J. Reschke, "HTTP Semantics", Work in Progress, Internet-Draft, draft-ietf-httpbis-semantics-19, , <https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-semantics-19>.
[RFC8899]
Fairhurst, G., Jones, T., Tüxen, M., Rüngeler, I., and T. Völker, "Packetization Layer Path MTU Discovery for Datagram Transports", RFC 8899, DOI 10.17487/RFC8899, , <https://www.rfc-editor.org/rfc/rfc8899>.

Acknowledgments

Thanks to Alex Chernyakhovsky for constructive input.

Author's Address

Benjamin Schwartz
Google LLC