src/java.base/share/classes/java/util/zip/ZStreamRef.java
author sherman
Mon, 11 Dec 2017 11:45:02 -0800
changeset 48238 9f225d4387e2
parent 47216 71c04702a3d5
permissions -rw-r--r--
8185582: Update Zip implementation to use Cleaner, not finalizers Reviewed-by: plevart, rriggs, mchung
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
     2
 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     4
 *
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    10
 *
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    15
 * accompanied this code).
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    16
 *
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 5174
diff changeset
    23
 * questions.
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    24
 */
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    25
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    26
package java.util.zip;
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    27
48238
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    28
import java.util.function.LongConsumer;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    29
import java.util.function.LongSupplier;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    30
import java.lang.ref.Cleaner.Cleanable;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    31
import jdk.internal.ref.CleanerFactory;
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    32
48238
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    33
/**
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    34
 * A reference to the native zlib's z_stream structure. It also
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    35
 * serves as the "cleaner" to clean up the native resource when
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    36
 * the deflater or infalter is ended, closed or cleaned.
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    37
 */
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    38
class ZStreamRef implements Runnable {
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    39
48238
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    40
    private LongConsumer end;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    41
    private long address;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    42
    private final Cleanable cleanable;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    43
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    44
    private ZStreamRef (Object owner, LongSupplier addr, LongConsumer end) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    45
        this.cleanable = CleanerFactory.cleaner().register(owner, this);
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    46
        this.end = end;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    47
        this.address = addr.getAsLong();
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    48
    }
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    49
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    50
    long address() {
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    51
        return address;
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    52
    }
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    53
48238
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    54
    void clean() {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    55
        cleanable.clean();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    56
    }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    57
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    58
    public synchronized void run() {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    59
        long addr = address;
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
    60
        address = 0;
48238
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    61
        if (addr != 0) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    62
            end.accept(addr);
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    63
        }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    64
    }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    65
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    66
    private ZStreamRef (LongSupplier addr, LongConsumer end) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    67
        this.cleanable = null;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    68
        this.end = end;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    69
        this.address = addr.getAsLong();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    70
    }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    71
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    72
    /*
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    73
     * If {@code Inflater/Deflater} has been subclassed and the {@code end} method
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    74
     * is overridden, uses {@code finalizer} mechanism for resource cleanup. So
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    75
     * {@code end} method can be called when the {@code Inflater/Deflater} is
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    76
     * unreachable. This mechanism will be removed when the {@code finalize} method
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    77
     * is removed from {@code Inflater/Deflater}.
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    78
     */
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    79
    static ZStreamRef get(Object owner, LongSupplier addr, LongConsumer end) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    80
        Class<?> clz = owner.getClass();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    81
        while (clz != Deflater.class && clz != Inflater.class) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    82
            try {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    83
                clz.getDeclaredMethod("end");
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    84
                return new FinalizableZStreamRef(owner, addr, end);
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    85
            } catch (NoSuchMethodException nsme) {}
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    86
            clz = clz.getSuperclass();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    87
        }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    88
        return new ZStreamRef(owner, addr, end);
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    89
    }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    90
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    91
    private static class FinalizableZStreamRef extends ZStreamRef {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    92
        final Object owner;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    93
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    94
        FinalizableZStreamRef (Object owner, LongSupplier addr, LongConsumer end) {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    95
            super(addr, end);
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    96
            this.owner = owner;
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    97
        }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    98
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
    99
        @Override
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   100
        void clean() {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   101
            run();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   102
        }
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   103
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   104
        @Override
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   105
        @SuppressWarnings("deprecation")
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   106
        protected void finalize() {
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   107
            if (owner instanceof Inflater)
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   108
                ((Inflater)owner).end();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   109
            else
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   110
                ((Deflater)owner).end();
9f225d4387e2 8185582: Update Zip implementation to use Cleaner, not finalizers
sherman
parents: 47216
diff changeset
   111
        }
5174
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
   112
    }
9c77a30a925f 6904925: Changeset for 6745393 for jdk7 ssr forest was incomplete
sherman
parents:
diff changeset
   113
}