Skip to content

Fix sizing of Maps #3868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 2.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.test.ThreadContextUtilityClass;
import org.apache.logging.log4j.test.junit.UsingAnyThreadContext;
import org.apache.logging.log4j.util.Maps;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -115,7 +115,7 @@ void testPutAll() {
assertTrue(ThreadContext.isEmpty());
assertFalse(ThreadContext.containsKey("key"));
final int mapSize = 10;
final Map<String, String> newMap = new HashMap<>(mapSize);
final Map<String, String> newMap = Maps.newHashMap(mapSize);
for (int i = 1; i <= mapSize; i++) {
newMap.put("key" + i, "value" + i);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import org.apache.logging.log4j.test.junit.UsingThreadContextMap;
import org.apache.logging.log4j.test.spi.ThreadContextMapSuite;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.PropertiesUtil;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -56,7 +56,7 @@ void testPutAll() {
assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
final int mapSize = 10;
final Map<String, String> newMap = new HashMap<>(mapSize);
final Map<String, String> newMap = Maps.newHashMap(mapSize);
for (int i = 1; i <= mapSize; i++) {
newMap.put("key" + i, "value" + i);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.util.Maps;

/**
* Adds entries to the {@link ThreadContext stack or map} and them removes them when the object is closed, e.g. as part
Expand Down Expand Up @@ -206,7 +207,7 @@ public void close() {
}

private void closeMap() {
final Map<String, String> valuesToReplace = new HashMap<>(originalValues.size());
final Map<String, String> valuesToReplace = Maps.newHashMap(originalValues.size());
final List<String> keysToRemove = new ArrayList<>(originalValues.size());
for (final Map.Entry<String, String> entry : originalValues.entrySet()) {
final String key = entry.getKey();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.ServiceLoader;
import org.apache.logging.log4j.message.ThreadDumpMessage.ThreadInfoFactory;
import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.Lazy;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.ServiceLoaderUtil;
import org.apache.logging.log4j.util.StringBuilderFormattable;
import org.apache.logging.log4j.util.Strings;
Expand Down Expand Up @@ -176,7 +176,7 @@ private static class BasicThreadInfoFactory implements ThreadInfoFactory {
@Override
public Map<ThreadInformation, StackTraceElement[]> createThreadInfo() {
final Map<Thread, StackTraceElement[]> map = Thread.getAllStackTraces();
final Map<ThreadInformation, StackTraceElement[]> threads = new HashMap<>(map.size());
final Map<ThreadInformation, StackTraceElement[]> threads = Maps.newHashMap(map.size());
for (final Map.Entry<Thread, StackTraceElement[]> entry : map.entrySet()) {
threads.put(new BasicThreadInformation(entry.getKey()), entry.getValue());
}
Expand Down
53 changes: 53 additions & 0 deletions log4j-api/src/main/java/org/apache/logging/log4j/util/Maps.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you 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 org.apache.logging.log4j.util;

import java.util.HashMap;
import java.util.LinkedHashMap;

public final class Maps {
private Maps() {}

/**
* Calculate initial capacity from expected size and default load factor (0.75).
*/
private static int calculateCapacity(int numMappings) {
return (int) Math.ceil(numMappings / 0.75d);
}

/**
* Creates a new, empty HashMap suitable for the expected number of mappings.
* The returned map is large enough so that the expected number of mappings can be
* added without resizing the map.
*
* This is essentially a backport of HashMap.newHashMap which was added in JDK19.
*/
public static <K, V> HashMap<K, V> newHashMap(int numMappings) {
return new HashMap<>(calculateCapacity(numMappings));
}

/**
* Creates a new, empty LinkedHashMap suitable for the expected number of mappings.
* The returned map is large enough so that the expected number of mappings can be
* added without resizing the map.
*
* This is essentially a backport of LinkedHashMap.newLinkedHashMap which was added in JDK19.
*/
public static <K, V> LinkedHashMap<K, V> newLinkedHashMap(int numMappings) {
return new LinkedHashMap<>(calculateCapacity(numMappings));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import java.io.Serializable;
import java.util.Arrays;
import java.util.ConcurrentModificationException;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import org.apache.logging.log4j.util.internal.SerializationUtil;
Expand Down Expand Up @@ -152,7 +151,7 @@ public boolean containsKey(final String key) {

@Override
public Map<String, String> toMap() {
final Map<String, String> result = new HashMap<>(size());
final Map<String, String> result = Maps.newHashMap(size());
for (int i = 0; i < size(); i++) {
final Object value = getValueAt(i);
result.put(getKeyAt(i), value == null ? null : String.valueOf(value));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import org.apache.logging.log4j.spi.ThreadContextMap;
import org.apache.logging.log4j.test.spi.ThreadContextMapSuite;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.PropertiesUtil;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -52,7 +52,7 @@ void testPutAll() {
assertTrue(map.isEmpty());
assertFalse(map.containsKey("key"));
final int mapSize = 10;
final Map<String, String> newMap = new HashMap<>(mapSize);
final Map<String, String> newMap = Maps.newHashMap(mapSize);
for (int i = 1; i <= mapSize; i++) {
newMap.put("key" + i, "value" + i);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
*/
package org.apache.logging.log4j.core.appender;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.core.Appender;
Expand All @@ -29,6 +28,7 @@
import org.apache.logging.log4j.core.config.plugins.PluginNode;
import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.Maps;

/**
* A deferred plugin for appenders.
Expand Down Expand Up @@ -60,7 +60,7 @@ public AppenderSet build() {
LOGGER.error("No children node in AppenderSet {}", this);
return null;
}
final Map<String, Node> map = new HashMap<>(children.size());
final Map<String, Node> map = Maps.newHashMap(children.size());
for (final Node childNode : children) {
final String key = childNode.getAttributes().get("name");
if (key == null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

import static org.apache.logging.log4j.util.Strings.toRootUpperCase;

import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.Core;
Expand All @@ -29,6 +28,7 @@
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.impl.Log4jLogEvent;
import org.apache.logging.log4j.core.util.KeyValuePair;
import org.apache.logging.log4j.util.Maps;

/**
* Rewrites log event levels for a given logger name.
Expand All @@ -45,11 +45,9 @@ public class LoggerNameLevelRewritePolicy implements RewritePolicy {
/**
* Creates a policy to rewrite levels for a given logger name.
*
* @param loggerNamePrefix
* The logger name prefix for events to rewrite; all event logger names that start with this string will be
* rewritten.
* @param levelPairs
* The levels to rewrite, the key is the source level, the value the target level.
* @param loggerNamePrefix The logger name prefix for events to rewrite; all event logger names that start with this string will be
* rewritten.
* @param levelPairs The levels to rewrite, the key is the source level, the value the target level.
* @return a new LoggerNameLevelRewritePolicy
*/
@PluginFactory
Expand All @@ -58,7 +56,7 @@ public static LoggerNameLevelRewritePolicy createPolicy(
@PluginAttribute("logger") final String loggerNamePrefix,
@PluginElement("KeyValuePair") final KeyValuePair[] levelPairs) {
// @formatter:on
final Map<Level, Level> newMap = new HashMap<>(levelPairs.length);
final Map<Level, Level> newMap = Maps.newHashMap(levelPairs.length);
for (final KeyValuePair keyValuePair : levelPairs) {
newMap.put(getLevel(keyValuePair.getKey()), getLevel(keyValuePair.getValue()));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package org.apache.logging.log4j.core.appender.rewrite;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.Logger;
Expand All @@ -32,6 +31,7 @@
import org.apache.logging.log4j.core.impl.ContextDataFactory;
import org.apache.logging.log4j.core.impl.Log4jLogEvent;
import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.StringMap;

/**
Expand All @@ -55,7 +55,7 @@ public final class PropertiesRewritePolicy implements RewritePolicy {

private PropertiesRewritePolicy(final Configuration config, final List<Property> props) {
this.config = config;
this.properties = new HashMap<>(props.size());
this.properties = Maps.newHashMap(props.size());
for (final Property property : props) {
final Boolean interpolate = Boolean.valueOf(property.getValue().contains("${"));
properties.put(property, interpolate);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.util.IndexedReadOnlyStringMap;
import org.apache.logging.log4j.util.IndexedStringMap;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.PerformanceSensitive;
import org.apache.logging.log4j.util.ReadOnlyStringMap;
import org.apache.logging.log4j.util.SortedArrayStringMap;
Expand Down Expand Up @@ -286,7 +287,7 @@ protected boolean isAnd() {
/** @deprecated use {@link #getStringMap()} instead */
@Deprecated
protected Map<String, List<String>> getMap() {
final Map<String, List<String>> result = new HashMap<>(map.size());
final Map<String, List<String>> result = Maps.newHashMap(map.size());
map.forEach((key, value) -> result.put(key, (List<String>) value));
return result;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.util.Maps;

/**
* <p>
Expand All @@ -46,7 +47,7 @@ public Map<String, String> deserialize(final JsonParser jp, final Deserializatio
new TypeReference<List<MapEntry>>() {
// empty
});
final HashMap<String, String> map = new HashMap<>(list.size());
final HashMap<String, String> map = Maps.newHashMap(list.size());
for (final MapEntry mapEntry : list) {
map.put(mapEntry.getKey(), mapEntry.getValue());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
import java.io.IOException;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.LinkedHashMap;
import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
Expand All @@ -43,6 +42,7 @@
import org.apache.logging.log4j.core.util.KeyValuePair;
import org.apache.logging.log4j.core.util.StringBuilderWriter;
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.ReadOnlyStringMap;
import org.apache.logging.log4j.util.Strings;

Expand Down Expand Up @@ -356,7 +356,7 @@ protected Object wrapLogEvent(final LogEvent event) {

private Map<String, String> resolveAdditionalFields(final LogEvent logEvent) {
// Note: LinkedHashMap retains order
final Map<String, String> additionalFieldsMap = new LinkedHashMap<>(additionalFields.length);
final Map<String, String> additionalFieldsMap = Maps.newLinkedHashMap(additionalFields.length);
final StrSubstitutor strSubstitutor = configuration.getStrSubstitutor();

// Go over each field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
import org.apache.logging.log4j.message.StructuredDataCollectionMessage;
import org.apache.logging.log4j.message.StructuredDataId;
import org.apache.logging.log4j.message.StructuredDataMessage;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.ProcessIdUtil;
import org.apache.logging.log4j.util.StringBuilders;
import org.apache.logging.log4j.util.Strings;
Expand Down Expand Up @@ -219,7 +220,7 @@ private Rfc5424Layout(

private Map<String, FieldFormatter> createFieldFormatters(
final LoggerFields[] loggerFields, final Configuration config) {
final Map<String, FieldFormatter> sdIdMap = new HashMap<>(loggerFields == null ? 0 : loggerFields.length);
final Map<String, FieldFormatter> sdIdMap = Maps.newHashMap(loggerFields == null ? 0 : loggerFields.length);
if (loggerFields != null) {
for (final LoggerFields loggerField : loggerFields) {
final StructuredDataId key = loggerField.getSdId() == null ? mdcSdId : loggerField.getSdId();
Expand Down Expand Up @@ -908,7 +909,7 @@ public FieldFormatter(final Map<String, List<PatternFormatter>> fieldMap, final
}

public StructuredDataElement format(final LogEvent event) {
final Map<String, String> map = new HashMap<>(delegateMap.size());
final Map<String, String> map = Maps.newHashMap(delegateMap.size());

for (final Map.Entry<String, List<PatternFormatter>> entry : delegateMap.entrySet()) {
final StringBuilder buffer = new StringBuilder();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
*/
package org.apache.logging.log4j.core.lookup;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.message.MapMessage;
import org.apache.logging.log4j.util.Maps;
import org.apache.logging.log4j.util.Strings;

/**
Expand Down Expand Up @@ -62,10 +62,6 @@ static Map<String, String> initMap(final String[] srcArgs, final Map<String, Str
return destMap;
}

static HashMap<String, String> newMap(final int initialCapacity) {
return new HashMap<>(initialCapacity);
}

/**
* An application's {@code public static main(String[])} method calls this method to make its main arguments
* available for lookup with the prefix {@code main}.
Expand Down Expand Up @@ -102,14 +98,14 @@ static Map<String, String> toMap(final List<String> args) {
return null;
}
final int size = args.size();
return initMap(args.toArray(Strings.EMPTY_ARRAY), newMap(size));
return initMap(args.toArray(Strings.EMPTY_ARRAY), Maps.newHashMap(size));
}

static Map<String, String> toMap(final String[] args) {
if (args == null) {
return null;
}
return initMap(args, newMap(args.length));
return initMap(args, Maps.newHashMap(args.length));
}

protected Map<String, String> getMap() {
Expand Down
Loading
Loading