summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/cursor/WorkFilePool.java
blob: 47e415b766629dc67c1a399fc15e1a884cd2e47e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * 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.
 */

package com.amazon.carbonado.cursor;

import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Used internally by {@link MergeSortBuffer}.
 *
 * @author Brian S O'Neill
 */
class WorkFilePool {
    private static final String cTempDir = System.getProperty("java.io.tmpdir");

    private static final ConcurrentMap<String, WorkFilePool> cPools =
        new ConcurrentHashMap<String, WorkFilePool>();

    /**
     * @param tempDir directory to store temp files for merging, or null for default
     */
    static WorkFilePool getInstance(String tempDir) {
        // This method uses ConcurrentMap features to eliminate the need to
        // ever synchronize access, since this method may be called frequently.

        if (tempDir == null) {
            tempDir = cTempDir;
        }

        WorkFilePool pool = cPools.get(tempDir);

        if (pool != null) {
            return pool;
        }

        String canonical;
        try {
            canonical = new File(tempDir).getCanonicalPath();
        } catch (IOException e) {
            canonical = new File(tempDir).getAbsolutePath();
        }

        if (!canonical.equals(tempDir)) {
            pool = getInstance(canonical);
            cPools.putIfAbsent(tempDir, pool);
            return pool;
        }

        pool = new WorkFilePool(new File(tempDir));

        WorkFilePool existing = cPools.putIfAbsent(tempDir, pool);

        if (existing == null) {
            // New pool is the winner, so finish off initialization. Pool can
            // be used concurrently by another thread without shutdown hook.
            pool.addShutdownHook(tempDir);
        } else {
            pool = existing;
        }

        return pool;
    }

    private final File mTempDir;

    // Work files not currently being used by any MergeSortBuffer.
    private final List<RandomAccessFile> mWorkFilePool;
    // Instances of MergeSortBuffer, to be notified on shutdown that they
    // should close their work files.
    private final Set<MergeSortBuffer<?>> mWorkFileUsers;

    private Thread mShutdownHook;

    /**
     * @param tempDir directory to store temp files for merging, or null for default
     */
    private WorkFilePool(File tempDir) {
        mTempDir = tempDir;
        mWorkFilePool = new ArrayList<RandomAccessFile>();
        mWorkFileUsers = new HashSet<MergeSortBuffer<?>>();
    }

    RandomAccessFile acquireWorkFile(MergeSortBuffer<?> buffer) throws IOException {
        synchronized (mWorkFileUsers) {
            mWorkFileUsers.add(buffer);
        }
        synchronized (mWorkFilePool) {
            if (mWorkFilePool.size() > 0) {
                return mWorkFilePool.remove(mWorkFilePool.size() - 1);
            }
        }
        File file = File.createTempFile("carbonado-mergesort-", null, mTempDir);
        file.deleteOnExit();
        return new RandomAccessFile(file, "rw");
    }

    void releaseWorkFiles(List<RandomAccessFile> files) {
        synchronized (mWorkFilePool) {
            for (RandomAccessFile raf : files) {
                try {
                    raf.seek(0);
                    // Return space to file system.
                    raf.setLength(0);
                    mWorkFilePool.add(raf);
                } catch (IOException e) {
                    // Work file is broken, discard it.
                    try {
                        raf.close();
                    } catch (IOException e2) {
                    }
                }
            }
        }
    }

    void unregisterWorkFileUser(MergeSortBuffer<?> buffer) {
        synchronized (mWorkFileUsers) {
            mWorkFileUsers.remove(buffer);
            // Only one wait condition, so okay to not call notifyAll.
            mWorkFileUsers.notify();
        }
    }

    private synchronized void addShutdownHook(String tempDir) {
        if (mShutdownHook != null) {
            return;
        }

        // Add shutdown hook to close work files so that they can be deleted.
        String threadName = "MergeSortBuffer shutdown (" + tempDir + ')';

        mShutdownHook = new Thread(threadName) {
            @Override
            public void run() {
                // Notify users of work files and wait for them to close.
                synchronized (mWorkFileUsers) {
                    for (MergeSortBuffer<?> buffer : mWorkFileUsers) {
                        buffer.stop();
                    }
                    final long timeout = 10000;
                    final long giveup = System.currentTimeMillis() + timeout;
                    try {
                        while (mWorkFileUsers.size() > 0) {
                            long now = System.currentTimeMillis();
                            if (now < giveup) {
                                mWorkFileUsers.wait(giveup - now);
                            } else {
                                break;
                            }
                        }
                    } catch (InterruptedException e) {
                    }
                }

                synchronized (mWorkFilePool) {
                    for (RandomAccessFile raf : mWorkFilePool) {
                        try {
                            raf.close();
                        } catch (IOException e) {
                        }
                    }
                    mWorkFilePool.clear();
                }
            }
        };

        Runtime.getRuntime().addShutdownHook(mShutdownHook);
    }
}