| /* Copyright 2015 greenbytes GmbH (https://www.greenbytes.de) |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #ifndef __mod_h2__h2_session__ |
| #define __mod_h2__h2_session__ |
| |
| #include "h2_conn_io.h" |
| |
| /** |
| * A HTTP/2 connection, a session with a specific client. |
| * |
| * h2_session sits on top of a httpd conn_rec* instance and takes complete |
| * control of the connection data. It receives protocol frames from the |
| * client. For new HTTP/2 streams it creates h2_task(s) that are sent |
| * via callback to a dispatcher (see h2_conn.c). |
| * h2_session keeps h2_io's for each ongoing stream which buffer the |
| * payload for that stream. |
| * |
| * New incoming HEADER frames are converted into a h2_stream+h2_task instance |
| * that both represent a HTTP/2 stream, but may have separate lifetimes. This |
| * allows h2_task to be scheduled in other threads without semaphores |
| * all over the place. It allows task memory to be freed independant of |
| * session lifetime and sessions may close down while tasks are still running. |
| * |
| * |
| */ |
| |
| #include "h2.h" |
| |
| struct apr_thread_mutext_t; |
| struct apr_thread_cond_t; |
| struct h2_ctx; |
| struct h2_config; |
| struct h2_filter_cin; |
| struct h2_ihash_t; |
| struct h2_mplx; |
| struct h2_priority; |
| struct h2_push; |
| struct h2_push_diary; |
| struct h2_response; |
| struct h2_session; |
| struct h2_stream; |
| struct h2_task; |
| struct h2_workers; |
| |
| struct nghttp2_session; |
| |
| typedef enum { |
| H2_SESSION_EV_INIT, /* session was initialized */ |
| H2_SESSION_EV_LOCAL_GOAWAY, /* we send a GOAWAY */ |
| H2_SESSION_EV_REMOTE_GOAWAY, /* remote send us a GOAWAY */ |
| H2_SESSION_EV_CONN_ERROR, /* connection error */ |
| H2_SESSION_EV_PROTO_ERROR, /* protocol error */ |
| H2_SESSION_EV_CONN_TIMEOUT, /* connection timeout */ |
| H2_SESSION_EV_NO_IO, /* nothing has been read or written */ |
| H2_SESSION_EV_STREAM_READY, /* stream signalled availability of headers/data */ |
| H2_SESSION_EV_DATA_READ, /* connection data has been read */ |
| H2_SESSION_EV_NGH2_DONE, /* nghttp2 wants neither read nor write anything */ |
| H2_SESSION_EV_MPM_STOPPING, /* the process is stopping */ |
| H2_SESSION_EV_PRE_CLOSE, /* connection will close after this */ |
| H2_SESSION_EV_STREAM_OPEN, /* stream has been opened */ |
| H2_SESSION_EV_STREAM_DONE, /* stream has been handled completely */ |
| } h2_session_event_t; |
| |
| typedef struct h2_session { |
| long id; /* identifier of this session, unique |
| * inside a httpd process */ |
| conn_rec *c; /* the connection this session serves */ |
| request_rec *r; /* the request that started this in case |
| * of 'h2c', NULL otherwise */ |
| server_rec *s; /* server/vhost we're starting on */ |
| const struct h2_config *config; /* Relevant config for this session */ |
| apr_pool_t *pool; /* pool to use in session */ |
| struct h2_mplx *mplx; /* multiplexer for stream data */ |
| struct h2_workers *workers; /* for executing stream tasks */ |
| struct h2_filter_cin *cin; /* connection input filter context */ |
| h2_conn_io io; /* io on httpd conn filters */ |
| struct h2_ihash_t *streams; /* streams handled by this session */ |
| struct nghttp2_session *ngh2; /* the nghttp2 session (internal use) */ |
| |
| h2_session_state state; /* state session is in */ |
| |
| h2_session_props local; /* properties of local session */ |
| h2_session_props remote; /* properites of remote session */ |
| |
| unsigned int reprioritize : 1; /* scheduled streams priority changed */ |
| unsigned int eoc_written : 1; /* h2 eoc bucket written */ |
| unsigned int flush : 1; /* flushing output necessary */ |
| unsigned int have_read : 1; /* session has read client data */ |
| unsigned int have_written : 1; /* session did write data to client */ |
| apr_interval_time_t wait_us; /* timout during BUSY_WAIT state, micro secs */ |
| |
| struct h2_push_diary *push_diary; /* remember pushes, avoid duplicates */ |
| |
| int open_streams; /* number of streams open */ |
| int unsent_submits; /* number of submitted, but not yet written responses. */ |
| int unsent_promises; /* number of submitted, but not yet written push promised */ |
| |
| int responses_submitted; /* number of http/2 responses submitted */ |
| int streams_reset; /* number of http/2 streams reset by client */ |
| int pushes_promised; /* number of http/2 push promises submitted */ |
| int pushes_submitted; /* number of http/2 pushed responses submitted */ |
| int pushes_reset; /* number of http/2 pushed reset by client */ |
| |
| apr_size_t frames_received; /* number of http/2 frames received */ |
| apr_size_t frames_sent; /* number of http/2 frames sent */ |
| |
| apr_size_t max_stream_count; /* max number of open streams */ |
| apr_size_t max_stream_mem; /* max buffer memory for a single stream */ |
| |
| apr_time_t idle_until; /* Time we shut down due to sheer boredom */ |
| apr_time_t keep_sync_until; /* Time we sync wait until passing to async mpm */ |
| |
| apr_bucket_brigade *bbtmp; /* brigade for keeping temporary data */ |
| struct apr_thread_cond_t *iowait; /* our cond when trywaiting for data */ |
| |
| char status[64]; /* status message for scoreboard */ |
| int last_status_code; /* the one already reported */ |
| const char *last_status_msg; /* the one already reported */ |
| } h2_session; |
| |
| |
| /** |
| * Create a new h2_session for the given connection. |
| * The session will apply the configured parameter. |
| * @param c the connection to work on |
| * @param cfg the module config to apply |
| * @param workers the worker pool to use |
| * @return the created session |
| */ |
| h2_session *h2_session_create(conn_rec *c, struct h2_ctx *ctx, |
| struct h2_workers *workers); |
| |
| /** |
| * Create a new h2_session for the given request. |
| * The session will apply the configured parameter. |
| * @param r the request that was upgraded |
| * @param cfg the module config to apply |
| * @param workers the worker pool to use |
| * @return the created session |
| */ |
| h2_session *h2_session_rcreate(request_rec *r, struct h2_ctx *ctx, |
| struct h2_workers *workers); |
| |
| /** |
| * Process the given HTTP/2 session until it is ended or a fatal |
| * error occured. |
| * |
| * @param session the sessionm to process |
| */ |
| apr_status_t h2_session_process(h2_session *session, int async); |
| |
| /** |
| * Last chance to do anything before the connection is closed. |
| */ |
| apr_status_t h2_session_pre_close(h2_session *session, int async); |
| |
| /** |
| * Cleanup the session and all objects it still contains. This will not |
| * destroy h2_task instances that have not finished yet. |
| * @param session the session to destroy |
| */ |
| void h2_session_eoc_callback(h2_session *session); |
| |
| /** |
| * Called when a serious error occured and the session needs to terminate |
| * without further connection io. |
| * @param session the session to abort |
| * @param reason the apache status that caused the abort |
| */ |
| void h2_session_abort(h2_session *session, apr_status_t reason); |
| |
| /** |
| * Close and deallocate the given session. |
| */ |
| void h2_session_close(h2_session *session); |
| |
| /* Start submitting the response to a stream request. This is possible |
| * once we have all the response headers. */ |
| apr_status_t h2_session_handle_response(h2_session *session, |
| struct h2_stream *stream); |
| |
| /** |
| * Create and register a new stream under the given id. |
| * |
| * @param session the session to register in |
| * @param stream_id the new stream identifier |
| * @param initiated_on the stream id this one is initiated on or 0 |
| * @param req the request for this stream or NULL if not known yet |
| * @return the new stream |
| */ |
| struct h2_stream *h2_session_open_stream(h2_session *session, int stream_id, |
| int initiated_on, |
| const h2_request *req); |
| |
| |
| /** |
| * Returns if client settings have push enabled. |
| * @param != 0 iff push is enabled in client settings |
| */ |
| int h2_session_push_enabled(h2_session *session); |
| |
| /** |
| * Destroy the stream and release it everywhere. Reclaim all resources. |
| * @param session the session to which the stream belongs |
| * @param stream the stream to destroy |
| */ |
| apr_status_t h2_session_stream_done(h2_session *session, |
| struct h2_stream *stream); |
| |
| /** |
| * Submit a push promise on the stream and schedule the new steam for |
| * processing.. |
| * |
| * @param session the session to work in |
| * @param is the stream initiating the push |
| * @param push the push to promise |
| * @return the new promised stream or NULL |
| */ |
| struct h2_stream *h2_session_push(h2_session *session, |
| struct h2_stream *is, struct h2_push *push); |
| |
| apr_status_t h2_session_set_prio(h2_session *session, |
| struct h2_stream *stream, |
| const struct h2_priority *prio); |
| |
| |
| #endif /* defined(__mod_h2__h2_session__) */ |
