#
# Preprocessing ARM WA workloads
#
# Developer: Grigori Fursin, cTuning foundation, 2016
#

import json
import os
import re

fix_params={0:{"exact_abi":"check_abi"},
            1:{"check_abi":"exact_abi"}}

##########################################################
default_agenda={
    "config": {
      "instrumentation": [
        "~execution_time"
      ],
      "result_processors": [
        "json"
      ]
    },
    "workloads": []
}

##########################################################
def ck_preprocess(i):

    import copy

    o=i.get('out','')

    ck=i['ck_kernel']


    rt=i['run_time']
    deps=i['deps']

    deps_wa=deps.get('wa',{})
    sver=deps_wa.get('cus',{}).get('version_split',[])

    misc=i['misc']

    hosd=i['host_os_dict']

    set_env=hosd.get('env_set','')
    if set_env!='' and not set_env.endswith(' '):
        set_env+=' '

    env_quotes=hosd.get('env_quotes','')

    env=i['env']

    all_params=i.get('params',{})
    raw_path=env.get('CK_WA_RAW_RESULT_PATH','')

    if raw_path=='':
       try:
           p=os.getcwd()
       except OSError:
           os.chdir('..')
           p=os.getcwd()

    else:
       p=raw_path

    pp=os.path.join(p,'wa-output') # otherwise WA overwrites .cm
    if not os.path.isdir(pp):
        os.makedirs(pp)

    meta=i.get('meta',{})

    # Get target machine config 
    device_cfg=i.get('device_cfg',{})
    wa_config=device_cfg.get('wa_config',{})

    # How to pass agenda from outside or params + what to measure (choices???)+ extra workloads + name
    # TBD: WE ALSO NEED TO PASS PREPARE AGENDA TO OUTPUT (state?)
    agenda=copy.deepcopy(default_agenda)

    r=ck.merge_dicts({'dict1':agenda, 'dict2':all_params.get('agenda',{})})
    if r['return']>0: return 

    # Check default params
    params={}

    dp=meta.get('params',{})
    rx=update_params({'params':dp, 'version_split':sver})
    if rx['return']>0: return rx

    dp1=all_params.get('params',{})
    rx=update_params({'params':dp1, 'version_split':sver})
    if rx['return']>0: return rx

    # Customize device config and workload params from outside!
    r=ck.merge_dicts({'dict1':params, 'dict2':dp1})
    if r['return']>0: return r

    runtime_parameters = dict(meta.get('runtime_parameters',{}))

    for k in sorted(dp):
        x=dp[k]

        ds=x.get('desc','')

        dv=params.get(k,None)
        if dv==None:
            dv=x.get('default',None)

        if dv!=None:
            ck.out(k+': '+str(dv))
        elif x.get('mandatory',False):
            r=ck.inp({'text':k+' ('+ds+'): '})
            if r['return']>0: return r
            dv=r['string'].strip()
            if dv=='':
                dv=None

        if dv!=None:
            params[k]=dv

    wname=meta['wa_alias']
    agenda['workloads'].append({'name':wname, 'params': params, 'runtime_parameters': runtime_parameters})

    # Prepare agenda
    if 'global' not in agenda:
        agenda['global']={}

    ag=agenda['global']

    ag['iterations']=1 # We rely on our CK pipeline statistical repetitions to apply CK stat analysis

    if 'config' not in agenda:
        agenda['config']={}

    # Prepare and customize WA device config !
    ac=agenda['config']
    ac.update(wa_config) # Update config from device description

    ac["remote_assets_url"]="https://raw.githubusercontent.com/ARM-software/workload-automation-assets/master/dependencies"

    r=ck.merge_dicts({'dict1':ac, 'dict2':all_params.get('config',{})})
    if r['return']>0: return r

    acrp=ac['result_processors']
    if 'json'not in acrp:
        acrp.append('json')

    cmd=''

    # Prepare temp yaml file
    r=ck.gen_tmp_file({'prefix':'tmp-', 'suffix':'.yaml', 'remove_dir':'yes'})
    if r['return']>0: return r
    xta=r['file_name']
    ta=os.path.join(p,xta)

    # Save agenda as YAML
    r=ck.save_yaml_to_file({'yaml_file':ta, 'dict':agenda})
    if r['return']>0: return r

    # Finish CMD
    cmd+=' '+ta+' -fd '+pp

    misc['add_to_state']={'wa_agenda':agenda}

    if all_params.get('verbose','')=='yes':
       cmd+=' --verbose'

    # Pass to CMD this file
    b=set_env+'CK_WA_CMD='+env_quotes+cmd.strip()+env_quotes+'\n'

    # Print agenda
    if o=='con':
       r=ck.dump_json({'dict':agenda, 'sort_keys':'yes'})
       if r['return']>0: return r
       s=r['string']

       ck.out('---------------------------------------')
       ck.out('Prepared agenda in JSON:')
       ck.out('')
       ck.out(s)
       ck.out('---------------------------------------')

    return {'return':0, 'bat':b}

##########################################################
# Fix parameters according to WA version to keep backwards compatibility

def update_params(i):

    params=i.get('params',{})
    sver=i.get('version_split',[])

    # Fix params depending on the WA version
    # If we don't have a version_split, assume it is newer than 2.6.0
    if len(params)>0:
       fparams={}
       if len(sver)==0 or (len(sver)>1 and sver[0]>=2 and sver[1]>=6):
          fparams=fix_params[1]
       else:
          fparams=fix_params[0]

       for k in fparams:
           if k in params:
              params[fparams[k]]=params[k]
              del(params[k])

    return {'return':0, 'params':params}


# Do not add anything here!