/
githubmirror
/
nghttp2
Обзор
Документация
Войти
/
githubmirror
/
nghttp2
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
lib/nghttp2_stream.h
293 строки
11 KB
Tatsuhiro Tsujikawa
lib: Rewrite integer decoder in http
30 май 2026, 05:26
30 май 2026, 05:26
a1e4a0b
Код
Авторство
О чём код?
/* * nghttp2 - HTTP/2 C Library * * Copyright (c) 2012 Tatsuhiro Tsujikawa * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef NGHTTP2_STREAM_H #define NGHTTP2_STREAM_H #ifdef HAVE_CONFIG_H # include <config.h> #endif /* defined(HAVE_CONFIG_H) */ #include <nghttp2/nghttp2.h> #include "nghttp2_outbound_item.h" #include "nghttp2_map.h" #include "nghttp2_pq.h" #include "nghttp2_int.h" /* * If local peer is stream initiator: * NGHTTP2_STREAM_OPENING : upon sending request HEADERS * NGHTTP2_STREAM_OPENED : upon receiving response HEADERS * NGHTTP2_STREAM_CLOSING : upon queuing RST_STREAM * * If remote peer is stream initiator: * NGHTTP2_STREAM_OPENING : upon receiving request HEADERS * NGHTTP2_STREAM_OPENED : upon sending response HEADERS * NGHTTP2_STREAM_CLOSING : upon queuing RST_STREAM */ typedef enum { /* Initial state */ NGHTTP2_STREAM_INITIAL, /* For stream initiator: request HEADERS has been sent, but response HEADERS has not been received yet. For receiver: request HEADERS has been received, but it does not send response HEADERS yet. */ NGHTTP2_STREAM_OPENING, /* For stream initiator: response HEADERS is received. For receiver: response HEADERS is sent. */ NGHTTP2_STREAM_OPENED, /* RST_STREAM is received, but somehow we need to keep stream in memory. */ NGHTTP2_STREAM_CLOSING, /* PUSH_PROMISE is received or sent */ NGHTTP2_STREAM_RESERVED, /* Stream is created in this state if it is used as anchor in dependency tree. */ NGHTTP2_STREAM_IDLE } nghttp2_stream_state; #define NGHTTP2_SHUT_NONE 0x00U /* Indicates further receptions will be disallowed. */ #define NGHTTP2_SHUT_RD 0x01U /* Indicates further transmissions will be disallowed. */ #define NGHTTP2_SHUT_WR 0x02U /* Indicates both further receptions and transmissions will be disallowed. */ #define NGHTTP2_SHUT_RDWR (NGHTTP2_SHUT_RD | NGHTTP2_SHUT_WR) #define NGHTTP2_STREAM_FLAG_NONE 0x00U /* Indicates that this stream is pushed stream and not opened yet. */ #define NGHTTP2_STREAM_FLAG_PUSH 0x01U /* Indicates that this stream was closed */ #define NGHTTP2_STREAM_FLAG_CLOSED 0x02U /* Indicates the item is deferred due to flow control. */ #define NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL 0x04U /* Indicates the item is deferred by user callback */ #define NGHTTP2_STREAM_FLAG_DEFERRED_USER 0x08U /* bitwise OR of NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL and NGHTTP2_STREAM_FLAG_DEFERRED_USER. */ #define NGHTTP2_STREAM_FLAG_DEFERRED_ALL \ (NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL | \ NGHTTP2_STREAM_FLAG_DEFERRED_USER) /* Ignore client RFC 9218 priority signal. */ #define NGHTTP2_STREAM_FLAG_IGNORE_CLIENT_PRIORITIES 0x20U /* Indicates that RFC 9113 leading and trailing white spaces validation against a field value is not performed. */ #define NGHTTP2_STREAM_FLAG_NO_RFC9113_LEADING_AND_TRAILING_WS_VALIDATION 0x40U /* HTTP related flags to enforce HTTP semantics */ #define NGHTTP2_HTTP_FLAG_NONE 0x00U /* header field seen so far */ #define NGHTTP2_HTTP_FLAG__AUTHORITY 0x01U #define NGHTTP2_HTTP_FLAG__PATH 0x02U #define NGHTTP2_HTTP_FLAG__METHOD 0x04U #define NGHTTP2_HTTP_FLAG__SCHEME 0x08U /* host is not pseudo header, but we require either host or :authority */ #define NGHTTP2_HTTP_FLAG_HOST 0x10U #define NGHTTP2_HTTP_FLAG__STATUS 0x20U /* required header fields for HTTP request except for CONNECT method. */ #define NGHTTP2_HTTP_FLAG_REQ_HEADERS \ (NGHTTP2_HTTP_FLAG__METHOD | NGHTTP2_HTTP_FLAG__PATH | \ NGHTTP2_HTTP_FLAG__SCHEME) #define NGHTTP2_HTTP_FLAG_PSEUDO_HEADER_DISALLOWED 0x40U /* HTTP method flags */ #define NGHTTP2_HTTP_FLAG_METH_CONNECT 0x80U #define NGHTTP2_HTTP_FLAG_METH_HEAD 0x0100U #define NGHTTP2_HTTP_FLAG_METH_OPTIONS 0x0200U #define NGHTTP2_HTTP_FLAG_METH_UPGRADE_WORKAROUND 0x0400U #define NGHTTP2_HTTP_FLAG_METH_ALL \ (NGHTTP2_HTTP_FLAG_METH_CONNECT | NGHTTP2_HTTP_FLAG_METH_HEAD | \ NGHTTP2_HTTP_FLAG_METH_OPTIONS | NGHTTP2_HTTP_FLAG_METH_UPGRADE_WORKAROUND) /* :path category */ /* path starts with "/" */ #define NGHTTP2_HTTP_FLAG_PATH_REGULAR 0x0800U /* path "*" */ #define NGHTTP2_HTTP_FLAG_PATH_ASTERISK 0x1000U /* scheme */ /* "http" or "https" scheme */ #define NGHTTP2_HTTP_FLAG_SCHEME_HTTP 0x2000U /* set if final response is expected */ #define NGHTTP2_HTTP_FLAG_EXPECT_FINAL_RESPONSE 0x4000U #define NGHTTP2_HTTP_FLAG__PROTOCOL 0x8000U /* set if priority header field is received */ #define NGHTTP2_HTTP_FLAG_PRIORITY 0x010000U /* set if an error is encountered while parsing priority header field */ #define NGHTTP2_HTTP_FLAG_BAD_PRIORITY 0x020000U struct nghttp2_stream { nghttp2_stream_state state; nghttp2_pq_entry pq_entry; /* Content-Length of request/response body. -1 if unknown. */ int64_t content_length; /* Received body so far */ int64_t recv_content_length; /* Next scheduled time to sent item */ uint64_t cycle; /* Secondary key for prioritization to break a tie for cycle. This value is monotonically increased for single parent stream. */ uint64_t seq; nghttp2_stream *closed_next; /* The arbitrary data provided by user for this stream. */ void *stream_user_data; /* Item to send */ nghttp2_outbound_item *item; /* Last written length of frame payload */ size_t last_writelen; /* stream ID */ int32_t stream_id; /* Current remote window size. This value is computed against the current initial window size of remote endpoint. */ int32_t remote_window_size; /* Keep track of the number of bytes received without WINDOW_UPDATE. This could be negative after submitting negative value to WINDOW_UPDATE */ int32_t recv_window_size; /* The number of bytes consumed by the application and now is subject to WINDOW_UPDATE. This is only used when auto WINDOW_UPDATE is turned off. */ int32_t consumed_size; /* The amount of recv_window_size cut using submitting negative value to WINDOW_UPDATE */ int32_t recv_reduction; /* window size for local flow control. It is initially set to NGHTTP2_INITIAL_WINDOW_SIZE and could be increased/decreased by submitting WINDOW_UPDATE. See nghttp2_submit_window_update(). */ int32_t local_window_size; /* This is unpaid penalty (offset) when calculating cycle. */ uint32_t pending_penalty; /* status code from remote server */ int32_t status_code; /* Bitwise OR of zero or more NGHTTP2_HTTP_FLAG_* values */ uint32_t http_flags; /* This is bitwise-OR of 0 or more of NGHTTP2_STREAM_FLAG_* values. */ uint8_t flags; /* Bitwise OR of zero or more NGHTTP2_SHUT_* values. */ uint8_t shut_flags; /* Nonzero if this stream has been queued to stream pointed by dep_prev. We maintain the invariant that if a stream is queued, then its ancestors, except for root, are also queued. This invariant may break in fatal error condition. */ uint8_t queued; /* This flag is used to reduce excessive queuing of WINDOW_UPDATE to this stream. The nonzero does not necessarily mean WINDOW_UPDATE is not queued. */ uint8_t window_update_queued; /* extpri is a stream priority produced by nghttp2_extpri_to_uint8 used by RFC 9218 extensible priorities. */ uint8_t extpri; /* http_extpri is a stream priority received in HTTP request header fields and produced by nghttp2_extpri_to_uint8. */ uint8_t http_extpri; }; void nghttp2_stream_init(nghttp2_stream *stream, int32_t stream_id, uint8_t flags, nghttp2_stream_state initial_state, int32_t remote_initial_window_size, int32_t local_initial_window_size, void *stream_user_data); void nghttp2_stream_free(nghttp2_stream *stream); /* * Disallow either further receptions or transmissions, or both. * |flag| is bitwise OR of one or more of NGHTTP2_SHUT_* values. */ void nghttp2_stream_shutdown(nghttp2_stream *stream, uint8_t flag); /* * Defer |stream->item|. We won't call this function in the situation * where |stream->item| == NULL. The |flags| is bitwise OR of zero or * more of NGHTTP2_STREAM_FLAG_DEFERRED_USER and * NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL. The |flags| indicates * the reason of this action. */ void nghttp2_stream_defer_item(nghttp2_stream *stream, uint8_t flags); /* * Put back deferred data in this stream to active state. The |flags| * are one or more of bitwise OR of the following values: * NGHTTP2_STREAM_FLAG_DEFERRED_USER and * NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL and given masks are * cleared if they are set. So even if this function is called, if * one of flag is still set, data does not become active. */ void nghttp2_stream_resume_deferred_item(nghttp2_stream *stream, uint8_t flags); /* * Returns nonzero if item is deferred by whatever reason. */ int nghttp2_stream_check_deferred_item(nghttp2_stream *stream); /* * Returns nonzero if item is deferred by flow control. */ int nghttp2_stream_check_deferred_by_flow_control(nghttp2_stream *stream); /* * Updates the remote window size with the new value * |new_initial_window_size|. The |old_initial_window_size| is used to * calculate the current window size. * * This function returns 0 if it succeeds or -1. The failure is due to * overflow. */ int nghttp2_stream_update_remote_initial_window_size( nghttp2_stream *stream, int32_t new_initial_window_size, int32_t old_initial_window_size); /* * Updates the local window size with the new value * |new_initial_window_size|. The |old_initial_window_size| is used to * calculate the current window size. * * This function returns 0 if it succeeds or -1. The failure is due to * overflow. */ int nghttp2_stream_update_local_initial_window_size( nghttp2_stream *stream, int32_t new_initial_window_size, int32_t old_initial_window_size); /* * Call this function if promised stream |stream| is replied with * HEADERS. This function makes the state of the |stream| to * NGHTTP2_STREAM_OPENED. */ void nghttp2_stream_promise_fulfilled(nghttp2_stream *stream); /* * Attaches |item| to |stream|. */ void nghttp2_stream_attach_item(nghttp2_stream *stream, nghttp2_outbound_item *item); /* * Detaches |stream->item|. This function does not free * |stream->item|. The caller must free it. */ void nghttp2_stream_detach_item(nghttp2_stream *stream); #endif /* !defined(NGHTTP2_STREAM_H) */