EIC code displayed by LXR master/​pilot2/​pilot/​util/​timing.py	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-04-10 08:39:18

 #!/usr/bin/env python
 # Licensed 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
 #
 # Authors:
 # - Paul Nilsson, paul.nilsson@cern.ch, 2018
 
 # Note: The Pilot 2 modules that need to record timing measurements, can do so using the add_to_pilot_timing() function.
 # When the timing measurements need to be recorded, the high-level functions, e.g. get_getjob_time(), can be used.
 
 # Structure of pilot timing dictionary:
 #     { job_id: { <timing_constant_1>: <time measurement in seconds since epoch>, .. }
 # job_id = 0 means timing information from wrapper. Timing constants are defined in pilot.util.constants.
 # Time measurement are time.time() values. The float value will be converted to an int as a last step.
 
 import os
 import time
 
 from pilot.util.config import config
 from pilot.util.constants import PILOT_START_TIME, PILOT_PRE_GETJOB, PILOT_POST_GETJOB, PILOT_PRE_SETUP, \
     PILOT_POST_SETUP, PILOT_PRE_STAGEIN, PILOT_POST_STAGEIN, PILOT_PRE_PAYLOAD, PILOT_POST_PAYLOAD, PILOT_PRE_STAGEOUT,\
     PILOT_POST_STAGEOUT, PILOT_PRE_FINAL_UPDATE, PILOT_POST_FINAL_UPDATE, PILOT_END_TIME, PILOT_MULTIJOB_START_TIME
 from pilot.util.filehandling import read_json, write_json
 #from pilot.util.mpi import get_ranks_info
 
 import logging
 logger = logging.getLogger(__name__)
 
 
 def read_pilot_timing():
     """
     Read the pilot timing dictionary from file.
 
     :return: pilot timing dictionary (json dictionary).
     """
 
     pilot_timing_dictionary = {}
 
     path = os.path.join(os.environ.get('PILOT_HOME', ''), config.Pilot.timing_file)
     if os.path.exists(path):
         pilot_timing_dictionary = read_json(path)
 
     return pilot_timing_dictionary
 
 
 def write_pilot_timing(pilot_timing_dictionary):
     """
     Write the given pilot timing dictionary to file.
 
     :param pilot_timing_dictionary:
     :return:
     """
     timing_file = config.Pilot.timing_file
     #rank, max_ranks = get_ranks_info()
     #if rank is not None:
     #    timing_file += '_{0}'.format(rank)
     path = os.path.join(os.environ.get('PILOT_HOME', ''), timing_file)
     if write_json(path, pilot_timing_dictionary):
         logger.debug('updated pilot timing dictionary: %s' % path)
     else:
         logger.warning('failed to update pilot timing dictionary: %s' % path)
 
 
 def add_to_pilot_timing(job_id, timing_constant, time_measurement, args, store=False):
     """
     Add the given timing contant and measurement got job_id to the pilot timing dictionary.
 
     :param job_id: PanDA job id (string).
     :param timing_constant: timing constant (string).
     :param time_measurement: time measurement (float).
     :param args: pilot arguments.
     :param store: if True, write timing dictionary to file. False by default.
     :return:
     """
 
     if args.timing == {}:
         args.timing[job_id] = {timing_constant: time_measurement}
     else:
         if job_id not in args.timing:
             args.timing[job_id] = {}
         args.timing[job_id][timing_constant] = time_measurement
 
     # update the file
     if store:
         write_pilot_timing(args.timing)
 
 
 def get_initial_setup_time(job_id, args):
     """
     High level function that returns the time for the initial setup.
     The initial setup time is measured from PILOT_START_TIME to PILOT_PRE_GETJOB.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_MULTIJOB_START_TIME, PILOT_PRE_GETJOB, args)
 
 
 def get_getjob_time(job_id, args):
     """
     High level function that returns the time for the getjob operation for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_GETJOB, PILOT_POST_GETJOB, args)
 
 
 def get_setup_time(job_id, args):
     """
     High level function that returns the time for the setup operation for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_SETUP, PILOT_POST_SETUP, args)
 
 
 def get_stagein_time(job_id, args):
     """
     High level function that returns the time for the stage-in operation for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_STAGEIN, PILOT_POST_STAGEIN, args)
 
 
 def get_stageout_time(job_id, args):
     """
     High level function that returns the time for the stage-out operation for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_STAGEOUT, PILOT_POST_STAGEOUT, args)
 
 
 def get_payload_execution_time(job_id, args):
     """
     High level function that returns the time for the payload execution for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_PAYLOAD, PILOT_POST_PAYLOAD, args)
 
 
 def get_final_update_time(job_id, args):
     """
     High level function that returns the time for execution the final update for the given job_id.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_PRE_FINAL_UPDATE, PILOT_POST_FINAL_UPDATE, args)
 
 
 def get_total_pilot_time(job_id, args):
     """
     High level function that returns the end time for the given job_id.
     This means the wall time that has passed from the start of the pilot until after the last job update.
 
     :param job_id: PanDA job id (string).
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_difference(job_id, PILOT_START_TIME, PILOT_END_TIME, args)
 
 
 def get_postgetjob_time(job_id, args):
     """
     Return the post getjob time.
 
     :param job_id: job object.
     :param args: pilot arguments.
     :return: post getjob time measurement (int). In case of failure, return None.
     """
 
     time_measurement = None
     timing_constant = PILOT_POST_GETJOB
 
     if job_id in args.timing:
         # extract time measurements
         time_measurement_dictionary = args.timing.get(job_id, None)
         if time_measurement_dictionary:
             time_measurement = time_measurement_dictionary.get(timing_constant, None)
 
         if not time_measurement:
             logger.warning('failed to extract time measurement %s from %s (no such key)' % (timing_constant, time_measurement_dictionary))
 
     return time_measurement
 
 
 def get_time_measurement(timing_constant, time_measurement_dictionary, timing_dictionary, job_id):
     """
     Return a requested time measurement from the time measurement dictionary, read from the pilot timing file.
 
     :param timing_constant: timing constant (e.g. PILOT_MULTIJOB_START_TIME)
     :param time_measurement_dictionary: time measurement dictionary, extracted from pilot timing dictionary.
     :param timing_dictionary: full timing dictionary from pilot timing file.
     :param job_id: PanDA job id (string).
     :return: time measurement (float).
     """
 
     time_measurement = time_measurement_dictionary.get(timing_constant, None)
     if not time_measurement:
         # try to get the measurement for the PILOT_MULTIJOB_START_TIME dictionary
         i = '0' if timing_constant == PILOT_START_TIME else '1'
         time_measurement_dictionary_0 = timing_dictionary.get(i, None)
         if time_measurement_dictionary_0:
             time_measurement = time_measurement_dictionary_0.get(timing_constant, None)
         else:
             logger.warning('failed to extract time measurement %s from %s (no such key)' % (timing_constant, time_measurement_dictionary))
 
     return time_measurement
 
 
 def get_time_since_start(args):
     """
     Return the amount of time that has passed since the pilot was launched.
 
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_since('0', PILOT_START_TIME, args)
 
 
 def get_time_since_multijob_start(args):
     """
     Return the amount of time that has passed since the last multi job was launched.
 
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     return get_time_since('1', PILOT_MULTIJOB_START_TIME, args)
 
 
 def get_time_since(job_id, timing_constant, args):
     """
     Return the amount of time that has passed since the time measurement of timing_constant.
 
     :param job_id: PanDA job id (string).
     :param timing_constant:
     :param args: pilot arguments.
     :return: time in seconds (int).
     """
 
     diff = 0
 
     if job_id in args.timing:
 
         # extract time measurements
         time_measurement_dictionary = args.timing.get(job_id, None)
         if time_measurement_dictionary:
             time_measurement = get_time_measurement(timing_constant, time_measurement_dictionary,
                                                     args.timing, job_id)
             if time_measurement:
                 diff = time.time() - time_measurement
         else:
             logger.warning('failed to extract time measurement dictionary from %s' % str(args.timing))
     else:
         logger.warning('job id %s not found in timing dictionary' % job_id)
 
     return diff
 
 
 def get_time_difference(job_id, timing_constant_1, timing_constant_2, args):
     """
     Return the positive time difference between the given constants.
     The order is not important and a positive difference is always returned. The function collects the time measurements
     corresponding to the given timing constants from the pilot timing file.
     The job_id is used internally as a dictionary key. The given timing constants and their timing measurements, belong
     to the given job_id.
     Structure of pilot timing dictionary:
         { job_id: { <timing_constant_1>: <time measurement in seconds since epoch>, .. }
     job_id = 0 means timing information from wrapper. Timing constants are defined in pilot.util.constants.
     Time measurement are time.time() values. The float value will be converted to an int as a last step.
 
     :param job_id: PanDA job id (string).
     :param timing_constant_1:
     :param timing_constant_2:
     :param args: pilot arguments.
     :return: time difference in seconds (int).
     """
 
     diff = 0
 
     if job_id in args.timing:
 
         # extract time measurements
         time_measurement_dictionary = args.timing.get(job_id, None)
         if time_measurement_dictionary:
 
             time_measurement_1 = get_time_measurement(timing_constant_1, time_measurement_dictionary,
                                                       args.timing, job_id)
             time_measurement_2 = get_time_measurement(timing_constant_2, time_measurement_dictionary,
                                                       args.timing, job_id)
 
             if time_measurement_1 and time_measurement_2:
                 diff = time_measurement_2 - time_measurement_1
         else:
             logger.warning('failed to extract time measurement dictionary from %s' % str(args.timing))
     else:
         logger.warning('job id %s not found in timing dictionary' % job_id)
 
     # always return a positive number
     if diff < 0:
         diff = -diff
 
     # convert to int as a last step
     try:
         diff = int(diff)
     except Exception as e:
         logger.warning('failed to convert %s to int: %s (will reset to 0)' % (diff, e))
         diff = 0
 
     return diff
 
 
 def timing_report(job_id, args):
     """
     Write a timing report to the job log and return relevant timing measurements.
 
     :param job_id: job id (string).
     :param args: pilot arguments.
     :return: time_getjob, time_stagein, time_payload, time_stageout, time_total_setup (integer strings).
     """
 
     # collect pilot timing data
     time_getjob = get_getjob_time(job_id, args)
     time_initial_setup = get_initial_setup_time(job_id, args)
     time_setup = get_setup_time(job_id, args)
     time_total_setup = time_initial_setup + time_setup
     time_stagein = get_stagein_time(job_id, args)
     time_payload = get_payload_execution_time(job_id, args)
     time_stageout = get_stageout_time(job_id, args)
     logger.info('.' * 30)
     logger.info('. Timing measurements:')
     logger.info('. get job = %d s' % time_getjob)
     logger.info('. initial setup = %d s' % time_initial_setup)
     logger.info('. payload setup = %d s' % time_setup)
     logger.info('. total setup = %d s' % time_total_setup)
     logger.info('. stage-in = %d s' % time_stagein)
     logger.info('. payload execution = %d s' % time_payload)
     logger.info('. stage-out = %d s' % time_stageout)
     logger.info('.' * 30)
 
     return time_getjob, time_stagein, time_payload, time_stageout, time_total_setup
 
 
 def time_stamp():
     """
     Return ISO-8601 compliant date/time format
 
     :return: time information
     """
 
     tmptz = time.timezone
     sign_str = '+'
     if tmptz > 0:
         sign_str = '-'
     tmptz_hours = int(tmptz / 3600)
 
     return str("%s%s%02d:%02d" % (time.strftime("%Y-%m-%dT%H:%M:%S", time.localtime()), sign_str, abs(tmptz_hours),
                                   int(tmptz / 60 - tmptz_hours * 60)))
 
 
 def get_elapsed_real_time(t0=None):
     """
     Return a time stamp corresponding to the elapsed real time (since t0 if requested).
     The function uses os.times() to get the current time stamp.
     If t0 is provided, the returned time stamp is relative to t0. t0 is assumed to be an os.times() tuple.
 
     :param t0: os.times() tuple for the t0 time stamp.
     :return: time stamp (int).
     """
 
     if t0 and type(t0) == tuple:
         try:
             _t0 = int(t0[4])
         except Exception as e:
             logger.warning('unknown timing format for t0: %s' % e)
             _t0 = 0
     else:
         _t0 = 0
 
     t = int(os.times()[4])
 
     return t - _t0

This page was automatically generated by the 2.3.7 LXR engine. The LXR team