| /** |
| * 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.hadoop.mapreduce.util; |
| |
| import org.apache.hadoop.classification.InterfaceAudience; |
| import org.apache.hadoop.classification.InterfaceStability; |
| import org.apache.hadoop.conf.Configuration; |
| import org.apache.hadoop.conf.Configured; |
| import org.apache.hadoop.util.ReflectionUtils; |
| |
| /** |
| * Plugin to calculate virtual and physical memories on the system. |
| * @deprecated Use |
| * {@link org.apache.hadoop.mapreduce.util.ResourceCalculatorPlugin} |
| * instead |
| */ |
| @Deprecated |
| @InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract class MemoryCalculatorPlugin extends Configured { |
| |
| /** |
| * Obtain the total size of the virtual memory present in the system. |
| * |
| * @return virtual memory size in bytes. |
| */ |
| public abstract long getVirtualMemorySize(); |
| |
| /** |
| * Obtain the total size of the physical memory present in the system. |
| * |
| * @return physical memory size bytes. |
| */ |
| public abstract long getPhysicalMemorySize(); |
| |
| /** |
| * Get the MemoryCalculatorPlugin from the class name and configure it. If |
| * class name is null, this method will try and return a memory calculator |
| * plugin available for this system. |
| * |
| * @param clazz class-name |
| * @param conf configure the plugin with this. |
| * @return MemoryCalculatorPlugin |
| */ |
| public static MemoryCalculatorPlugin getMemoryCalculatorPlugin( |
| Class<? extends MemoryCalculatorPlugin> clazz, Configuration conf) { |
| |
| if (clazz != null) { |
| return ReflectionUtils.newInstance(clazz, conf); |
| } |
| |
| // No class given, try a os specific class |
| try { |
| String osName = System.getProperty("os.name"); |
| if (osName.startsWith("Linux")) { |
| return new LinuxMemoryCalculatorPlugin(); |
| } |
| } catch (SecurityException se) { |
| // Failed to get Operating System name. |
| return null; |
| } |
| |
| // Not supported on this system. |
| return null; |
| } |
| } |