diff options
Diffstat (limited to 'src/node_http2_core.h')
| -rw-r--r-- | src/node_http2_core.h | 516 |
1 files changed, 0 insertions, 516 deletions
diff --git a/src/node_http2_core.h b/src/node_http2_core.h deleted file mode 100644 index 5fbb7fa9f2..0000000000 --- a/src/node_http2_core.h +++ /dev/null @@ -1,516 +0,0 @@ -#ifndef SRC_NODE_HTTP2_CORE_H_ -#define SRC_NODE_HTTP2_CORE_H_ - -#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS - -#include "stream_base.h" -#include "util-inl.h" -#include "uv.h" -#include "nghttp2/nghttp2.h" - -#include <queue> -#include <vector> -#include <stdio.h> -#include <unordered_map> - -namespace node { -namespace http2 { - -#ifdef NODE_DEBUG_HTTP2 - -// Adapted from nghttp2 own debug printer -static inline void _debug_vfprintf(const char* fmt, va_list args) { - vfprintf(stderr, fmt, args); -} - -void inline debug_vfprintf(const char* format, ...) { - va_list args; - va_start(args, format); - _debug_vfprintf(format, args); - va_end(args); -} - -#define DEBUG_HTTP2(...) debug_vfprintf(__VA_ARGS__); -#else -#define DEBUG_HTTP2(...) \ - do { \ - } while (0) -#endif - -#define DEFAULT_SETTINGS_HEADER_TABLE_SIZE 4096 -#define DEFAULT_SETTINGS_ENABLE_PUSH 1 -#define DEFAULT_SETTINGS_INITIAL_WINDOW_SIZE 65535 -#define DEFAULT_SETTINGS_MAX_FRAME_SIZE 16384 -#define DEFAULT_SETTINGS_MAX_HEADER_LIST_SIZE 65535 -#define MAX_MAX_FRAME_SIZE 16777215 -#define MIN_MAX_FRAME_SIZE DEFAULT_SETTINGS_MAX_FRAME_SIZE -#define MAX_INITIAL_WINDOW_SIZE 2147483647 - -#define MAX_MAX_HEADER_LIST_SIZE 16777215u -#define DEFAULT_MAX_HEADER_LIST_PAIRS 128u - - -class Nghttp2Session; -class Nghttp2Stream; - -struct nghttp2_stream_write_t; - -#define MAX_BUFFER_COUNT 16 - -enum nghttp2_session_type { - NGHTTP2_SESSION_SERVER, - NGHTTP2_SESSION_CLIENT -}; - -enum nghttp2_shutdown_flags { - NGHTTP2_SHUTDOWN_FLAG_GRACEFUL -}; - -enum nghttp2_stream_flags { - NGHTTP2_STREAM_FLAG_NONE = 0x0, - // Writable side has ended - NGHTTP2_STREAM_FLAG_SHUT = 0x1, - // Reading has started - NGHTTP2_STREAM_FLAG_READ_START = 0x2, - // Reading is paused - NGHTTP2_STREAM_FLAG_READ_PAUSED = 0x4, - // Stream is closed - NGHTTP2_STREAM_FLAG_CLOSED = 0x8, - // Stream is destroyed - NGHTTP2_STREAM_FLAG_DESTROYED = 0x10 -}; - -enum nghttp2_stream_options { - STREAM_OPTION_EMPTY_PAYLOAD = 0x1, - STREAM_OPTION_GET_TRAILERS = 0x2, -}; - -// Callbacks -typedef void (*nghttp2_stream_write_cb)( - nghttp2_stream_write_t* req, - int status); - -struct nghttp2_stream_write { - unsigned int nbufs = 0; - nghttp2_stream_write_t* req = nullptr; - nghttp2_stream_write_cb cb = nullptr; - MaybeStackBuffer<uv_buf_t, MAX_BUFFER_COUNT> bufs; -}; - -struct nghttp2_header { - nghttp2_rcbuf* name = nullptr; - nghttp2_rcbuf* value = nullptr; - uint8_t flags = 0; -}; - -// Handle Types -class Nghttp2Session { - public: - // Initializes the session instance - inline int Init( - const nghttp2_session_type type = NGHTTP2_SESSION_SERVER, - nghttp2_option* options = nullptr, - nghttp2_mem* mem = nullptr, - uint32_t maxHeaderPairs = DEFAULT_MAX_HEADER_LIST_PAIRS); - - // Frees this session instance - inline ~Nghttp2Session(); - inline void MarkDestroying(); - bool IsDestroying() { - return destroying_; - } - - uint32_t GetMaxHeaderPairs() const { - return max_header_pairs_; - } - - inline const char* TypeName() { - switch (session_type_) { - case NGHTTP2_SESSION_SERVER: return "server"; - case NGHTTP2_SESSION_CLIENT: return "client"; - default: - // This should never happen - ABORT(); - } - } - - // Returns the pointer to the identified stream, or nullptr if - // the stream does not exist - inline Nghttp2Stream* FindStream(int32_t id); - - // Submits a new request. If the request is a success, assigned - // will be a pointer to the Nghttp2Stream instance assigned. - // This only works if the session is a client session. - inline int32_t SubmitRequest( - nghttp2_priority_spec* prispec, - nghttp2_nv* nva, - size_t len, - Nghttp2Stream** assigned = nullptr, - int options = 0); - - // Submits a notice to the connected peer that the session is in the - // process of shutting down. - inline void SubmitShutdownNotice(); - - // Submits a SETTINGS frame to the connected peer. - inline int SubmitSettings(const nghttp2_settings_entry iv[], size_t niv); - - // Write data to the session - inline ssize_t Write(const uv_buf_t* bufs, unsigned int nbufs); - - // Returns the nghttp2 library session - inline nghttp2_session* session() const { return session_; } - - inline bool IsClosed() const { return session_ == nullptr; } - - nghttp2_session_type type() const { - return session_type_; - } - - protected: - // Adds a stream instance to this session - inline void AddStream(Nghttp2Stream* stream); - - // Removes a stream instance from this session - inline void RemoveStream(int32_t id); - - virtual void OnHeaders( - Nghttp2Stream* stream, - nghttp2_header* headers, - size_t count, - nghttp2_headers_category cat, - uint8_t flags) {} - virtual void OnStreamClose(int32_t id, uint32_t code) {} - virtual void OnDataChunk(Nghttp2Stream* stream, - uv_buf_t* chunk) {} - virtual void OnSettings(bool ack) {} - virtual void OnPriority(int32_t id, - int32_t parent, - int32_t weight, - int8_t exclusive) {} - virtual void OnGoAway(int32_t lastStreamID, - uint32_t errorCode, - uint8_t* data, - size_t length) {} - virtual void OnFrameError(int32_t id, - uint8_t type, - int error_code) {} - virtual ssize_t GetPadding(size_t frameLength, - size_t maxFrameLength) { return 0; } - - inline void SendPendingData(); - virtual void Send(WriteWrap* req, char* buf, size_t length) = 0; - virtual WriteWrap* AllocateSend() = 0; - - virtual bool HasGetPaddingCallback() { return false; } - - class SubmitTrailers { - public: - inline void Submit(nghttp2_nv* trailers, size_t length) const; - - private: - inline SubmitTrailers(Nghttp2Session* handle, - Nghttp2Stream* stream, - uint32_t* flags); - - Nghttp2Session* const handle_; - Nghttp2Stream* const stream_; - uint32_t* const flags_; - - friend class Nghttp2Session; - }; - - virtual void OnTrailers(Nghttp2Stream* stream, - const SubmitTrailers& submit_trailers) {} - - virtual uv_loop_t* event_loop() const = 0; - - virtual void Close(); - - private: - inline void HandleHeadersFrame(const nghttp2_frame* frame); - inline void HandlePriorityFrame(const nghttp2_frame* frame); - inline void HandleDataFrame(const nghttp2_frame* frame); - inline void HandleGoawayFrame(const nghttp2_frame* frame); - - static inline void GetTrailers(nghttp2_session* session, - Nghttp2Session* handle, - Nghttp2Stream* stream, - uint32_t* flags); - - /* callbacks for nghttp2 */ -#ifdef NODE_DEBUG_HTTP2 - static inline int OnNghttpError(nghttp2_session* session, - const char* message, - size_t len, - void* user_data); -#endif - - static inline int OnBeginHeadersCallback(nghttp2_session* session, - const nghttp2_frame* frame, - void* user_data); - static inline int OnHeaderCallback(nghttp2_session* session, - const nghttp2_frame* frame, - nghttp2_rcbuf* name, - nghttp2_rcbuf* value, - uint8_t flags, - void* user_data); - static inline int OnFrameReceive(nghttp2_session* session, - const nghttp2_frame* frame, - void* user_data); - static inline int OnFrameNotSent(nghttp2_session* session, - const nghttp2_frame* frame, - int error_code, - void* user_data); - static inline int OnStreamClose(nghttp2_session* session, - int32_t id, - uint32_t code, - void* user_data); - static inline int OnInvalidHeader(nghttp2_session* session, - const nghttp2_frame* frame, - nghttp2_rcbuf* name, - nghttp2_rcbuf* value, - uint8_t flags, - void* user_data); - static inline int OnDataChunkReceived(nghttp2_session* session, - uint8_t flags, - int32_t id, - const uint8_t* data, - size_t len, - void* user_data); - static inline ssize_t OnStreamReadFD(nghttp2_session* session, - int32_t id, - uint8_t* buf, - size_t length, - uint32_t* flags, - nghttp2_data_source* source, - void* user_data); - static inline ssize_t OnStreamRead(nghttp2_session* session, - int32_t id, - uint8_t* buf, - size_t length, - uint32_t* flags, - nghttp2_data_source* source, - void* user_data); - static inline ssize_t OnSelectPadding(nghttp2_session* session, - const nghttp2_frame* frame, - size_t maxPayloadLen, - void* user_data); - - struct Callbacks { - inline explicit Callbacks(bool kHasGetPaddingCallback); - inline ~Callbacks(); - - nghttp2_session_callbacks* callbacks; - }; - - /* Use callback_struct_saved[kHasGetPaddingCallback ? 1 : 0] */ - static Callbacks callback_struct_saved[2]; - - nghttp2_session* session_; - nghttp2_session_type session_type_; - uint32_t max_header_pairs_ = DEFAULT_MAX_HEADER_LIST_PAIRS; - std::unordered_map<int32_t, Nghttp2Stream*> streams_; - bool destroying_ = false; - - friend class Nghttp2Stream; -}; - - - -class Nghttp2Stream { - public: - // Resets the state of the stream instance to defaults - Nghttp2Stream( - int32_t id, - Nghttp2Session* session, - nghttp2_headers_category category = NGHTTP2_HCAT_HEADERS, - int options = 0); - - inline ~Nghttp2Stream() {} - - inline void FlushDataChunks(); - - // Destroy this stream instance and free all held memory. - // Note that this will free queued outbound and inbound - // data chunks and inbound headers, so it's important not - // to call this until those are fully consumed. - inline void Destroy(); - - // Returns true if this stream has been destroyed - inline bool IsDestroyed() const { - return flags_ & NGHTTP2_STREAM_FLAG_DESTROYED; - } - - // Queue outbound chunks of data to be sent on this stream - inline int Write( - nghttp2_stream_write_t* req, - const uv_buf_t bufs[], - unsigned int nbufs, - nghttp2_stream_write_cb cb); - - // Initiate a response on this stream. - inline int SubmitResponse(nghttp2_nv* nva, - size_t len, - int options); - - // Send data read from a file descriptor as the response on this stream. - inline int SubmitFile(int fd, - nghttp2_nv* nva, size_t len, - int64_t offset, - int64_t length, - int options); - - // Submit informational headers for this stream - inline int SubmitInfo(nghttp2_nv* nva, size_t len); - - // Submit a PRIORITY frame for this stream - inline int SubmitPriority(nghttp2_priority_spec* prispec, - bool silent = false); - - // Submits an RST_STREAM frame using the given code - inline int SubmitRstStream(const uint32_t code); - - // Submits a PUSH_PROMISE frame with this stream as the parent. - inline int SubmitPushPromise( - nghttp2_nv* nva, - size_t len, - Nghttp2Stream** assigned = nullptr, - int options = 0); - - // Marks the Writable side of the stream as being shutdown - inline void Shutdown() { - flags_ |= NGHTTP2_STREAM_FLAG_SHUT; - nghttp2_session_resume_data(session_->session(), id_); - } - - // Returns true if this stream is writable. - inline bool IsWritable() const { - return !(flags_ & NGHTTP2_STREAM_FLAG_SHUT); - } - - // Start Reading. If there are queued data chunks, they are pushed into - // the session to be emitted at the JS side - inline void ReadStart(); - - // Resume Reading - inline void ReadResume(); - - // Stop/Pause Reading. - inline void ReadStop(); - - // Returns true if reading is paused - inline bool IsPaused() const { - return flags_ & NGHTTP2_STREAM_FLAG_READ_PAUSED; - } - - inline bool GetTrailers() const { - return getTrailers_; - } - - // Returns true if this stream is in the reading state, which occurs when - // the NGHTTP2_STREAM_FLAG_READ_START flag has been set and the - // NGHTTP2_STREAM_FLAG_READ_PAUSED flag is *not* set. - inline bool IsReading() const { - return flags_ & NGHTTP2_STREAM_FLAG_READ_START && - !(flags_ & NGHTTP2_STREAM_FLAG_READ_PAUSED); - } - - inline void Close(int32_t code) { - DEBUG_HTTP2("Nghttp2Stream %d: closing with code %d\n", id_, code); - flags_ |= NGHTTP2_STREAM_FLAG_CLOSED; - code_ = code; - session_->OnStreamClose(id_, code); - DEBUG_HTTP2("Nghttp2Stream %d: closed\n", id_); - } - - // Returns true if this stream has been closed either by receiving or - // sending an RST_STREAM frame. - inline bool IsClosed() const { - return flags_ & NGHTTP2_STREAM_FLAG_CLOSED; - } - - // Returns the RST_STREAM code used to close this stream - inline int32_t code() const { - return code_; - } - - // Returns the stream identifier for this stream - inline int32_t id() const { - return id_; - } - - inline bool AddHeader(nghttp2_rcbuf* name, - nghttp2_rcbuf* value, - uint8_t flags); - - inline nghttp2_header* headers() { - return current_headers_.data(); - } - - inline nghttp2_headers_category headers_category() const { - return current_headers_category_; - } - - inline size_t headers_count() const { - return current_headers_.size(); - } - - void StartHeaders(nghttp2_headers_category category) { - DEBUG_HTTP2("Nghttp2Stream %d: starting headers, category: %d\n", - id_, category); - current_headers_length_ = 0; - current_headers_.clear(); - current_headers_category_ = category; - } - - private: - // The Stream Identifier - int32_t id_; - - // The Parent HTTP/2 Session - Nghttp2Session* session_; - - // Internal state flags - int flags_ = NGHTTP2_STREAM_FLAG_NONE; - uint32_t max_header_pairs_ = DEFAULT_MAX_HEADER_LIST_PAIRS; - uint32_t max_header_length_ = DEFAULT_SETTINGS_MAX_HEADER_LIST_SIZE; - - // The RST_STREAM code used to close this stream - int32_t code_ = NGHTTP2_NO_ERROR; - - // Outbound Data... This is the data written by the JS layer that is - // waiting to be written out to the socket. - std::queue<nghttp2_stream_write*> queue_; - unsigned int queue_index_ = 0; - size_t queue_offset_ = 0; - int64_t fd_offset_ = 0; - int64_t fd_length_ = -1; - - // True if this stream will have outbound trailers - bool getTrailers_ = false; - - // The Current Headers block... As headers are received for this stream, - // they are temporarily stored here until the OnFrameReceived is called - // signalling the end of the HEADERS frame - nghttp2_headers_category current_headers_category_ = NGHTTP2_HCAT_HEADERS; - uint32_t current_headers_length_ = 0; // total number of octets - std::vector<nghttp2_header> current_headers_; - - // Inbound Data... This is the data received via DATA frames for this stream. - std::queue<uv_buf_t> data_chunks_; - - friend class Nghttp2Session; -}; - -struct nghttp2_stream_write_t { - void* data; - int status; -}; - -} // namespace http2 -} // namespace node - -#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS - -#endif // SRC_NODE_HTTP2_CORE_H_ |