org.apache.sysml.runtime.controlprogram.parfor.RemoteParForMR.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.sysml.runtime.controlprogram.parfor.RemoteParForMR.java

Source

/*
 * 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.sysml.runtime.controlprogram.parfor;

import java.io.IOException;
import java.util.HashMap;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.SequenceFile;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.mapred.Counters.Group;
import org.apache.hadoop.mapred.FileInputFormat;
import org.apache.hadoop.mapred.FileOutputFormat;
import org.apache.hadoop.mapred.JobClient;
import org.apache.hadoop.mapred.JobConf;
import org.apache.hadoop.mapred.RunningJob;
import org.apache.hadoop.mapred.SequenceFileOutputFormat;
import org.apache.hadoop.mapred.lib.NLineInputFormat;
import org.apache.sysml.api.DMLScript;
import org.apache.sysml.conf.ConfigurationManager;
import org.apache.sysml.conf.DMLConfig;
import org.apache.sysml.runtime.DMLRuntimeException;
import org.apache.sysml.runtime.controlprogram.LocalVariableMap;
import org.apache.sysml.runtime.controlprogram.ParForProgramBlock;
import org.apache.sysml.runtime.controlprogram.caching.CacheStatistics;
import org.apache.sysml.runtime.controlprogram.caching.CacheableData;
import org.apache.sysml.runtime.controlprogram.caching.MatrixObject;
import org.apache.sysml.runtime.controlprogram.parfor.stat.InfrastructureAnalyzer;
import org.apache.sysml.runtime.controlprogram.parfor.stat.Stat;
import org.apache.sysml.runtime.instructions.cp.Data;
import org.apache.sysml.runtime.io.IOUtilFunctions;
import org.apache.sysml.runtime.matrix.MatrixCharacteristics;
import org.apache.sysml.runtime.matrix.mapred.MRConfigurationNames;
import org.apache.sysml.runtime.matrix.mapred.MRJobConfiguration;
import org.apache.sysml.runtime.util.MapReduceTool;
import org.apache.sysml.utils.Statistics;
import org.apache.sysml.yarn.DMLAppMasterUtils;

/**
 * MR job class for submitting parfor remote MR jobs, controlling its execution and obtaining results.
 * 
 *
 */
public class RemoteParForMR {

    protected static final Log LOG = LogFactory.getLog(RemoteParForMR.class.getName());

