diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..9c662bc --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +trim_trailing_whitespace = true +end_of_line = lf +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false + +[*.{yml,json}] +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c5ceab4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,42 @@ +/.idea/workspace.xml +/.idea/usage.statistics.xml +/nbproject/private/ +/bin +/wiki +.DS_Store +*.bat +*.conf +*.dll +*.dylib +*.jar +*.jpg +*.mhr +*.obj +*.ogg +*.sh +*.so +*.ttf +*.wav +*.zip +touch.txt + +.gradle +build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar +!gradlew.bat + +# Cache of project +.gradletasknamecache + +# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 +# gradle/wrapper/gradle-wrapper.properties + +.idea/ +out/ + +run/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5fc79d7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Overrun Organization + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f4ce4e --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Pooling + +Object pools for multi-threading. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..596ad36 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,167 @@ +plugins { + java + idea + signing + `maven-publish` +} + +val projGroupId: String by rootProject +val projArtifactId: String by rootProject +val projName: String by rootProject +val projVersion: String by rootProject +val projDesc: String by rootProject +val projVcs: String by rootProject +val projBranch: String by rootProject +val orgName: String by rootProject +val orgUrl: String by rootProject +val developers: String by rootProject + +group = projGroupId +version = projVersion + +repositories { + mavenCentral() + maven { url = uri("https://maven.aliyun.com/repository/central") } + // temporary maven repositories + maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") } + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/releases") } + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots") } +} + +dependencies { + testImplementation(platform("org.junit:junit-bom:5.10.0")) + testImplementation("org.junit.jupiter:junit-jupiter") +} + +tasks.test { + useJUnitPlatform() +} + +val targetJavaVersion = 17 +tasks.withType { + options.encoding = "UTF-8" + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible) { + options.release.set(targetJavaVersion) + } +} + +java { + val javaVersion = JavaVersion.toVersion(targetJavaVersion) + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion.set(JavaLanguageVersion.of(targetJavaVersion)) + } + withJavadocJar() + withSourcesJar() +} + +tasks.named("javadoc") { + isFailOnError = false + options { + encoding = "UTF-8" + locale = "en_US" + windowTitle = "$projName $projVersion Javadoc" + if (this is StandardJavadocDocletOptions) { + charSet = "UTF-8" + isAuthor = true + links("https://docs.oracle.com/en/java/javase/$targetJavaVersion/docs/api/") + } + } +} + +tasks.named("jar") { + manifestContentCharset = "utf-8" + metadataCharset = "utf-8" + from("LICENSE") + manifest.attributes( + "Specification-Title" to projName, + "Specification-Vendor" to orgName, + "Specification-Version" to "0", + "Implementation-Title" to projName, + "Implementation-Vendor" to orgName, + "Implementation-Version" to archiveVersion + ) + archiveBaseName.set(projArtifactId) +} + +tasks.named("sourcesJar") { + dependsOn(tasks["classes"]) + archiveClassifier.set("sources") +// from(sourceSets.main.allSource, "LICENSE") +} + +tasks.named("javadocJar") { + val javadoc by tasks + dependsOn(javadoc) + archiveClassifier.set("javadoc") + from(javadoc, "LICENSE") +} + +artifacts { + archives(tasks["javadocJar"]) + archives(tasks["sourcesJar"]) +} + +publishing.publications { + register("mavenJava") { + groupId = projGroupId + artifactId = projArtifactId + version = projVersion + description = projDesc + from(components["java"]) + pom { + name = projName + description = projDesc + url.set("https://github.com/$projVcs") + licenses { + license { + name.set("MIT") + url.set("https://raw.githubusercontent.com/$projVcs/$projBranch/LICENSE") + } + } + organization { + name = orgName + url = orgUrl + } + developers { + val prop = developers.split(',') + prop.map { it.split(':', limit = 3) } + .forEach { + developer { + id.set(it[0]) + name.set(it[1]) + email.set(it[2]) + } + } + } + scm { + connection.set("scm:git:https://github.com/${projVcs}.git") + developerConnection.set("scm:git:https://github.com/${projVcs}.git") + url.set("https://github.com/${projVcs}.git") + } + } + } +} +// You have to add 'OSSRH_USERNAME', 'OSSRH_PASSWORD', 'signing.keyId', +// 'signing.password' and 'signing.secretKeyRingFile' to +// GRADLE_USER_HOME/gradle.properties +publishing.repositories { + maven { + name = "OSSRH" + credentials { + username = project.findProperty("OSSRH_USERNAME").toString() + password = project.findProperty("OSSRH_PASSWORD").toString() + } + url = uri( + if (projVersion.endsWith("-SNAPSHOT")) + "https://s01.oss.sonatype.org/content/repositories/snapshots/" + else "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" + ) + } +} + +signing { + if (!projVersion.endsWith("-SNAPSHOT") && System.getProperty("gpg.signing", "true").toBoolean()) + sign(publishing.publications["mavenJava"]) +} + +idea.module.inheritOutputDirs = true diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..3c178eb --- /dev/null +++ b/gradle.properties @@ -0,0 +1,17 @@ +org.gradle.jvmargs=-Dfile.encoding=UTF-8 + +# Project information +projGroupId=io.github.over-run +projArtifactId=pooling +projName=pooling +projVersion=0.1.0 +projDesc=Object pools for multi-threading +projVcs=Over-Run/pooling +projBranch=0.x + +# Organization +orgName=Overrun Organization +orgUrl=https://over-run.github.io/ + +# Developers +developers=squid233:squid233:513508220@qq.com diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..8f10c14 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sun Sep 10 08:58:22 CST 2023 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..b992094 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,12 @@ +pluginManagement { + repositories { + mavenCentral() + gradlePluginPortal() + maven { url = uri("https://maven.aliyun.com/repository/public") } + maven { url = uri("https://maven.aliyun.com/repository/gradle-plugin") } + } +} + +val projName: String by settings + +rootProject.name = projName diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java new file mode 100644 index 0000000..92545cb --- /dev/null +++ b/src/main/java/module-info.java @@ -0,0 +1,23 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +/** + * @author squid233 + * @since 0.1.0 + */ +module org.overrun.pooling { + exports org.overrun.pooling; +} diff --git a/src/main/java/org/overrun/pooling/FixedObjectPool.java b/src/main/java/org/overrun/pooling/FixedObjectPool.java new file mode 100644 index 0000000..25bcb08 --- /dev/null +++ b/src/main/java/org/overrun/pooling/FixedObjectPool.java @@ -0,0 +1,102 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +import java.util.Objects; +import java.util.concurrent.atomic.AtomicReferenceArray; +import java.util.function.Consumer; +import java.util.function.Supplier; + +/** + * A fixed-size object pool that allows borrowing and returning object instances. + * + * @param the type of the instances in this pool. + * @author squid233 + * @since 0.1.0 + */ +public final class FixedObjectPool implements Pool { + private final Consumer cleanupAction; + private final AtomicReferenceArray> states; + private final Supplier constructor; + + /** + * Creates a fixed-size object pool with the given size and cleanup action. + * + * @param size the size of this pool. + * @param constructor the constructor of the objects. + * @param cleanupAction the cleanup action of this pool. + */ + public FixedObjectPool(int size, Supplier constructor, Consumer cleanupAction) { + this.cleanupAction = cleanupAction; + this.states = new AtomicReferenceArray<>(size); + this.constructor = constructor; + } + + /** + * Creates a fixed-size object pool with the given size. + * + * @param size the size of this pool. + * @param constructor the constructor of the objects. + */ + public FixedObjectPool(int size, Supplier constructor) { + this(size, constructor, null); + } + + @Override + public boolean hasRemaining() { + for (int i = 0, c = states.length(); i < c; i++) { + if (!states.get(i).lent.get()) return true; + } + return false; + } + + @Override + public Result borrow() { + for (int i = 0, c = states.length(); i < c; i++) { + if (states.get(i) == null) { + var state = new PoolObjectState<>(i, Objects.requireNonNull(constructor.get())); + states.set(i, state); + return new Result<>(state, null); + } + var state = states.get(i); + if (state.lent.compareAndSet(false, true)) { + state.get().reset(); + return new Result<>(state, null); + } + } + return new Result<>(null, + new ArrayIndexOutOfBoundsException("FixedObjectPool has exceeded the limit: " + states.length())); + } + + @Override + public void returning(PoolObjectState state) { + state.lent.compareAndSet(true, false); + } + + @Override + public void cleanup() { + if (cleanupAction != null) { + for (int i = 0, c = states.length(); i < c; i++) { + var state = states.get(i); + final T t = state.get(); + if (t != null) { + cleanupAction.accept(t); + } + } + } + } +} diff --git a/src/main/java/org/overrun/pooling/KeyedObjectPool.java b/src/main/java/org/overrun/pooling/KeyedObjectPool.java new file mode 100644 index 0000000..5c7f3c3 --- /dev/null +++ b/src/main/java/org/overrun/pooling/KeyedObjectPool.java @@ -0,0 +1,112 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +import java.util.*; +import java.util.function.Consumer; +import java.util.function.Function; + +/** + * A growable keyed object pool that allows borrowing and returning object instances. + * + * @author squid233 + * @since 0.1.0 + */ +public final class KeyedObjectPool implements KeyedPool { + private final Consumer cleanupAction; + private final Map>> states; + private final Function constructor; + private final int initialCapacity; + + /** + * Creates a growable keyed object pool with the given initial capacity and cleanup action. + * + * @param constructor the constructor of the objects. + * @param cleanupAction the cleanup action of this pool. + * @param numMappings the initial mapping count of the map. + * @param initialCapacity the initial capacity of the lists. + */ + public KeyedObjectPool(Function constructor, Consumer cleanupAction, int numMappings, int initialCapacity) { + this.cleanupAction = cleanupAction; + this.states = Collections.synchronizedMap(new HashMap<>((int) (numMappings / 0.75))); + this.constructor = constructor; + this.initialCapacity = initialCapacity; + } + + /** + * Creates a growable keyed object pool with the given initial capacity. + * + * @param constructor the constructor of the objects. + * @param numMappings the initial mapping count of the map. + * @param initialCapacity the initial capacity of the lists. + */ + public KeyedObjectPool(Function constructor, int numMappings, int initialCapacity) { + this(constructor, null, numMappings, initialCapacity); + } + + /** + * Creates a growable keyed object pool. + * + * @param constructor the constructor of the objects. + */ + public KeyedObjectPool(Function constructor) { + this(constructor, 12, 10); + } + + @Override + public boolean hasRemaining(K key) { + final var list = states.get(key); + if (list == null) return false; + for (var state : list) { + if (!state.lent.get()) return true; + } + return false; + } + + @Override + public KeyedResult borrow(K key) { + final var list = states.computeIfAbsent(key, k -> Collections.synchronizedList(new ArrayList<>(initialCapacity))); + for (var state : list) { + if (state.lent.compareAndSet(false, true)) { + state.get().reset(); + return new KeyedResult<>(state, null); + } + } + final var state = new KeyedPoolObjectState<>(key, list.size(), Objects.requireNonNull(constructor.apply(key))); + list.add(state); + return new KeyedResult<>(state, null); + } + + @Override + public void returning(KeyedPoolObjectState state) { + state.lent.compareAndSet(true, false); + } + + @Override + public void cleanup() { + if (cleanupAction != null) { + states.values().forEach(list -> { + for (var state : list) { + final T t = state.get(); + if (t != null) { + cleanupAction.accept(t); + } + } + }); + } + } +} diff --git a/src/main/java/org/overrun/pooling/KeyedPool.java b/src/main/java/org/overrun/pooling/KeyedPool.java new file mode 100644 index 0000000..79da87b --- /dev/null +++ b/src/main/java/org/overrun/pooling/KeyedPool.java @@ -0,0 +1,54 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +/** + * A keyed object pool. + * + * @param the type of the key. + * @param the type of the instances in this pool. + * @author squid233 + * @since 0.1.0 + */ +public interface KeyedPool { + /** + * {@return {@code true} if this pool has remaining.} + * + * @param key the key. + */ + boolean hasRemaining(K key); + + /** + * Borrows an object with the given key from this pool. + * + * @param key the key. + * @return the result that contains the instance; or {@link Throwable} if this pool has exceeded the limit. + */ + KeyedResult borrow(K key); + + /** + * Returns the result to this pool. + * + * @param state the state that holds the object instance. + */ + void returning(KeyedPoolObjectState state); + + /** + * Executes the cleanup action of this pool. + */ + void cleanup(); +} diff --git a/src/main/java/org/overrun/pooling/KeyedPoolObjectState.java b/src/main/java/org/overrun/pooling/KeyedPoolObjectState.java new file mode 100644 index 0000000..6a25bdb --- /dev/null +++ b/src/main/java/org/overrun/pooling/KeyedPoolObjectState.java @@ -0,0 +1,46 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** + * The state that holds the instance of the object. + * + * @author squid233 + * @since 0.1.0 + */ +public final class KeyedPoolObjectState { + final K key; + final int id; + private final AtomicReference object; + final AtomicBoolean lent = new AtomicBoolean(true); + + KeyedPoolObjectState(K key, int id, T object) { + this.key = key; + this.id = id; + this.object = new AtomicReference<>(object); + } + + /** + * {@return the instance of the object} + */ + public T get() { + return object.get(); + } +} diff --git a/src/main/java/org/overrun/pooling/KeyedResult.java b/src/main/java/org/overrun/pooling/KeyedResult.java new file mode 100644 index 0000000..7361ef8 --- /dev/null +++ b/src/main/java/org/overrun/pooling/KeyedResult.java @@ -0,0 +1,39 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +/** + * A keyed result that holds the state and an exception. + * + * @author squid233 + * @since 0.1.0 + */ +public /* value */ record KeyedResult(KeyedPoolObjectState state, Throwable throwable) { + /** + * {@return {@code true} if successful} + */ + public boolean successful() { + return state != null && throwable == null; + } + + /** + * {@return {@code true} if failed} + */ + public boolean failed() { + return state == null || throwable != null; + } +} diff --git a/src/main/java/org/overrun/pooling/ObjectPool.java b/src/main/java/org/overrun/pooling/ObjectPool.java new file mode 100644 index 0000000..f445c4e --- /dev/null +++ b/src/main/java/org/overrun/pooling/ObjectPool.java @@ -0,0 +1,107 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.function.Consumer; +import java.util.function.Supplier; + +/** + * A growable object pool that allows borrowing and returning object instances. + * + * @param the type of the instances in this pool. + * @author squid233 + * @since 0.1.0 + */ +public final class ObjectPool implements Pool { + private final Consumer cleanupAction; + private final List> states; + private final Supplier constructor; + + /** + * Creates a growable object pool with the given initial capacity and cleanup action. + * + * @param constructor the constructor of the objects. + * @param cleanupAction the cleanup action of this pool. + * @param initialCapacity the initial capacity of this pool. + */ + public ObjectPool(Supplier constructor, Consumer cleanupAction, int initialCapacity) { + this.cleanupAction = cleanupAction; + this.states = Collections.synchronizedList(new ArrayList<>(initialCapacity)); + this.constructor = constructor; + } + + /** + * Creates a growable object pool with the given initial capacity. + * + * @param constructor the constructor of the objects. + * @param initialCapacity the initial capacity of this pool. + */ + public ObjectPool(Supplier constructor, int initialCapacity) { + this(constructor, null, initialCapacity); + } + + /** + * Creates a growable object pool. + * + * @param constructor the constructor of the objects. + */ + public ObjectPool(Supplier constructor) { + this(constructor, 10); + } + + @Override + public boolean hasRemaining() { + for (PoolObjectState state : states) { + if (!state.lent.get()) return true; + } + return false; + } + + @Override + public Result borrow() { + for (var state : states) { + if (state.lent.compareAndSet(false, true)) { + state.get().reset(); + return new Result<>(state, null); + } + } + final var state = new PoolObjectState<>(states.size(), Objects.requireNonNull(constructor.get())); + states.add(state); + return new Result<>(state, null); + } + + @Override + public void returning(PoolObjectState state) { + state.lent.compareAndSet(true, false); + } + + @Override + public void cleanup() { + if (cleanupAction != null) { + for (PoolObjectState state : states) { + final T t = state.get(); + if (t != null) { + cleanupAction.accept(t); + } + } + } + } +} diff --git a/src/main/java/org/overrun/pooling/Pool.java b/src/main/java/org/overrun/pooling/Pool.java new file mode 100644 index 0000000..5cff986 --- /dev/null +++ b/src/main/java/org/overrun/pooling/Pool.java @@ -0,0 +1,50 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +/** + * An object pool. + * + * @param the type of the instances in this pool. + * @author squid233 + * @since 0.1.0 + */ +public interface Pool { + /** + * {@return {@code true} if this pool has remaining.} + */ + boolean hasRemaining(); + + /** + * Borrows an object from this pool. + * + * @return the result that contains the instance; or {@link Throwable} if this pool has exceeded the limit. + */ + Result borrow(); + + /** + * Returns the result to this pool. + * + * @param state the state that holds the object instance. + */ + void returning(PoolObjectState state); + + /** + * Executes the cleanup action of this pool. + */ + void cleanup(); +} diff --git a/src/main/java/org/overrun/pooling/PoolObjectState.java b/src/main/java/org/overrun/pooling/PoolObjectState.java new file mode 100644 index 0000000..d50d537 --- /dev/null +++ b/src/main/java/org/overrun/pooling/PoolObjectState.java @@ -0,0 +1,44 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** + * The state that holds the instance of the object. + * + * @author squid233 + * @since 0.1.0 + */ +public final class PoolObjectState { + final int id; + private final AtomicReference object; + final AtomicBoolean lent = new AtomicBoolean(true); + + PoolObjectState(int id, T object) { + this.id = id; + this.object = new AtomicReference<>(object); + } + + /** + * {@return the instance of the object} + */ + public T get() { + return object.get(); + } +} diff --git a/src/main/java/org/overrun/pooling/Poolable.java b/src/main/java/org/overrun/pooling/Poolable.java new file mode 100644 index 0000000..887a587 --- /dev/null +++ b/src/main/java/org/overrun/pooling/Poolable.java @@ -0,0 +1,32 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +/** + * A poolable object. + *

