Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API for cached tables #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions cache/cache.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#ifndef CACHE_H
#define CACHE_H

/* A cached version of the global state database (object table, task log, task
* table). */
typedef db_cache_impl db_cache;

/* These are the error codes the methods can return. */
#define CACHE_NOT_FOUND -1
#define CACHE_OK 0

/* Return an array of plasma managers that have the object (the last parameter
* is an out parameter, which is assumed to be an array we append to). */
int cached_object_table_get(db_cache *db,
Copy link
Collaborator

@istoica istoica Sep 27, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe change cached_* to cache_* ?

While for get() "cached" makes sense, it doesn't make that much sense for add().

In general the prefix of the function should be a noun as it is used to name the object on which the function operate on. Just emulate a poor man object oriented design ;-)

object_name_method_name()

or maybe

object_name__method_name()

to better separate object_name and method_name.
If we follow the above rule, maybe the best prefixes are object_cache, task_cache, etc.

object_id object_id,
UT_array *managers);

/* Register a new object with the cache. */
void cached_object_table_add(db_cache *db, object_id object_id, node_id node);

/* Initially add a task to the task log cache. */
void cached_task_log_add_task(db_cache *db,
task_iid task_iid,
task_spec *task,
task_status task_status);

/* Update task in the task log cache. This will append the new status to the
* task log cache. */
void cached_task_log_update_task(db_cache *db,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just updating status. We should make clear about this in the name of the function as well.

task_iid task_iid,
task_status status);

/* Get task from the task log cache. The last two parameters are out parameters,
* which are both assumed to be allocated. */
int cached_task_log_get_task(db_cache *db,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the above rule the name for this would be

task_log_cache_get_task()

or

task_log_cache__get_task()

task_iid task_iid,
task_spec *task,
task_status *status);

/* Add task to the task table cache. */
void chached_task_table_add_task(db_cache *db, task_spec *task);

/* Get specific task from the task table cache. */
int cached_task_table_get_task(db_cache *db, task_id task_id, task_spec *out);

#endif /* CACHE_H */