    public static RemoteParForJobReturn runJob(long pfid, String program, String taskFile, String resultFile,
            MatrixObject colocatedDPMatrixObj, //inputs
            boolean enableCPCaching, int numMappers, int replication, int max_retry, long minMem, boolean jvmReuse) //opt params
            throws DMLRuntimeException {
        RemoteParForJobReturn ret = null;
        String jobname = "ParFor-EMR";
        long t0 = DMLScript.STATISTICS ? System.nanoTime() : 0;

        JobConf job;
        job = new JobConf(RemoteParForMR.class);
        job.setJobName(jobname + pfid);

        //maintain dml script counters
        Statistics.incrementNoOfCompiledMRJobs();

        try {
            /////
            //configure the MR job

            //set arbitrary CP program blocks that will perform in the mapper
            MRJobConfiguration.setProgramBlocks(job, program);

            //enable/disable caching
            MRJobConfiguration.setParforCachingConfig(job, enableCPCaching);

            //set mappers, reducers, combiners
            job.setMapperClass(RemoteParWorkerMapper.class); //map-only

            //set input format (one split per row, NLineInputFormat default N=1)
            if (ParForProgramBlock.ALLOW_DATA_COLOCATION && colocatedDPMatrixObj != null) {
                job.setInputFormat(RemoteParForColocatedNLineInputFormat.class);
                MRJobConfiguration.setPartitioningFormat(job, colocatedDPMatrixObj.getPartitionFormat());
                MatrixCharacteristics mc = colocatedDPMatrixObj.getMatrixCharacteristics();
                MRJobConfiguration.setPartitioningBlockNumRows(job, mc.getRowsPerBlock());
                MRJobConfiguration.setPartitioningBlockNumCols(job, mc.getColsPerBlock());
                MRJobConfiguration.setPartitioningFilename(job, colocatedDPMatrixObj.getFileName());
            } else //default case 
            {
                job.setInputFormat(NLineInputFormat.class);
            }

            //set the input path and output path 
            FileInputFormat.setInputPaths(job, new Path(taskFile));

            //set output format
            job.setOutputFormat(SequenceFileOutputFormat.class);

            //set output path
            MapReduceTool.deleteFileIfExistOnHDFS(resultFile);
            FileOutputFormat.setOutputPath(job, new Path(resultFile));

            //set the output key, value schema
            job.setMapOutputKeyClass(LongWritable.class);
            job.setMapOutputValueClass(Text.class);
            job.setOutputKeyClass(LongWritable.class);
            job.setOutputValueClass(Text.class);

            //////
            //set optimization parameters

            //set the number of mappers and reducers 
            job.setNumMapTasks(numMappers); //numMappers
            job.setNumReduceTasks(0);
            //job.setInt("mapred.map.tasks.maximum", 1); //system property
            //job.setInt("mapred.tasktracker.tasks.maximum",1); //system property
            //job.setInt("mapred.jobtracker.maxtasks.per.job",1); //system property

            //set jvm memory size (if require)
            String memKey = MRConfigurationNames.MR_CHILD_JAVA_OPTS;
            if (minMem > 0 && minMem > InfrastructureAnalyzer.extractMaxMemoryOpt(job.get(memKey))) {
                InfrastructureAnalyzer.setMaxMemoryOpt(job, memKey, minMem);
                LOG.warn("Forcing '" + memKey + "' to -Xmx" + minMem / (1024 * 1024) + "M.");
            }

            //disable automatic tasks timeouts and speculative task exec
            job.setInt(MRConfigurationNames.MR_TASK_TIMEOUT, 0);
            job.setMapSpeculativeExecution(false);

            //set up map/reduce memory configurations (if in AM context)
            DMLConfig config = ConfigurationManager.getDMLConfig();
            DMLAppMasterUtils.setupMRJobRemoteMaxMemory(job, config);

            //set up custom map/reduce configurations 
            MRJobConfiguration.setupCustomMRConfigurations(job, config);

            //enables the reuse of JVMs (multiple tasks per MR task)
            if (jvmReuse)
                job.setNumTasksToExecutePerJvm(-1); //unlimited

            //set sort io buffer (reduce unnecessary large io buffer, guaranteed memory consumption)
            job.setInt(MRConfigurationNames.MR_TASK_IO_SORT_MB, 8); //8MB

            //set the replication factor for the results
            job.setInt(MRConfigurationNames.DFS_REPLICATION, replication);

            //set the max number of retries per map task
            //  disabled job-level configuration to respect cluster configuration
            //  note: this refers to hadoop2, hence it never had effect on mr1
            //job.setInt(MRConfigurationNames.MR_MAP_MAXATTEMPTS, max_retry);

            //set unique working dir
            MRJobConfiguration.setUniqueWorkingDir(job);

            /////
            // execute the MR job         
            RunningJob runjob = JobClient.runJob(job);

            // Process different counters 
            Statistics.incrementNoOfExecutedMRJobs();
            Group pgroup = runjob.getCounters().getGroup(ParForProgramBlock.PARFOR_COUNTER_GROUP_NAME);
            int numTasks = (int) pgroup.getCounter(Stat.PARFOR_NUMTASKS.toString());
            int numIters = (int) pgroup.getCounter(Stat.PARFOR_NUMITERS.toString());
            if (DMLScript.STATISTICS && !InfrastructureAnalyzer.isLocalMode()) {
                Statistics.incrementJITCompileTime(pgroup.getCounter(Stat.PARFOR_JITCOMPILE.toString()));
                Statistics.incrementJVMgcCount(pgroup.getCounter(Stat.PARFOR_JVMGC_COUNT.toString()));
                Statistics.incrementJVMgcTime(pgroup.getCounter(Stat.PARFOR_JVMGC_TIME.toString()));
                Group cgroup = runjob.getCounters().getGroup(CacheableData.CACHING_COUNTER_GROUP_NAME.toString());
                CacheStatistics
                        .incrementMemHits((int) cgroup.getCounter(CacheStatistics.Stat.CACHE_HITS_MEM.toString()));
                CacheStatistics.incrementFSBuffHits(
                        (int) cgroup.getCounter(CacheStatistics.Stat.CACHE_HITS_FSBUFF.toString()));
                CacheStatistics
                        .incrementFSHits((int) cgroup.getCounter(CacheStatistics.Stat.CACHE_HITS_FS.toString()));
                CacheStatistics.incrementHDFSHits(
                        (int) cgroup.getCounter(CacheStatistics.Stat.CACHE_HITS_HDFS.toString()));
                CacheStatistics.incrementFSBuffWrites(
                        (int) cgroup.getCounter(CacheStatistics.Stat.CACHE_WRITES_FSBUFF.toString()));
                CacheStatistics.incrementFSWrites(
                        (int) cgroup.getCounter(CacheStatistics.Stat.CACHE_WRITES_FS.toString()));
                CacheStatistics.incrementHDFSWrites(
                        (int) cgroup.getCounter(CacheStatistics.Stat.CACHE_WRITES_HDFS.toString()));
                CacheStatistics
                        .incrementAcquireRTime(cgroup.getCounter(CacheStatistics.Stat.CACHE_TIME_ACQR.toString()));
                CacheStatistics
                        .incrementAcquireMTime(cgroup.getCounter(CacheStatistics.Stat.CACHE_TIME_ACQM.toString()));
                CacheStatistics
                        .incrementReleaseTime(cgroup.getCounter(CacheStatistics.Stat.CACHE_TIME_RLS.toString()));
                CacheStatistics
                        .incrementExportTime(cgroup.getCounter(CacheStatistics.Stat.CACHE_TIME_EXP.toString()));
            }

            // read all files of result variables and prepare for return
            LocalVariableMap[] results = readResultFile(job, resultFile);

            ret = new RemoteParForJobReturn(runjob.isSuccessful(), numTasks, numIters, results);
        } catch (Exception ex) {
            throw new DMLRuntimeException(ex);
        } finally {
            // remove created files 
            try {
                MapReduceTool.deleteFileIfExistOnHDFS(new Path(taskFile), job);
                MapReduceTool.deleteFileIfExistOnHDFS(new Path(resultFile), job);
            } catch (IOException ex) {
                throw new DMLRuntimeException(ex);
            }
        }

        if (DMLScript.STATISTICS) {
            long t1 = System.nanoTime();
            Statistics.maintainCPHeavyHitters("MR-Job_" + jobname, t1 - t0);
        }

        return ret;
    }