+ * These objects must be able to reset their values to prepare for next use. + * + * @author squid233 + * @since 0.1.0 + */ +public interface Poolable { + /** + * Resets the values in this object. + */ + void reset(); +} diff --git a/src/main/java/org/overrun/pooling/Result.java b/src/main/java/org/overrun/pooling/Result.java new file mode 100644 index 0000000..c3147ce --- /dev/null +++ b/src/main/java/org/overrun/pooling/Result.java @@ -0,0 +1,39 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling; + +/** + * A result that holds the state and an exception. + * + * @author squid233 + * @since 0.1.0 + */ +public /* value */ record Result(PoolObjectState state, Throwable throwable) { + /** + * {@return {@code true} if successful} + */ + public boolean successful() { + return state != null && throwable == null; + } + + /** + * {@return {@code true} if failed} + */ + public boolean failed() { + return state == null || throwable != null; + } +} diff --git a/src/test/java/org/overrun/pooling/test/Chunk.java b/src/test/java/org/overrun/pooling/test/Chunk.java new file mode 100644 index 0000000..94430aa --- /dev/null +++ b/src/test/java/org/overrun/pooling/test/Chunk.java @@ -0,0 +1,45 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling.test; + +import java.nio.IntBuffer; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * @author squid233 + * @since 0.1.0 + */ +final class Chunk { + final World world; + final int x, y, z; + final AtomicBoolean submitted = new AtomicBoolean(); + final AtomicBoolean compiled = new AtomicBoolean(); + final AtomicBoolean dirty = new AtomicBoolean(true); + final AtomicInteger data = new AtomicInteger(); + + Chunk(World world, int x, int y, int z) { + this.world = world; + this.x = x; + this.y = y; + this.z = z; + } + + void render(IntBuffer buffer) { + buffer.put(world.data[World.index(x, y, z)]); + } +} diff --git a/src/test/java/org/overrun/pooling/test/ChunkCompiler.java b/src/test/java/org/overrun/pooling/test/ChunkCompiler.java new file mode 100644 index 0000000..80013d5 --- /dev/null +++ b/src/test/java/org/overrun/pooling/test/ChunkCompiler.java @@ -0,0 +1,41 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling.test; + +import org.overrun.pooling.Poolable; + +import java.nio.IntBuffer; + +/** + * @author squid233 + * @since 0.1.0 + */ +final class ChunkCompiler implements Poolable { + final IntBuffer buffer = IntBuffer.allocate(1); + + void compile(Chunk chunk) { + buffer.clear(); + chunk.render(buffer); + buffer.flip(); + chunk.data.set(buffer.get(0)); + } + + @Override + public void reset() { + buffer.clear(); + } +} diff --git a/src/test/java/org/overrun/pooling/test/FixedObjectPoolTest.java b/src/test/java/org/overrun/pooling/test/FixedObjectPoolTest.java new file mode 100644 index 0000000..914edd1 --- /dev/null +++ b/src/test/java/org/overrun/pooling/test/FixedObjectPoolTest.java @@ -0,0 +1,134 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling.test; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.overrun.pooling.FixedObjectPool; +import org.overrun.pooling.Result; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.*; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * @author squid233 + * @since 0.1.0 + */ +class FixedObjectPoolTest { + private static final int SIZE = 4; + static World world; + static FixedObjectPool pool; + static AtomicInteger timer; + static ExecutorService executorService; + + @BeforeAll + static void beforeAll() { + world = new World(); + pool = new FixedObjectPool<>(SIZE, ChunkCompiler::new); + timer = new AtomicInteger(10); + final int processors = Runtime.getRuntime().availableProcessors(); + System.out.println("Using " + processors + " processors"); + executorService = new ThreadPoolExecutor(processors, + processors + 1, + 3, + TimeUnit.SECONDS, + new SynchronousQueue<>(), + (r, executor) -> { + if (!executor.isShutdown() && r instanceof Future future) { + future.cancel(true); + } + }); + } + + static boolean running() { + return timer.get() > 0; + } + + List dirtyChunks() { + List chunks = null; + Chunk[] chunks1 = world.chunks; + for (int i = 0, j = 0; i < chunks1.length && j < SIZE; i++) { + Chunk chunk = chunks1[i]; + if (chunk.dirty.get() && !chunk.submitted.get()) { + if (chunks == null) { + chunks = new ArrayList<>(); + } + chunks.add(chunk); + j++; + } + } + return chunks; + } + + void compile() { + final List dirtyChunks = dirtyChunks(); + if (dirtyChunks != null) { + for (Chunk dirtyChunk : dirtyChunks) { + CompletableFuture.supplyAsync(() -> { + Result result = null; + try { + result = pool.borrow(); + if (result.successful()) { + dirtyChunk.submitted.set(true); + result.state().get().compile(dirtyChunk); + } + } finally { + if (result != null && result.successful()) { + pool.returning(result.state()); + } + } + return dirtyChunk; + }, executorService) + .thenAccept(chunk -> { + chunk.dirty.set(false); + chunk.submitted.set(false); + chunk.compiled.set(true); + }); + } + } + } + + @SuppressWarnings("BusyWait") + @Test + void test() throws InterruptedException { + final Thread renderThread = new Thread(() -> { + while (running()) { + try { + world.render(); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + }, "Render Thread"); + renderThread.setUncaughtExceptionHandler((t, e) -> e.printStackTrace()); + renderThread.start(); + while (running()) { + Thread.sleep(1000); + timer.getAndDecrement(); + compile(); + } + } + + @AfterAll + static void afterAll() { + pool.cleanup(); + executorService.shutdown(); + } +} diff --git a/src/test/java/org/overrun/pooling/test/World.java b/src/test/java/org/overrun/pooling/test/World.java new file mode 100644 index 0000000..682b75d --- /dev/null +++ b/src/test/java/org/overrun/pooling/test/World.java @@ -0,0 +1,60 @@ +/* + * MIT License + * + * Copyright (c) 2023 Overrun Organization + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + */ + +package org.overrun.pooling.test; + +/** + * @author squid233 + * @since 0.1.0 + */ +final class World { + static final int width = 3; + static final int height = 3; + static final int depth = 3; + final int[] data = new int[width * height * depth]; + final Chunk[] chunks = new Chunk[width * height * depth]; + + World() { + for (int x = 0; x < width; x++) { + for (int y = 0; y < height; y++) { + for (int z = 0; z < depth; z++) { + final int i = index(x, y, z); + data[i] = i; + chunks[i] = new Chunk(this, x, y, z); + } + } + } + } + + static int index(int x, int y, int z) { + return (y * depth + z) * width + x; + } + + void render() throws InterruptedException { + System.out.println("----- render -----"); + for (int x = 0; x < width; x++) { + for (int y = 0; y < height; y++) { + for (int z = 0; z < depth; z++) { + final Chunk chunk = chunks[index(x, y, z)]; + if (chunk.compiled.get()) { + System.out.println("x: " + x + ", y: " + y + ", z: " + z + ", data: " + chunk.data.get()); + } + } + } + } + Thread.sleep(1000); + } +}