jdk/src/java.httpclient/share/classes/sun/net/httpclient/hpack/IntegerReader.java
author lana
Thu, 08 Dec 2016 18:03:34 +0000
changeset 42478 3e6a90ed3c1c
parent 37517 9b2bc238b8a3
permissions -rw-r--r--
Added tag jdk-9+148 for changeset 20b598516784
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37517
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     1
/*
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     2
 * Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     4
 *
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    10
 *
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    15
 * accompanied this code).
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    16
 *
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    20
 *
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    23
 * questions.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    24
 */
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    25
package sun.net.httpclient.hpack;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    26
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    27
import java.nio.ByteBuffer;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    28
import java.util.Arrays;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    29
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    30
import static java.lang.String.format;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    31
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    32
final class IntegerReader {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    33
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    34
    private static final int NEW             = 0;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    35
    private static final int CONFIGURED      = 1;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    36
    private static final int FIRST_BYTE_READ = 2;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    37
    private static final int DONE            = 4;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    38
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    39
    private int state = NEW;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    40
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    41
    private int N;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    42
    private int maxValue;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    43
    private int value;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    44
    private long r;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    45
    private long b = 1;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    46
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    47
    public IntegerReader configure(int N) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    48
        return configure(N, Integer.MAX_VALUE);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    49
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    50
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    51
    //
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    52
    // Why is it important to configure 'maxValue' here. After all we can wait
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    53
    // for the integer to be fully read and then check it. Can't we?
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    54
    //
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    55
    // Two reasons.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    56
    //
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    57
    // 1. Value wraps around long won't be unnoticed.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    58
    // 2. It can spit out an exception as soon as it becomes clear there's
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    59
    // an overflow. Therefore, no need to wait for the value to be fully read.
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    60
    //
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    61
    public IntegerReader configure(int N, int maxValue) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    62
        if (state != NEW) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    63
            throw new IllegalStateException("Already configured");
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    64
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    65
        checkPrefix(N);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    66
        if (maxValue < 0) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    67
            throw new IllegalArgumentException(
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    68
                    "maxValue >= 0: maxValue=" + maxValue);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    69
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    70
        this.maxValue = maxValue;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    71
        this.N = N;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    72
        state = CONFIGURED;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    73
        return this;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    74
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    75
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    76
    public boolean read(ByteBuffer input) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    77
        if (state == NEW) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    78
            throw new IllegalStateException("Configure first");
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    79
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    80
        if (state == DONE) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    81
            return true;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    82
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    83
        if (!input.hasRemaining()) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    84
            return false;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    85
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    86
        if (state == CONFIGURED) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    87
            int max = (2 << (N - 1)) - 1;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    88
            int n = input.get() & max;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    89
            if (n != max) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    90
                value = n;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    91
                state = DONE;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    92
                return true;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    93
            } else {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    94
                r = max;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    95
            }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    96
            state = FIRST_BYTE_READ;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    97
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    98
        if (state == FIRST_BYTE_READ) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
    99
            // variable-length quantity (VLQ)
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   100
            byte i;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   101
            do {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   102
                if (!input.hasRemaining()) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   103
                    return false;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   104
                }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   105
                i = input.get();
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   106
                long increment = b * (i & 127);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   107
                if (r + increment > maxValue) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   108
                    throw new IllegalArgumentException(format(
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   109
                            "Integer overflow: maxValue=%,d, value=%,d",
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   110
                            maxValue, r + increment));
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   111
                }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   112
                r += increment;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   113
                b *= 128;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   114
            } while ((128 & i) == 128);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   115
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   116
            value = (int) r;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   117
            state = DONE;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   118
            return true;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   119
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   120
        throw new InternalError(Arrays.toString(
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   121
                new Object[]{state, N, maxValue, value, r, b}));
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   122
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   123
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   124
    public int get() throws IllegalStateException {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   125
        if (state != DONE) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   126
            throw new IllegalStateException("Has not been fully read yet");
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   127
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   128
        return value;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   129
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   130
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   131
    private static void checkPrefix(int N) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   132
        if (N < 1 || N > 8) {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   133
            throw new IllegalArgumentException("1 <= N <= 8: N= " + N);
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   134
        }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   135
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   136
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   137
    public IntegerReader reset() {
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   138
        b = 1;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   139
        state = NEW;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   140
        return this;
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   141
    }
9b2bc238b8a3 8153353: HPACK implementation
prappo
parents:
diff changeset
   142
}