    /**
     * Result file contains hierarchy of workerID-resultvar(incl filename). We deduplicate
     * on the workerID. Without JVM reuse each task refers to a unique workerID, so we
     * will not find any duplicates. With JVM reuse, however, each slot refers to a workerID, 
     * and there are duplicate filenames due to partial aggregation and overwrite of fname 
     * (the RemoteParWorkerMapper ensures uniqueness of those files independent of the 
     * runtime implementation). 
     * 
     * @param job job configuration
     * @param fname file name
     * @return array of local variable maps
     * @throws DMLRuntimeException if DMLRuntimeException occurs
     * @throws IOException if IOException occurs
     */
    @SuppressWarnings("deprecation")
    public static LocalVariableMap[] readResultFile(JobConf job, String fname)
            throws DMLRuntimeException, IOException {
        HashMap<Long, LocalVariableMap> tmp = new HashMap<>();

        Path path = new Path(fname);
        FileSystem fs = IOUtilFunctions.getFileSystem(path, job);
        LongWritable key = new LongWritable(); //workerID
        Text value = new Text(); //serialized var header (incl filename)

        int countAll = 0;
        for (Path lpath : IOUtilFunctions.getSequenceFilePaths(fs, path)) {
            SequenceFile.Reader reader = new SequenceFile.Reader(fs, lpath, job);
            try {
                while (reader.next(key, value)) {
                    //System.out.println("key="+key.get()+", value="+value.toString());
                    if (!tmp.containsKey(key.get()))
                        tmp.put(key.get(), new LocalVariableMap());
                    Object[] dat = ProgramConverter.parseDataObject(value.toString());
                    tmp.get(key.get()).put((String) dat[0], (Data) dat[1]);
                    countAll++;
                }
            } finally {
                IOUtilFunctions.closeSilently(reader);
            }
        }

        LOG.debug("Num remote worker results (before deduplication): " + countAll);
        LOG.debug("Num remote worker results: " + tmp.size());

        //create return array
        return tmp.values().toArray(new LocalVariableMap[0]);
    }
}