YARN-6507. NM side FPGA resource handler abstraction component

Author: Zhankun Tang

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java

@@ -1288,6 +1288,27 @@ public static boolean isAclEnabled(Configuration conf) {
   public static final String NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT =
       NM_NETWORK_RESOURCE_PREFIX + "outbound-bandwidth-yarn-mbit";
 
+  /**
+   * Prefix for FPGA configurations. Work in progress: This configuration
+   * parameter may be changed/removed in the future.
+   */
+  @Private
+  public static final String NM_FPGA_RESOURCE_PREFIX = NM_PREFIX
+      + "resource.fpga.";
+
+  /**
+   * This setting controls if resource handling for FPGA operations is enabled.
+   */
+  @Private
+  public static final String NM_FPGA_RESOURCE_ENABLED =
+      NM_FPGA_RESOURCE_PREFIX + "enabled";
+
+  /**
+   * FPGA as a resource is disabled by default.
+   **/
+  @Private
+  public static final boolean DEFAULT_NM_FPGA_RESOURCE_ENABLED = false;
+
   /** NM Webapp address.**/
   public static final String NM_WEBAPP_ADDRESS = NM_PREFIX + "webapp.address";
   public static final int DEFAULT_NM_WEBAPP_PORT = 8042;

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/resource/ResourceUtils.java

@@ -392,6 +392,31 @@ public static Map<String, ResourceInformation> getNodeResourceInformation(
     return readOnlyNodeResources;
   }
 
+  /**
+   * Function to get the device allowed infomation. The value format should be comma separated majorNumber:minorNumber
+   *
+   * <property>
+   *   <name>yarn.nodemanager.resource-types.MCP.allowed</name>
+   *   <value>244:0,245:1</value>
+   * </property>
+   * @return a map of resource type and allowed value string
+   * */
+  public static Map<String, String> getResourceTypeAllowedValue(Configuration conf) {
+    Map<String, String> allowedDevices = new HashMap<>();
+    for (Map.Entry<String, String> entry : conf) {
+      String key = entry.getKey();
+      String value = entry.getValue();
+      if (key.startsWith(YarnConfiguration.NM_RESOURCES_PREFIX)) {
+        String[] parts = key.split("\\.");
+        LOG.info("Found allowed device resource entry " + key);
+        if (parts.length == 5 && parts[4].equalsIgnoreCase("allowed")) {
+          allowedDevices.put(parts[3], value);
+        }
+      }
+    }
+    return allowedDevices;
+  }
+
   private static Map<String, ResourceInformation>
   initializeNodeResourceInformation(Configuration conf) {
     Map<String, ResourceInformation> nodeResources = new HashMap<>();

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.java

@@ -39,7 +39,8 @@ enum CGroupController {
     CPU("cpu"),
     NET_CLS("net_cls"),
     BLKIO("blkio"),
-    MEMORY("memory");
+    MEMORY("memory"),
+    DEVICES("devices");
 
     private final String name;
 
@@ -65,6 +66,7 @@ String getName() {
   String CGROUP_CPU_QUOTA_US = "cfs_quota_us";
   String CGROUP_CPU_SHARES = "shares";
 
+  String CGROUP_PARAM_DEVICE_DENY = "deny";
   /**
    * Mounts or initializes a cgroup controller.
    * @param controller - the controller being initialized

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/Fpga/AbstractFpgaPlugin.java

@@ -0,0 +1,52 @@
+/**
+ * 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.yarn.server.nodemanager.containermanager.linux.resources.Fpga;
+
+import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceStability;
+import org.apache.hadoop.conf.Configuration;
+
+import java.util.List;
+
+
+/**
+ * FPGA plugin interface for vendor to implement
+ *
+ * */
+
+@InterfaceAudience.Private
+@InterfaceStability.Unstable
+public interface AbstractFpgaPlugin {
+
+  boolean initPlugin(String s, Configuration configuration);
+
+  String getExistingIPID(int major, int minor);
+
+  String getFpgaType();
+
+  /**
+   * the vendor should check if the IP file has already been downloaded
+   * */
+  String downloadIP(String id, String dstDir);
+
+  boolean configureIP(String ipPath, FpgaResourceAllocator.FpgaAllocation fpgaAllocations);
+
+  boolean cleanupFpgas(FpgaResourceAllocator.FpgaAllocation fpgaAllocations);
+}

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/Fpga/FpgaPluginChain.java

@@ -0,0 +1,64 @@
+/**
+ * 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.yarn.server.nodemanager.containermanager.linux.resources.Fpga;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.ResourceHandlerException;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+public class FpgaPluginChain{
+
+  private HashMap<String, AbstractFpgaPlugin> plugins;
+
+  FpgaPluginChain(){}
+
+  FpgaPluginChain(HashMap<String, AbstractFpgaPlugin> plugins) {
+    this.plugins = plugins;
+  }
+
+
+  public void addPlugin(AbstractFpgaPlugin plugin) {
+    if (null == plugins) {
+      plugins = new HashMap<>();
+    }
+    plugins.put(plugin.getFpgaType(), plugin);
+  }
+
+  public AbstractFpgaPlugin getPlugin(String type) {
+    return plugins.get(type);
+  }
+
+  public List<AbstractFpgaPlugin> getPlugins() {
+    return new ArrayList<>(plugins.values());
+  }
+
+  public boolean initPlugin(String s, Configuration configuration) {
+    for (AbstractFpgaPlugin plugin : plugins.values()) {
+      if (!plugin.initPlugin(s,configuration)) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+}