Skip to content
Closed
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
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2007, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2007, 2025, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
Expand Down Expand Up @@ -90,6 +90,13 @@ public Soundbank getSoundbank(AudioInputStream ais)
"Can not allocate enough memory to read audio data.");
}

long maximumHeapSize = (long) ((Runtime.getRuntime().maxMemory() -
(Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory())) * 0.9);
if (totalSize > maximumHeapSize) {
throw new InvalidMidiDataException(
"Insufficient heap size to render audio data.");
}

if (ais.getFrameLength() == -1 || totalSize > MEGABYTE) {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buff = new byte[DEFAULT_BUFFER_SIZE - (DEFAULT_BUFFER_SIZE % frameSize)];
Expand Down
53 changes: 53 additions & 0 deletions test/jdk/javax/sound/midi/BulkSoundBank/BulkSoundBank.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

import javax.sound.midi.InvalidMidiDataException;
import javax.sound.midi.MidiSystem;
import java.io.ByteArrayInputStream;
import java.io.IOException;

/**
* @test
* @bug 8350813
* @summary Rendering of bulky sound bank from MIDI sequence can cause OutOfMemoryError.
* @run main/othervm -Xmx1g BulkSoundBank
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test can still throw OOME with @run main/othervm -Xmx2g BulkSoundBank after the fix. (Tested on Ubuntu 22.04)

So it looks like the condition when we throw the InvalidMidiDataException should be tuned.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can not predict OOME reliably - if size of the rendered data is 99% of the remaining heap and the file i/o or background task takes more than 2% of it - the memory will eventually end, there always will be corner cases no matter what treshold we choose. In the end rendering such a huge bank will take minutes and background task might consume more memory at the time. The code here stops OOME when we know for sure we will not have enough resources and lowering the amount might stop the legitimate use case from working.

*/

public class BulkSoundBank {
static final byte[] midi = {77, 84, 104, 100, 0, 0, 0, 6, 0, 0, 0, 1, 1,
-32, 77, 84, 114, 107, 0, 0, 0, 50, 0, -1, 88, 4, 4, 2, 24, 8, 0, -1,
81, 3, 7, -95, 32, 0, -112, 60, 64, -125, 96, -128, 60, 64, -125, -44,
-51, 32, -112, 48, 64, 1, -128, 48, 64, -127, -64, -45, 127, -112, 60,
64, 1, -128, 60, 64, 0, -1, 47, 0};

public static void main(String[] args) throws IOException {
try (ByteArrayInputStream bis = new ByteArrayInputStream(midi)) {
MidiSystem.getSoundbank(bis);
throw new RuntimeException("Test should throw InvalidMidiDataException"
+ " but it did not.");
} catch (InvalidMidiDataException imda) {
System.out.println("Caught InvalidMidiDataException as expected");
}
}
}