|
| 1 | +# Cloud Foundry Java Buildpack |
| 2 | +# Copyright 2017 the original author or authors. |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +require 'fileutils' |
| 17 | +require 'java_buildpack/component/versioned_dependency_component' |
| 18 | +require 'java_buildpack/jre' |
| 19 | +require 'java_buildpack/util/tokenized_version' |
| 20 | + |
| 21 | +module JavaBuildpack |
| 22 | + module Jre |
| 23 | + |
| 24 | + # Encapsulates the detect, compile, and release functionality for selecting a JRE. |
| 25 | + class IbmJreInitializer < JavaBuildpack::Component::VersionedDependencyComponent |
| 26 | + |
| 27 | + # Creates an instance |
| 28 | + # |
| 29 | + # @param [Hash] context a collection of utilities used the component |
| 30 | + def initialize(context) |
| 31 | + @application = context[:application] |
| 32 | + @component_name = context[:component_name] |
| 33 | + @configuration = context[:configuration] |
| 34 | + @droplet = context[:droplet] |
| 35 | + |
| 36 | + @droplet.java_home.root = @droplet.sandbox + 'jre/' |
| 37 | + end |
| 38 | + |
| 39 | + # (see JavaBuildpack::Component::BaseComponent#detect) |
| 40 | + def detect |
| 41 | + @version, @uri = JavaBuildpack::Repository::ConfiguredItem.find_item(@component_name, |
| 42 | + @configuration) |
| 43 | + @droplet.java_home.version = @version |
| 44 | + super |
| 45 | + end |
| 46 | + |
| 47 | + # (see JavaBuildpack::Component::BaseComponent#compile) |
| 48 | + def compile |
| 49 | + download(@version, @uri, @component_name) do |file| |
| 50 | + with_timing "Installing #{@component_name} to #{@droplet.sandbox.relative_path_from(@droplet.root)}" do |
| 51 | + install_bin(@droplet.sandbox, file) |
| 52 | + end |
| 53 | + end |
| 54 | + @droplet.copy_resources |
| 55 | + end |
| 56 | + |
| 57 | + # (see JavaBuildpack::Component::BaseComponent#release) |
| 58 | + def release |
| 59 | + @droplet |
| 60 | + .java_opts |
| 61 | + .add_system_property('java.io.tmpdir', '$TMPDIR') |
| 62 | + .add_option('-XX:OnOutOfMemoryError', killjava) |
| 63 | + .add_preformatted_options('-Xtune:virtualized') |
| 64 | + .add_preformatted_options('-Xshareclasses:none') |
| 65 | + |
| 66 | + @droplet.java_opts.concat mem_opts |
| 67 | + end |
| 68 | + |
| 69 | + private |
| 70 | + |
| 71 | + # constant HEAP_RATIO is the ratio of memory assigned to the heap |
| 72 | + # as against the container total and is set using -Xmx. |
| 73 | + HEAP_RATIO = 0.75 |
| 74 | + |
| 75 | + KILO = 1024 |
| 76 | + |
| 77 | + private_constant :HEAP_RATIO, :KILO |
| 78 | + |
| 79 | + # Installs the Downloaded InstallAnywhere (tm) BIN file to the target directory |
| 80 | + # |
| 81 | + # @param [String] target_directory, Where the java needs to be installed |
| 82 | + # @param [File] file, InstallAnywhere (tm) BIN file |
| 83 | + # @return [Void] |
| 84 | + def install_bin(target_directory, file) |
| 85 | + FileUtils.mkdir_p target_directory |
| 86 | + response_file = Tempfile.new('response.properties') |
| 87 | + response_file.puts('INSTALLER_UI=silent') |
| 88 | + response_file.puts('LICENSE_ACCEPTED=TRUE') |
| 89 | + response_file.puts("USER_INSTALL_DIR=#{target_directory}") |
| 90 | + response_file.close |
| 91 | + |
| 92 | + File.chmod(0o755, file.path) unless File.executable?(file.path) |
| 93 | + shell "#{file.path} -i silent -f #{response_file.path} 2>&1" |
| 94 | + end |
| 95 | + |
| 96 | + # Returns the max heap size ('-Xmx') value |
| 97 | + def mem_opts |
| 98 | + mopts = [] |
| 99 | + total_memory = memory_limit_finder |
| 100 | + if total_memory.nil? |
| 101 | + # if no memory option has been set by cloudfoundry, we just assume defaults |
| 102 | + else |
| 103 | + calculated_heap_ratio = heap_ratio_verification(heap_ratio) |
| 104 | + heap_size = heap_size_calculator(total_memory, calculated_heap_ratio) |
| 105 | + mopts.push "-Xmx#{heap_size}" |
| 106 | + end |
| 107 | + mopts |
| 108 | + end |
| 109 | + |
| 110 | + # Returns the heap_ratio attribute in config file (if specified) or the HEAP_RATIO constant value |
| 111 | + def heap_ratio |
| 112 | + @configuration['heap_ratio'] || HEAP_RATIO |
| 113 | + end |
| 114 | + |
| 115 | + def killjava |
| 116 | + @droplet.sandbox + 'jre/bin/killjava.sh' |
| 117 | + end |
| 118 | + |
| 119 | + # Returns the container total memory limit in bytes |
| 120 | + def memory_limit_finder |
| 121 | + memory_limit = ENV['MEMORY_LIMIT'] |
| 122 | + return nil unless memory_limit |
| 123 | + memory_limit_size = memory_size_bytes(memory_limit) |
| 124 | + raise "Invalid negative $MEMORY_LIMIT #{memory_limit}" if memory_limit_size < 0 |
| 125 | + memory_limit_size |
| 126 | + end |
| 127 | + |
| 128 | + # Returns the no. of bytes for a given string of minified size representation |
| 129 | + # |
| 130 | + # @param [String] size, A minified memory representation string |
| 131 | + # @return [Integer] bytes, value of size in bytes |
| 132 | + def memory_size_bytes(size) |
| 133 | + if size == '0' |
| 134 | + bytes = 0 |
| 135 | + else |
| 136 | + raise "Invalid memory size '#{size}'" if !size || size.length < 2 |
| 137 | + unit = size[-1] |
| 138 | + value = size[0..-2] |
| 139 | + raise "Invalid memory size '#{size}'" unless check_is_integer? value |
| 140 | + value = size.to_i |
| 141 | + # store the bytes |
| 142 | + bytes = calculate_bytes(unit, value) |
| 143 | + end |
| 144 | + bytes |
| 145 | + end |
| 146 | + |
| 147 | + # Returns the no. of bytes for a given memory size unit |
| 148 | + # |
| 149 | + # @param [String] unit, Represents a Memory Size Unit |
| 150 | + # @param [Integer] value |
| 151 | + # @return [Integer] bytes, value of size in bytes |
| 152 | + def calculate_bytes(unit, value) |
| 153 | + if %w[b B].include?(unit) |
| 154 | + bytes = value |
| 155 | + elsif %w[k K].include?(unit) |
| 156 | + bytes = KILO * value |
| 157 | + elsif %w[m M].include?(unit) |
| 158 | + bytes = KILO * KILO * value |
| 159 | + elsif %w[g G].include?(unit) |
| 160 | + bytes = KILO * KILO * KILO * value |
| 161 | + else |
| 162 | + raise "Invalid unit '#{unit}' in memory size" |
| 163 | + end |
| 164 | + bytes |
| 165 | + end |
| 166 | + |
| 167 | + # Checks whether the given value is an Integer |
| 168 | + # |
| 169 | + # @param [String] v, value as a string |
| 170 | + def check_is_integer?(v) |
| 171 | + v = Float(v) |
| 172 | + v && v.floor == v |
| 173 | + end |
| 174 | + |
| 175 | + # Calculates the Heap size as per the Heap ratio |
| 176 | + # |
| 177 | + # @param [Integer] membytes, total memory in bytes |
| 178 | + # @param [Numeric] heapratio, Desired/Default Heap Ratio |
| 179 | + def heap_size_calculator(membytes, heapratio) |
| 180 | + memory_size_minified(membytes * heapratio) |
| 181 | + end |
| 182 | + |
| 183 | + # Calculates the Memory Size in a Minified String Representation |
| 184 | + # |
| 185 | + # @param [Numeric] membytes, calculated heap size |
| 186 | + def memory_size_minified(membytes) |
| 187 | + giga = membytes / 2**(10 * 3) |
| 188 | + mega = membytes / 2**(10 * 2) |
| 189 | + kilo = (membytes / 2**(10 * 1)).round |
| 190 | + if check_is_integer?(giga) |
| 191 | + minified_size_calculator(giga, 'G') |
| 192 | + elsif check_is_integer?(mega) |
| 193 | + minified_size_calculator(mega, 'M') |
| 194 | + elsif check_is_integer?(kilo) |
| 195 | + minified_size_calculator(kilo, 'K') |
| 196 | + end |
| 197 | + end |
| 198 | + |
| 199 | + # Returns the minified memory string |
| 200 | + # |
| 201 | + # @param [Integer] order, calculated memory value |
| 202 | + # @param [String] char, calculated memory unit |
| 203 | + # @return [String] minified memory string |
| 204 | + def minified_size_calculator(order, char) |
| 205 | + order.to_i.to_s + char |
| 206 | + end |
| 207 | + |
| 208 | + # Verifies whether heap ratio is valid |
| 209 | + def heap_ratio_verification(ratio) |
| 210 | + raise 'Invalid heap ratio' unless ratio.is_a? Numeric |
| 211 | + raise 'heap ratio cannot be greater than 100%' unless ratio <= 1 |
| 212 | + ratio |
| 213 | + end |
| 214 | + |
| 215 | + end |
| 216 | + |
| 217 | + end |
| 218 | +end |
0 commit comments