cavis/libnd4j/include/graph/profiling/GraphProfile.h

/*******************************************************************************
 * Copyright (c) 2015-2018 Skymind, Inc.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License, Version 2.0 which is available at
 * https://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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ******************************************************************************/

//
//  @author raver119@gmail.com
//

#ifndef ND4J_GRAPH_PROFILE_H
#define ND4J_GRAPH_PROFILE_H

#include "NodeProfile.h"
#include <system/pointercast.h>
#include <system/dll.h>
#include <vector>
#include <string>
#include <map>
#include <chrono>

namespace sd {
    namespace graph {
        class ND4J_EXPORT GraphProfile {
        private:
            // this variable
            Nd4jLong _merges = 1L;

            /**
             * This is global memory values
             */
            Nd4jLong _memoryTotal = 0L;
            Nd4jLong _memoryActivations = 0L;
            Nd4jLong _memoryTemporary = 0L;
            Nd4jLong _memoryObjects = 0L;

            // time spent for graph construction
            Nd4jLong _buildTime = 0L;

            // time spent for graph execution
            Nd4jLong _executionTime = 0L;

            // collection of pointers to profile results 
            std::vector<NodeProfile *> _profiles;
            std::map<int, NodeProfile *> _profilesById;

            // collection of various timing reports
            std::map<std::string, Nd4jLong> _timings;
            std::chrono::time_point<std::chrono::system_clock> _last;

            std::map<std::string, std::chrono::time_point<std::chrono::system_clock>> _timers;

            void updateLast();
        public:
            GraphProfile();
            ~GraphProfile();

            /**
             * These methods just adding amount of bytes to various counters
             */
            void addToTotal(Nd4jLong bytes);
            void addToActivations(Nd4jLong bytes);
            void addToTemporary(Nd4jLong bytes);
            void addToObjects(Nd4jLong bytes);

            /**
             * This method allows to set graph construction (i.e. deserialization) time in nanoseconds
             */
            void setBuildTime(Nd4jLong nanos);

            /**
             * This method sets graph execution time in nanoseconds.
             */
            void setExecutionTime(Nd4jLong nanos);

            void startEvent(const char *name);
            void recordEvent(const char *name);
            void deleteEvent(const char *name);

            /**
             * This method saves time as delta from last saved time
             */
            void spotEvent(const char *name);

            /**
             * This method returns pointer to NodeProfile by ID
             * PLEASE NOTE: this method will create new NodeProfile if there's none
             */
            NodeProfile* nodeById(int id, const char *name = nullptr);
            bool nodeExists(int id);

            /**
             * This method merges values from other profile report
             * @param other
             */
            void merge(GraphProfile *other);
            void assign(GraphProfile *other);

            /**
             * These methods are just utility methods for time
             */
            static Nd4jLong currentTime();
            static Nd4jLong relativeTime(Nd4jLong time);

            void printOut();
        };
    }
}

#endif