class FunctionExecutor:
class State:
New = 'New'
Running = 'Running'
Ready = 'Ready'
Done = 'Done'
Error = 'Error'
def __init__(self, config = None, runtime=None, runtime_memory=None, compute_backend=None,
compute_backend_region=None, storage_backend=None, storage_backend_region=None,
workers=None, rabbitmq_monitor=None, remote_invoker=None, log_level=None):
self.start_time = time.time()
self._state = self.State.New
self.is_pywren_function = is_pywren_function()
# Log level Configuration
self.log_level = log_level
if not self.log_level:
if(logger.getEffectiveLevel() != logging.WARNING):
self.log_level = logging.getLevelName(logger.getEffectiveLevel())
if self.log_level:
os.environ["PYWREN_LOGLEVEL"] = self.log_level
if not self.is_pywren_function:
default_logging_config(self.log_level)
# Overwrite pywren config parameters
pw_config_ow = {}
if runtime is not None:
pw_config_ow['runtime'] = runtime
if runtime_memory is not None:
pw_config_ow['runtime_memory'] = runtime_memory
if compute_backend is not None:
pw_config_ow['compute_backend'] = compute_backend
if compute_backend_region is not None:
pw_config_ow['compute_backend_region'] = compute_backend_region
if storage_backend is not None:
pw_config_ow['storage_backend'] = storage_backend
if storage_backend_region is not None:
pw_config_ow['storage_backend_region'] = storage_backend_region
if workers is not None:
pw_config_ow['workers'] = workers
if rabbitmq_monitor is not None:
pw_config_ow['rabbitmq_monitor'] = rabbitmq_monitor
if remote_invoker is not None:
pw_config_ow['remote_invoker'] = remote_invoker
self.config = default_config(copy.deepcopy(config), pw_config_ow)
self.executor_id = create_executor_id()
logger.debug('FunctionExecutor created with ID: {}'.format(self.executor_id))
self.data_cleaner = self.config['pywren'].get('data_cleaner', True)
self.rabbitmq_monitor = self.config['pywren'].get('rabbitmq_monitor', False)
if self.rabbitmq_monitor:
if 'rabbitmq' in self.config and 'amqp_url' in self.config['rabbitmq']:
self.rabbit_amqp_url = self.config['rabbitmq'].get('amqp_url')
else:
raise Exception("You cannot use rabbitmq_mnonitor since 'amqp_url'"
" is not present in configuration")
storage_config = extract_storage_config(self.config)
self.internal_storage = InternalStorage(storage_config)
self.invoker = FunctionInvoker(self.config, self.executor_id, self.internal_storage)
self.futures = []
self.total_jobs = 0
self.cleaned_jobs = set()
def _create_job_id(self, call_type):
job_id = str(self.total_jobs).zfill(3)
self.total_jobs += 1
return '{}{}'.format(call_type, job_id)
def lidar_call_async(self, func, data, extra_env=None, runtime_memory=None,
timeout=EXECUTION_TIMEOUT, include_modules=[], exclude_modules=[]):
"""
For running one function execution asynchronously
:param func: the function to map over the data
:param data: input data
:param extra_data: Additional data to pass to action. Default None.
:param extra_env: Additional environment variables for action environment. Default None.
:param runtime_memory: Memory to use to run the function. Default None (loaded from config).
:param timeout: Time that the functions have to complete their execution before raising a timeout.
:param include_modules: Explicitly pickle these dependencies.
:param exclude_modules: Explicitly keep these modules from pickled dependencies.
:return: future object.
"""
job_id = self._create_job_id('A')
runtime_meta = self.invoker.select_runtime(job_id, runtime_memory)
job = create_map_job(self.config, self.internal_storage,
self.executor_id, job_id,
map_function=func,
iterdata=[data],
runtime_meta=runtime_meta,
runtime_memory=runtime_memory,
extra_env=extra_env,
include_modules=include_modules,
exclude_modules=exclude_modules,
execution_timeout=timeout)
futures = self.invoker.run(job)
self.futures.extend(futures)
self._state = FunctionExecutor.State.Running
return futures[0]
def lidar_map(self, map_function, map_iterdata, extra_params=None, extra_env=None, runtime_memory=None,
partition_type = None, rows=1, cols=1, timeout=EXECUTION_TIMEOUT, invoke_pool_threads=500,
include_modules=[], exclude_modules=[]):
"""
:param map_function: the function to map over the data
:param map_iterdata: An iterable of input data
:param extra_params: Additional parameters to pass to the function activation. Default None.
:param extra_env: Additional environment variables for action environment. Default None.
:param runtime_memory: Memory to use to run the function. Default None (loaded from config).
:param chunk_size: the size of the data chunks to split each object. 'None' for processing
the whole file in one function activation.
:param chunk_n: Number of chunks to split each object. 'None' for processing the whole
file in one function activation.
:param remote_invocation: Enable or disable remote_invocation mechanism. Default 'False'
:param timeout: Time that the functions have to complete their execution before raising a timeout.
:param invoke_pool_threads: Number of threads to use to invoke.
:param include_modules: Explicitly pickle these dependencies.
:param exclude_modules: Explicitly keep these modules from pickled dependencies.
:return: A list with size `len(iterdata)` of futures.
"""
job_id = self._create_job_id('M')
runtime_meta = self.invoker.select_runtime(job_id, runtime_memory)
job = create_map_job(self.config, self.internal_storage,
self.executor_id, job_id,
map_function=map_function,
iterdata=map_iterdata,
runtime_meta=runtime_meta,
runtime_memory=runtime_memory,
partition_type = partition_type,
extra_params=extra_params,
extra_env=extra_env,
obj_rows=rows,
obj_cols=cols,
invoke_pool_threads=invoke_pool_threads,
include_modules=include_modules,
exclude_modules=exclude_modules,
execution_timeout=timeout)
futures = self.invoker.run(job)
self.futures.extend(futures)
self._state = FunctionExecutor.State.Running
if len(futures) == 1:
return futures[0]
return futures
def lidar_map_reduce(self, map_function, map_iterdata, reduce_function, extra_params=None, extra_env=None,
map_runtime_memory=None, reduce_runtime_memory=None, chunk_size=None, chunk_n=None,
timeout=EXECUTION_TIMEOUT, invoke_pool_threads=500, reducer_one_per_object=False,
reducer_wait_local=False, include_modules=[], exclude_modules=[]):
"""
Map the map_function over the data and apply the reduce_function across all futures.
This method is executed all within CF.
:param map_function: the function to map over the data
:param map_iterdata: the function to reduce over the futures
:param reduce_function: the function to reduce over the futures
:param extra_env: Additional environment variables for action environment. Default None.
:param extra_params: Additional parameters to pass to function activation. Default None.
:param map_runtime_memory: Memory to use to run the map function. Default None (loaded from config).
:param reduce_runtime_memory: Memory to use to run the reduce function. Default None (loaded from config).
:param chunk_size: the size of the data chunks to split each object. 'None' for processing
the whole file in one function activation.
:param chunk_n: Number of chunks to split each object. 'None' for processing the whole
file in one function activation.
:param remote_invocation: Enable or disable remote_invocation mechanism. Default 'False'
:param timeout: Time that the functions have to complete their execution before raising a timeout.
:param reducer_one_per_object: Set one reducer per object after running the partitioner
:param reducer_wait_local: Wait for results locally
:param invoke_pool_threads: Number of threads to use to invoke.
:param include_modules: Explicitly pickle these dependencies.
:param exclude_modules: Explicitly keep these modules from pickled dependencies.
:return: A list with size `len(map_iterdata)` of futures.
"""
map_job_id = self._create_job_id('M')
runtime_meta = self.invoker.select_runtime(map_job_id, map_runtime_memory)
map_job = create_map_job(self.config, self.internal_storage,
self.executor_id, map_job_id,
map_function=map_function,
iterdata=map_iterdata,
runtime_meta=runtime_meta,
runtime_memory=map_runtime_memory,
extra_params=extra_params,
extra_env=extra_env,
obj_chunk_size=chunk_size,
obj_chunk_number=chunk_n,
invoke_pool_threads=invoke_pool_threads,
include_modules=include_modules,
exclude_modules=exclude_modules,
execution_timeout=timeout)
map_futures = self.invoker.run(map_job)
self.futures.extend(map_futures)
if reducer_wait_local:
self.wait(fs=map_futures)
reduce_job_id = map_job_id.replace('M', 'R')
runtime_meta = self.invoker.select_runtime(reduce_job_id, reduce_runtime_memory)
reduce_job = create_reduce_job(self.config, self.internal_storage,
self.executor_id, reduce_job_id,
reduce_function, map_job, map_futures,
runtime_meta=runtime_meta,
reducer_one_per_object=reducer_one_per_object,
runtime_memory=reduce_runtime_memory,
extra_env=extra_env,
include_modules=include_modules,
exclude_modules=exclude_modules)
reduce_futures = self.invoker.run(reduce_job)
self.futures.extend(reduce_futures)
for f in map_futures:
f.produce_output = False
self._state = FunctionExecutor.State.Running
return map_futures + reduce_futures
def wait(self, fs=None, throw_except=True, return_when=ALL_COMPLETED, download_results=False,
timeout=None, THREADPOOL_SIZE=128, WAIT_DUR_SEC=1):
"""
Wait for the Future instances (possibly created by different Executor instances)
given by fs to complete. Returns a named 2-tuple of sets. The first set, named done,
contains the futures that completed (finished or cancelled futures) before the wait
completed. The second set, named not_done, contains the futures that did not complete
(pending or running futures). timeout can be used to control the maximum number of
seconds to wait before returning.
:param fs: Futures list. Default None
:param throw_except: Re-raise exception if call raised. Default True.
:param return_when: One of `ALL_COMPLETED`, `ANY_COMPLETED`, `ALWAYS`
:param download_results: Download results. Default false (Only get statuses)
:param timeout: Timeout of waiting for results.
:param THREADPOOL_SIZE: Number of threads to use. Default 64
:param WAIT_DUR_SEC: Time interval between each check.
:return: `(fs_done, fs_notdone)`
where `fs_done` is a list of futures that have completed
and `fs_notdone` is a list of futures that have not completed.
:rtype: 2-tuple of list
"""
futures = self.futures if not fs else fs
if type(futures) != list:
futures = [futures]
if not futures:
raise Exception('You must run the call_async(), map() or map_reduce(), or provide'
' a list of futures before calling the wait()/get_result() method')
if download_results:
msg = 'ExecutorID {} - Getting results...'.format(self.executor_id)
else:
msg = 'ExecutorID {} - Waiting for functions to complete...'.format(self.executor_id)
logger.info(msg)
if not self.log_level and self._state == FunctionExecutor.State.Running:
print(msg)
if is_unix_system() and timeout is not None:
signal.signal(signal.SIGALRM, timeout_handler)
signal.alarm(timeout)
pbar = None
if not self.is_pywren_function and self._state == FunctionExecutor.State.Running \
and not self.log_level:
from tqdm.auto import tqdm
if download_results:
total_to_check = len([f for f in futures if not f.done])
else:
total_to_check = len([f for f in futures if not f.ready and not (f.ready or f.done)])
if is_notebook():
pbar = tqdm(bar_format='{n}/|/ {n_fmt}/{total_fmt}', total=total_to_check) # ncols=800
else:
print()
pbar = tqdm(bar_format=' {l_bar}{bar}| {n_fmt}/{total_fmt} ', total=total_to_check, disable=False)
try:
if self.rabbitmq_monitor:
logger.info('Using RabbitMQ to monitor function activations')
wait_rabbitmq(futures, self.internal_storage, rabbit_amqp_url=self.rabbit_amqp_url,
download_results=download_results, throw_except=throw_except,
pbar=pbar, return_when=return_when, THREADPOOL_SIZE=THREADPOOL_SIZE)
else:
wait_storage(futures, self.internal_storage, download_results=download_results,
throw_except=throw_except, return_when=return_when, pbar=pbar,
THREADPOOL_SIZE=THREADPOOL_SIZE, WAIT_DUR_SEC=WAIT_DUR_SEC)
except FunctionException as e:
if is_unix_system():
signal.alarm(0)
if pbar:
pbar.close()
print()
msg = None
logger.info(e.msg)
if not self.log_level:
print(e.msg)
if e.exc_msg:
logger.info('Exception: ' + e.exc_msg)
if not self.log_level:
print('--> Exception: ' + e.exc_msg)
else:
print()
traceback.print_exception(*e.exception)
self._state = FunctionExecutor.State.Error
except TimeoutError:
if download_results:
not_dones_call_ids = [(f.job_id, f.call_id) for f in futures if not f.done]
else:
not_dones_call_ids = [(f.job_id, f.call_id) for f in futures if not f.ready and not f.done]
msg = ('ExecutorID {} - Raised timeout of {} seconds waiting for results - Total Activations not done: {}'
.format(self.executor_id, timeout, len(not_dones_call_ids)))
self._state = FunctionExecutor.State.Error
except KeyboardInterrupt:
if download_results:
not_dones_call_ids = [(f.job_id, f.call_id) for f in futures if not f.done]
else:
not_dones_call_ids = [(f.job_id, f.call_id) for f in futures if not f.ready and not f.done]
msg = ('ExecutorID {} - Cancelled - Total Activations not done: {}'
.format(self.executor_id, len(not_dones_call_ids)))
self._state = FunctionExecutor.State.Error
except Exception as e:
self.invoker.stop()
if pbar:
pbar.close()
print()
if not self.is_pywren_function:
self.clean()
raise e
finally:
self.invoker.stop()
if is_unix_system():
signal.alarm(0)
if pbar:
pbar.close()
if not is_notebook():
print()
if self._state == FunctionExecutor.State.Error and msg:
logger.debug(msg)
if not self.log_level:
print(msg)
if self.data_cleaner and not self.is_pywren_function:
self.clean()
if not fs and self._state == FunctionExecutor.State.Error and is_notebook():
del self.futures[len(self.futures)-len(futures):]
if download_results:
fs_done = [f for f in futures if f.done]
fs_notdone = [f for f in futures if not f.done]
self._state = FunctionExecutor.State.Done
else:
fs_done = [f for f in futures if f.ready or f.done]
fs_notdone = [f for f in futures if not f.ready and not f.done]
self._state = FunctionExecutor.State.Ready
return fs_done, fs_notdone
def get_result(self, fs=None, throw_except=True, timeout=None, THREADPOOL_SIZE=128, WAIT_DUR_SEC=1):
"""
For getting the results from all function activations
:param fs: Futures list. Default None
:param throw_except: Reraise exception if call raised. Default True.
:param verbose: Shows some information prints. Default False
:param timeout: Timeout for waiting for results.
:param THREADPOOL_SIZE: Number of threads to use. Default 128
:param WAIT_DUR_SEC: Time interval between each check.
:return: The result of the future/s
"""
fs_done, unused_fs_notdone = self.wait(fs=fs, throw_except=throw_except,
timeout=timeout, download_results=True,
THREADPOOL_SIZE=THREADPOOL_SIZE,
WAIT_DUR_SEC=WAIT_DUR_SEC)
result = []
for f in fs_done:
if fs and not f.futures and f.produce_output:
# Process futures provided by the user
result.append(f.result(throw_except=throw_except, internal_storage=self.internal_storage))
elif not fs and not f.futures and f.produce_output and not f.read:
# Process internally stored futures
result.append(f.result(throw_except=throw_except, internal_storage=self.internal_storage))
f.read = True
logger.debug("ExecutorID {} Finished getting results".format(self.executor_id))
if result and len(result) == 1:
return result[0]
return result
def clean(self, fs=None, local_execution=True):
"""
Deletes all the files from COS. These files include the function,
the data serialization and the function invocation results.
"""
futures = self.futures if not fs else fs
if type(futures) != list:
futures = [futures]
if not futures:
return
if not fs:
present_jobs = {(f.executor_id, f.job_id) for f in futures
if (f.done or not f.produce_output)
and f.executor_id.count('/') == 1}
else:
present_jobs = {(f.executor_id, f.job_id) for f in futures
if f.executor_id.count('/') == 1}
jobs_to_clean = present_jobs - self.cleaned_jobs
if jobs_to_clean:
msg = "ExecutorID {} - Cleaning temporary data".format(self.executor_id)
logger.info(msg)
if not self.log_level:
print(msg)
for executor_id, job_id in jobs_to_clean:
storage_bucket = self.config['pywren']['storage_bucket']
storage_prerix = '/'.join([JOBS_PREFIX, executor_id, job_id])
if local_execution:
# 1st case: Not background. The main code waits until the cleaner finishes its execution.
# It is not ideal for performance tests, since it can take long time to complete.
# clean_os_bucket(storage_bucket, storage_prerix, self.internal_storage)
# 2nd case: Execute in Background as a subprocess. The main program does not wait for its completion.
storage_config = json.dumps(self.internal_storage.get_storage_config())
storage_config = storage_config.replace('"', '\\"')
cmdstr = ('{} -c "from pywren_ibm_cloud.storage.utils import clean_bucket; \
clean_bucket(\'{}\', \'{}\', \'{}\')"'.format(sys.executable,
storage_bucket,
storage_prerix,
storage_config))
os.popen(cmdstr)
else:
extra_env = {'STORE_STATUS': False,
'STORE_RESULT': False}
old_stdout = sys.stdout
sys.stdout = open(os.devnull, 'w')
self.call_async(clean_os_bucket, [storage_bucket, storage_prerix], extra_env=extra_env)
sys.stdout = old_stdout
self.cleaned_jobs.update(jobs_to_clean)
def status(self, throw_except=True, internal_storage=None):
"""
Return the status returned by the call.
If the call raised an exception, this method will raise the same exception
If the future is cancelled before completing then CancelledError will be raised.
:param check_only: Return None immediately if job is not complete. Default False.
:param throw_except: Reraise exception if call raised. Default true.
:param storage_handler: Storage handler to poll cloud storage. Default None.
:return: Result of the call.
:raises CancelledError: If the job is cancelled before completed.
:raises TimeoutError: If job is not complete after `timeout` seconds.
"""
if self._state == ResponseFuture.State.New:
raise ValueError("task not yet invoked")
if self._state in [
ResponseFuture.State.Ready, ResponseFuture.State.Success
]:
return self._call_status
if internal_storage is None:
internal_storage = InternalStorage(self.storage_config)
if self._call_status is None:
check_storage_path(internal_storage.get_storage_config(),
self.storage_path)
self._call_status = internal_storage.get_call_status(
self.executor_id, self.job_id, self.call_id)
self.status_query_count += 1
while self._call_status is None:
time.sleep(self.GET_RESULT_SLEEP_SECS)
self._call_status = internal_storage.get_call_status(
self.executor_id, self.job_id, self.call_id)
self.status_query_count += 1
self.activation_id = self._call_status['activation_id']
if self._call_status['type'] == '__init__':
self._set_state(ResponseFuture.State.Running)
return self._call_status
self._call_metadata['host_submit_time'] = self._call_status[
'host_submit_time']
self._call_metadata['status_done_timestamp'] = time.time()
self._call_metadata['status_query_count'] = self.status_query_count
total_time = format(
round(
self._call_status['end_time'] -
self._call_status['start_time'], 2), '.2f')
if self._call_status['exception']:
# the action handler/jobrunner/function had an exception
self._set_state(ResponseFuture.State.Error)
self._exception = pickle.loads(eval(self._call_status['exc_info']))
msg = None
if not self._call_status.get('exc_pickle_fail', False):
exception_args = self._exception[1].args
if exception_args and exception_args[0] == "WRONGVERSION":
msg = "PyWren version mismatch: remote library is version {}, local " \
"library is version {}".format(exception_args[2], exception_args[3])
elif exception_args and exception_args[0] == "OUTATIME":
msg = "Process ran out of time and was killed"
elif exception_args and exception_args[0] == "OUTOFMEMORY":
msg = "Process exceeded maximum memory and was killed"
else:
fault = Exception(self._exception['exc_value'])
self._exception = (Exception, fault,
self._exception['exc_traceback'])
if throw_except:
reraise(*self._exception)
raise FunctionException(self.executor_id, self.job_id,
self.activation_id, self._exception, msg)
log_msg = (
'ExecutorID {} | JobID {} - Got status from call {} - Activation '
'ID: {} - Time: {} seconds'.format(self.executor_id, self.job_id,
self.call_id,
self.activation_id,
str(total_time)))
logger.info(log_msg)
self._set_state(ResponseFuture.State.Ready)
if not self._call_status['result']:
self._set_state(ResponseFuture.State.Success)
self.produce_output = False
if 'new_futures' in self._call_status:
self.result(throw_except=throw_except,
internal_storage=internal_storage)
return self._call_status