mirror of
https://github.com/wassname/ray.git
synced 2026-07-19 11:27:32 +08:00
IonandPhilipp Moritz
ee3718c80c
* Ion and Philipp's table retries * Refactor the retry struct: - Rename it from retry_struct to retry_info - Retry information contains the failure callback, not the retry callback - All functions take in retry information as an arg instead of its expanded fields * Rename cb -> callback * Remove prints * Fix compiler warnings * Change some CHECKs to greatest ASSERTs * Key outstanding callbacks hash table with timer ID instead of callback data pointer * Use the new retry API for table commands * Memory cleanup in plasma unit tests * fix Robert's comments * add valgrind for common
89 lines
3.3 KiB
C
89 lines
3.3 KiB
C
#ifndef TASK_LOG_H
|
|
#define TASK_LOG_H
|
|
|
|
#include "db.h"
|
|
#include "table.h"
|
|
#include "task.h"
|
|
|
|
/**
|
|
* The task log is a message bus that is used for all communication between
|
|
* local and global schedulers (and also persisted to the state database).
|
|
* Here are examples of events that are recorded by the task log:
|
|
*
|
|
* 1) local scheduler writes it when submits a task to the global scheduler;
|
|
* 2) global scheduler reads it to get the task submitted by local schedulers;
|
|
* 3) global scheduler writes it when assigning the task to a local scheduler;
|
|
* 4) local scheduler reads it to get its tasks assigned by global scheduler;
|
|
* 5) local scheduler writes it when a task finishes execution;
|
|
* 6) global scheduler reads it to get the tasks that have finished; */
|
|
|
|
/* Callback called when the task log operation completes. */
|
|
typedef void (*task_log_done_callback)(task_iid task_iid, void *user_context);
|
|
|
|
/*
|
|
* ==== Publish the task log ====
|
|
*/
|
|
|
|
/**
|
|
* Add or update a task instance to the task log.
|
|
*
|
|
* @param db_handle Database handle.
|
|
* @param retry Information about retrying the request to the database.
|
|
* @param done_callback Function to be called when database returns result.
|
|
* @param user_context Data that will be passed to done_callback and
|
|
* fail_callback.
|
|
* @return Void.
|
|
*/
|
|
void task_log_publish(db_handle *db_handle,
|
|
task_instance *task_instance,
|
|
retry_info *retry,
|
|
task_log_done_callback done_callback,
|
|
void *user_context);
|
|
|
|
/*
|
|
* ==== Subscribing to the task log ====
|
|
*/
|
|
|
|
/* Callback for subscribing to the task log. */
|
|
typedef void (*task_log_subscribe_callback)(task_instance *task_instance,
|
|
void *user_context);
|
|
|
|
/**
|
|
* Register callback for a certain event.
|
|
*
|
|
* @param db_handle Database handle.
|
|
* @param subscribe_callback Callback that will be called when the task log is
|
|
* updated.
|
|
* @param subscribe_context Context that will be passed into the
|
|
* subscribe_callback.
|
|
* @param node Node whose events we want to listen to. If you want to register
|
|
* to updates from all nodes, set node = NIL_ID.
|
|
* @param state_filter Flags for events we want to listen to. If you want
|
|
* to listen to all events, use state_filter = TASK_WAITING |
|
|
* TASK_SCHEDULED | TASK_RUNNING | TASK_DONE.
|
|
* @param retry Information about retrying the request to the database.
|
|
* @param done_callback Function to be called when database returns result.
|
|
* @param user_context Data that will be passed to done_callback and
|
|
* fail_callback.
|
|
* @return Void.
|
|
*/
|
|
void task_log_subscribe(db_handle *db_handle,
|
|
node_id node,
|
|
int32_t state_filter,
|
|
task_log_subscribe_callback subscribe_callback,
|
|
void *subscribe_context,
|
|
retry_info *retry,
|
|
task_log_done_callback done_callback,
|
|
void *user_context);
|
|
|
|
/* Data that is needed to register task log subscribe callbacks with the state
|
|
* database. */
|
|
typedef struct {
|
|
node_id node;
|
|
int32_t state_filter;
|
|
task_log_subscribe_callback subscribe_callback;
|
|
void *subscribe_context;
|
|
} task_log_subscribe_data;
|
|
|
|
#endif /* TASK_LOG_H */
|