/*
 * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.internal.net.http;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.http.HttpClient;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandler;
import java.net.http.HttpResponse.BodySubscriber;
import java.nio.ByteBuffer;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.Executor;
import java.util.concurrent.Flow;
import jdk.internal.net.http.common.Demand;
import jdk.internal.net.http.common.Log;
import jdk.internal.net.http.common.FlowTube;
import jdk.internal.net.http.common.Logger;
import jdk.internal.net.http.common.SequentialScheduler;
import jdk.internal.net.http.common.MinimalFuture;
import jdk.internal.net.http.common.Utils;
import static java.net.http.HttpClient.Version.HTTP_1_1;
import static jdk.internal.net.http.common.Utils.wrapWithExtraDetail;

Encapsulates one HTTP/1.1 request/response exchange.
/** * Encapsulates one HTTP/1.1 request/response exchange. */
class Http1Exchange<T> extends ExchangeImpl<T> { final Logger debug = Utils.getDebugLogger(this::dbgString, Utils.DEBUG); final HttpRequestImpl request; // main request final Http1Request requestAction; private volatile Http1Response<T> response; final HttpConnection connection; final HttpClientImpl client; final Executor executor; private final Http1AsyncReceiver asyncReceiver; private volatile boolean upgraded;
Records a possible cancellation raised before any operation has been initiated, or an error received while sending the request.
/** Records a possible cancellation raised before any operation * has been initiated, or an error received while sending the request. */
private Throwable failed; private final List<CompletableFuture<?>> operations; // used for cancel
Must be held when operating on any internal state or data.
/** Must be held when operating on any internal state or data. */
private final Object lock = new Object();
Holds the outgoing data, either the headers or a request body part. Or an error from the request body publisher. At most there can be ~2 pieces of outgoing data ( onComplete|onError can be invoked without demand ).
/** Holds the outgoing data, either the headers or a request body part. Or * an error from the request body publisher. At most there can be ~2 pieces * of outgoing data ( onComplete|onError can be invoked without demand ).*/
final ConcurrentLinkedDeque<DataPair> outgoing = new ConcurrentLinkedDeque<>();
The write publisher, responsible for writing the complete request ( both headers and body ( if any ).
/** The write publisher, responsible for writing the complete request ( both * headers and body ( if any ). */
private final Http1Publisher writePublisher = new Http1Publisher();
Completed when the header have been published, or there is an error
/** Completed when the header have been published, or there is an error */
private final CompletableFuture<ExchangeImpl<T>> headersSentCF = new MinimalFuture<>();
Completed when the body has been published, or there is an error
/** Completed when the body has been published, or there is an error */
private final CompletableFuture<ExchangeImpl<T>> bodySentCF = new MinimalFuture<>();
The subscriber to the request's body published. Maybe null.
/** The subscriber to the request's body published. Maybe null. */
private volatile Http1BodySubscriber bodySubscriber; enum State { INITIAL, HEADERS, BODY, ERROR, // terminal state COMPLETING, COMPLETED } // terminal state private State state = State.INITIAL;
A carrier for either data or an error. Used to carry data, and communicate errors from the request ( both headers and body ) to the exchange.
/** A carrier for either data or an error. Used to carry data, and communicate * errors from the request ( both headers and body ) to the exchange. */
static class DataPair { Throwable throwable; List<ByteBuffer> data; DataPair(List<ByteBuffer> data, Throwable throwable){ this.data = data; this.throwable = throwable; } @Override public String toString() { return "DataPair [data=" + data + ", throwable=" + throwable + "]"; } }
An abstract supertype for HTTP/1.1 body subscribers. There are two concrete implementations: StreamSubscriber, and FixedContentSubscriber, for receiving chunked and fixed length bodies, respectively.
/** An abstract supertype for HTTP/1.1 body subscribers. There are two * concrete implementations: {@link Http1Request.StreamSubscriber}, and * {@link Http1Request.FixedContentSubscriber}, for receiving chunked and * fixed length bodies, respectively. */
static abstract class Http1BodySubscriber implements Flow.Subscriber<ByteBuffer> { final MinimalFuture<Flow.Subscription> whenSubscribed = new MinimalFuture<>(); private volatile Flow.Subscription subscription; volatile boolean complete; private final Logger debug; Http1BodySubscriber(Logger debug) { assert debug != null; this.debug = debug; }
Final sentinel in the stream of request body.
/** Final sentinel in the stream of request body. */
static final List<ByteBuffer> COMPLETED = List.of(ByteBuffer.allocate(0)); final void request(long n) { if (debug.on()) debug.log("Http1BodySubscriber requesting %d, from %s", n, subscription); subscription.request(n); }
A current-state message suitable for inclusion in an exception detail message.
/** A current-state message suitable for inclusion in an exception detail message. */
abstract String currentStateMessage(); final boolean isSubscribed() { return subscription != null; } final void setSubscription(Flow.Subscription subscription) { this.subscription = subscription; whenSubscribed.complete(subscription); } final void cancelSubscription() { try { subscription.cancel(); } catch(Throwable t) { String msg = "Ignoring exception raised when canceling BodyPublisher subscription"; if (debug.on()) debug.log("%s: %s", msg, t); Log.logError("{0}: {1}", msg, (Object)t); } } static Http1BodySubscriber completeSubscriber(Logger debug) { return new Http1BodySubscriber(debug) { @Override public void onSubscribe(Flow.Subscription subscription) { error(); } @Override public void onNext(ByteBuffer item) { error(); } @Override public void onError(Throwable throwable) { error(); } @Override public void onComplete() { error(); } @Override String currentStateMessage() { return null; } private void error() { throw new InternalError("should not reach here"); } }; } } @Override public String toString() { return "HTTP/1.1 " + request.toString(); } HttpRequestImpl request() { return request; } Http1Exchange(Exchange<T> exchange, HttpConnection connection) throws IOException { super(exchange); this.request = exchange.request(); this.client = exchange.client(); this.executor = exchange.executor(); this.operations = new LinkedList<>(); operations.add(headersSentCF); operations.add(bodySentCF); if (connection != null) { this.connection = connection; } else { InetSocketAddress addr = request.getAddress(); this.connection = HttpConnection.getConnection(addr, client, request, HTTP_1_1); } this.requestAction = new Http1Request(request, this); this.asyncReceiver = new Http1AsyncReceiver(executor, this); } @Override HttpConnection connection() { return connection; } private void connectFlows(HttpConnection connection) { FlowTube tube = connection.getConnectionFlow(); if (debug.on()) debug.log("%s connecting flows", tube); // Connect the flow to our Http1TubeSubscriber: // asyncReceiver.subscriber(). tube.connectFlows(writePublisher, asyncReceiver.subscriber()); } @Override CompletableFuture<ExchangeImpl<T>> sendHeadersAsync() { // create the response before sending the request headers, so that // the response can set the appropriate receivers. if (debug.on()) debug.log("Sending headers only"); // If the first attempt to read something triggers EOF, or // IOException("channel reset by peer"), we're going to retry. // Instruct the asyncReceiver to throw ConnectionExpiredException // to force a retry. asyncReceiver.setRetryOnError(true); if (response == null) { response = new Http1Response<>(connection, this, asyncReceiver); } if (debug.on()) debug.log("response created in advance"); CompletableFuture<Void> connectCF; if (!connection.connected()) { if (debug.on()) debug.log("initiating connect async"); connectCF = connection.connectAsync(exchange) .thenCompose(unused -> connection.finishConnect()); Throwable cancelled; synchronized (lock) { if ((cancelled = failed) == null) { operations.add(connectCF); } } if (cancelled != null) { if (client.isSelectorThread()) { executor.execute(() -> connectCF.completeExceptionally(cancelled)); } else { connectCF.completeExceptionally(cancelled); } } } else { connectCF = new MinimalFuture<>(); connectCF.complete(null); } return connectCF .thenCompose(unused -> { CompletableFuture<Void> cf = new MinimalFuture<>(); try { asyncReceiver.whenFinished.whenComplete((r,t) -> { if (t != null) { if (debug.on()) debug.log("asyncReceiver finished (failed=%s)", (Object)t); if (!headersSentCF.isDone()) headersSentCF.completeAsync(() -> this, executor); } }); connectFlows(connection); if (debug.on()) debug.log("requestAction.headers"); List<ByteBuffer> data = requestAction.headers(); synchronized (lock) { state = State.HEADERS; } if (debug.on()) debug.log("setting outgoing with headers"); assert outgoing.isEmpty() : "Unexpected outgoing:" + outgoing; appendToOutgoing(data); cf.complete(null); return cf; } catch (Throwable t) { if (debug.on()) debug.log("Failed to send headers: %s", t); headersSentCF.completeExceptionally(t); bodySentCF.completeExceptionally(t); connection.close(); cf.completeExceptionally(t); return cf; } }) .thenCompose(unused -> headersSentCF); } private void cancelIfFailed(Flow.Subscription s) { asyncReceiver.whenFinished.whenCompleteAsync((r,t) -> { if (debug.on()) debug.log("asyncReceiver finished (failed=%s)", (Object)t); if (t != null) { s.cancel(); // Don't complete exceptionally here as 't' // might not be the right exception: it will // not have been decorated yet. // t is an exception raised by the read side, // an EOFException or Broken Pipe... // We are cancelling the BodyPublisher subscription // and completing bodySentCF to allow the next step // to flow and call readHeaderAsync, which will // get the right exception from the asyncReceiver. bodySentCF.complete(this); } }, executor); } @Override CompletableFuture<ExchangeImpl<T>> sendBodyAsync() { assert headersSentCF.isDone(); if (debug.on()) debug.log("sendBodyAsync"); try { bodySubscriber = requestAction.continueRequest(); if (debug.on()) debug.log("bodySubscriber is %s", bodySubscriber == null ? null : bodySubscriber.getClass()); if (bodySubscriber == null) { bodySubscriber = Http1BodySubscriber.completeSubscriber(debug); appendToOutgoing(Http1BodySubscriber.COMPLETED); } else { // start bodySubscriber.whenSubscribed .thenAccept((s) -> cancelIfFailed(s)) .thenAccept((s) -> requestMoreBody()); } } catch (Throwable t) { cancelImpl(t); bodySentCF.completeExceptionally(t); } return Utils.wrapForDebug(debug, "sendBodyAsync", bodySentCF); } @Override CompletableFuture<Response> getResponseAsync(Executor executor) { if (debug.on()) debug.log("reading headers"); CompletableFuture<Response> cf = response.readHeadersAsync(executor); Throwable cause; synchronized (lock) { operations.add(cf); cause = failed; failed = null; } if (cause != null) { Log.logTrace("Http1Exchange: request [{0}/timeout={1}ms]" + "\n\tCompleting exceptionally with {2}\n", request.uri(), request.timeout().isPresent() ? // calling duration.toMillis() can throw an exception. // this is just debugging, we don't care if it overflows. (request.timeout().get().getSeconds() * 1000 + request.timeout().get().getNano() / 1000000) : -1, cause); boolean acknowledged = cf.completeExceptionally(cause); if (debug.on()) debug.log(acknowledged ? ("completed response with " + cause) : ("response already completed, ignoring " + cause)); } return Utils.wrapForDebug(debug, "getResponseAsync", cf); } @Override CompletableFuture<T> readBodyAsync(BodyHandler<T> handler, boolean returnConnectionToPool, Executor executor) { BodySubscriber<T> bs = handler.apply(new ResponseInfoImpl(response.responseCode(), response.responseHeaders(), HTTP_1_1)); CompletableFuture<T> bodyCF = response.readBody(bs, returnConnectionToPool, executor); return bodyCF; } @Override CompletableFuture<Void> ignoreBody() { return response.ignoreBody(executor); } // Used for those response codes that have no body associated @Override public void nullBody(HttpResponse<T> resp, Throwable t) { response.nullBody(resp, t); } ByteBuffer drainLeftOverBytes() { synchronized (lock) { asyncReceiver.stop(); return asyncReceiver.drain(Utils.EMPTY_BYTEBUFFER); } } void released() { Http1Response<T> resp = this.response; if (resp != null) resp.completed(); asyncReceiver.clear(); } void completed() { Http1Response<T> resp = this.response; if (resp != null) resp.completed(); }
Cancel checks to see if request and responseAsync finished already. If not it closes the connection and completes all pending operations
/** * Cancel checks to see if request and responseAsync finished already. * If not it closes the connection and completes all pending operations */
@Override void cancel() { cancelImpl(new IOException("Request cancelled")); }
Cancel checks to see if request and responseAsync finished already. If not it closes the connection and completes all pending operations
/** * Cancel checks to see if request and responseAsync finished already. * If not it closes the connection and completes all pending operations */
@Override void cancel(IOException cause) { cancelImpl(cause); } private void cancelImpl(Throwable cause) { LinkedList<CompletableFuture<?>> toComplete = null; int count = 0; Throwable error; synchronized (lock) { if ((error = failed) == null) { failed = error = cause; } if (debug.on()) { debug.log(request.uri() + ": " + error); } if (requestAction != null && requestAction.finished() && response != null && response.finished()) { return; } writePublisher.writeScheduler.stop(); if (operations.isEmpty()) { Log.logTrace("Http1Exchange: request [{0}/timeout={1}ms] no pending operation." + "\n\tCan''t cancel yet with {2}", request.uri(), request.timeout().isPresent() ? // calling duration.toMillis() can throw an exception. // this is just debugging, we don't care if it overflows. (request.timeout().get().getSeconds() * 1000 + request.timeout().get().getNano() / 1000000) : -1, cause); } else { for (CompletableFuture<?> cf : operations) { if (!cf.isDone()) { if (toComplete == null) toComplete = new LinkedList<>(); toComplete.add(cf); count++; } } operations.clear(); } } try { Log.logError("Http1Exchange.cancel: count=" + count); if (toComplete != null) { // We might be in the selector thread in case of timeout, when // the SelectorManager calls purgeTimeoutsAndReturnNextDeadline() // There may or may not be other places that reach here // from the SelectorManager thread, so just make sure we // don't complete any CF from within the selector manager // thread. Executor exec = client.isSelectorThread() ? executor : this::runInline; Throwable x = error; while (!toComplete.isEmpty()) { CompletableFuture<?> cf = toComplete.poll(); exec.execute(() -> { if (cf.completeExceptionally(x)) { if (debug.on()) debug.log("%s: completed cf with %s", request.uri(), x); } }); } } } finally { if (!upgraded) connection.close(); } } void upgraded() { upgraded = true; } private void runInline(Runnable run) { assert !client.isSelectorThread(); run.run(); }
Returns true if this exchange was canceled.
/** Returns true if this exchange was canceled. */
boolean isCanceled() { synchronized (lock) { return failed != null; } }
Returns the cause for which this exchange was canceled, if available.
/** Returns the cause for which this exchange was canceled, if available. */
Throwable getCancelCause() { synchronized (lock) { return failed; } }
Convenience for appendToOutgoing(DataPair), with just a Throwable.
/** Convenience for {@link #appendToOutgoing(DataPair)}, with just a Throwable. */
void appendToOutgoing(Throwable throwable) { appendToOutgoing(new DataPair(null, throwable)); }
Convenience for appendToOutgoing(DataPair), with just data.
/** Convenience for {@link #appendToOutgoing(DataPair)}, with just data. */
void appendToOutgoing(List<ByteBuffer> item) { appendToOutgoing(new DataPair(item, null)); } private void appendToOutgoing(DataPair dp) { if (debug.on()) debug.log("appending to outgoing " + dp); outgoing.add(dp); writePublisher.writeScheduler.runOrSchedule(); }
Tells whether, or not, there is any outgoing data that can be published, or if there is an error.
/** Tells whether, or not, there is any outgoing data that can be published, * or if there is an error. */
private boolean hasOutgoing() { return !outgoing.isEmpty(); } private void requestMoreBody() { try { if (debug.on()) debug.log("requesting more request body from the subscriber"); bodySubscriber.request(1); } catch (Throwable t) { if (debug.on()) debug.log("Subscription::request failed", t); cancelImpl(t); bodySentCF.completeExceptionally(t); } } private void cancelUpstreamSubscription() { final Executor exec = client.theExecutor(); if (debug.on()) debug.log("cancelling upstream publisher"); if (bodySubscriber != null) { exec.execute(bodySubscriber::cancelSubscription); } else if (debug.on()) { debug.log("bodySubscriber is null"); } } // Invoked only by the publisher // ALL tasks should execute off the Selector-Manager thread
Returns the next portion of the HTTP request, or the error.
/** Returns the next portion of the HTTP request, or the error. */
private DataPair getOutgoing() { final Executor exec = client.theExecutor(); final DataPair dp = outgoing.pollFirst(); if (writePublisher.cancelled) { cancelUpstreamSubscription(); headersSentCF.completeAsync(() -> this, exec); bodySentCF.completeAsync(() -> this, exec); return null; } if (dp == null) // publisher has not published anything yet return null; if (dp.throwable != null) { synchronized (lock) { state = State.ERROR; } exec.execute(() -> { headersSentCF.completeExceptionally(dp.throwable); bodySentCF.completeExceptionally(dp.throwable); connection.close(); }); return dp; } switch (state) { case HEADERS: synchronized (lock) { state = State.BODY; } // completeAsync, since dependent tasks should run in another thread if (debug.on()) debug.log("initiating completion of headersSentCF"); headersSentCF.completeAsync(() -> this, exec); break; case BODY: if (dp.data == Http1BodySubscriber.COMPLETED) { synchronized (lock) { state = State.COMPLETING; } if (debug.on()) debug.log("initiating completion of bodySentCF"); bodySentCF.completeAsync(() -> this, exec); } else { exec.execute(this::requestMoreBody); } break; case INITIAL: case ERROR: case COMPLETING: case COMPLETED: default: assert false : "Unexpected state:" + state; } return dp; }
A Publisher of HTTP/1.1 headers and request body.
/** A Publisher of HTTP/1.1 headers and request body. */
final class Http1Publisher implements FlowTube.TubePublisher { final Logger debug = Utils.getDebugLogger(this::dbgString); volatile Flow.Subscriber<? super List<ByteBuffer>> subscriber; volatile boolean cancelled; final Http1WriteSubscription subscription = new Http1WriteSubscription(); final Demand demand = new Demand(); final SequentialScheduler writeScheduler = SequentialScheduler.synchronizedScheduler(new WriteTask()); @Override public void subscribe(Flow.Subscriber<? super List<ByteBuffer>> s) { assert state == State.INITIAL; Objects.requireNonNull(s); assert subscriber == null; subscriber = s; if (debug.on()) debug.log("got subscriber: %s", s); s.onSubscribe(subscription); } volatile String dbgTag; String dbgString() { String tag = dbgTag; Object flow = connection.getConnectionFlow(); if (tag == null && flow != null) { dbgTag = tag = "Http1Publisher(" + flow + ")"; } else if (tag == null) { tag = "Http1Publisher(?)"; } return tag; } @SuppressWarnings("fallthrough") private boolean checkRequestCancelled() { if (exchange.multi.requestCancelled()) { if (debug.on()) debug.log("request cancelled"); if (subscriber == null) { if (debug.on()) debug.log("no subscriber yet"); return true; } switch (state) { case BODY: cancelUpstreamSubscription(); // fall trough to HEADERS case HEADERS: Throwable cause = getCancelCause(); if (cause == null) cause = new IOException("Request cancelled"); subscriber.onError(cause); writeScheduler.stop(); return true; } } return false; } final class WriteTask implements Runnable { @Override public void run() { assert state != State.COMPLETED : "Unexpected state:" + state; if (debug.on()) debug.log("WriteTask"); if (cancelled) { if (debug.on()) debug.log("handling cancellation"); writeScheduler.stop(); getOutgoing(); return; } if (checkRequestCancelled()) return; if (subscriber == null) { if (debug.on()) debug.log("no subscriber yet"); return; } if (debug.on()) debug.log(() -> "hasOutgoing = " + hasOutgoing()); while (hasOutgoing() && demand.tryDecrement()) { DataPair dp = getOutgoing(); if (dp == null) break; if (dp.throwable != null) { if (debug.on()) debug.log("onError"); // Do not call the subscriber's onError, it is not required. writeScheduler.stop(); } else { List<ByteBuffer> data = dp.data; if (data == Http1BodySubscriber.COMPLETED) { synchronized (lock) { assert state == State.COMPLETING : "Unexpected state:" + state; state = State.COMPLETED; } if (debug.on()) debug.log("completed, stopping %s", writeScheduler); writeScheduler.stop(); // Do nothing more. Just do not publish anything further. // The next Subscriber will eventually take over. } else { if (checkRequestCancelled()) return; if (debug.on()) debug.log("onNext with " + Utils.remaining(data) + " bytes"); subscriber.onNext(data); } } } } } final class Http1WriteSubscription implements Flow.Subscription { @Override public void request(long n) { if (cancelled) return; //no-op demand.increase(n); if (debug.on()) debug.log("subscription request(%d), demand=%s", n, demand); writeScheduler.runOrSchedule(client.theExecutor()); } @Override public void cancel() { if (debug.on()) debug.log("subscription cancelled"); if (cancelled) return; //no-op cancelled = true; writeScheduler.runOrSchedule(client.theExecutor()); } } } HttpClient client() { return client; } String dbgString() { return "Http1Exchange"; } }