update sources to v12.1.0

[ceph.git] / ceph / src / cls / replica_log / cls_replica_log_client.h

/*
 * Ceph - scalable distributed file system
 *
 * This is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1, as published by the Free Software
 * Foundation.  See file COPYING.
 *
 * Copyright 2013 Inktank
 */

#ifndef CLS_REPLICA_LOG_CLIENT_H_
#define CLS_REPLICA_LOG_CLIENT_H_

#include "cls_replica_log_ops.h"

namespace librados {
  class ObjectWriteOperation;
  class IoCtx;
}

/**
 * Prepare a progress marker object to send out.
 *
 * @param progress The marker object to prepare
 * @param entity The ID of the entity setting the progress
 * @param marker The marker key the entity has gotten to
 * @param time The timestamp associated with the marker
 * param entries A list of in-progress entries prior to the marker
 */
void cls_replica_log_prepare_marker(cls_replica_log_progress_marker& progress,
                                    const string& entity, const string& marker,
                                    const utime_t& time,
                                    const list<pair<string, utime_t> > *entries);

/**
 * Extract a progress marker object into its components.
 *
 * @param progress The marker object to extract data from
 * @param entity [out] The ID of the entity the progress is associated with
 * @param marker [out] The marker key the entity has gotten to
 * @param time [out] The timestamp associated with the marker
 * @param entries [out] List of in-progress entries prior to the marker
 */
void cls_replica_log_extract_marker(const cls_replica_log_progress_marker& progress,
                                    string& entity, string& marker,
                                    utime_t& time,
                                    list<pair<string, utime_t> >& entries);

/**
 * Add a progress marker update to a write op. The op will return 0 on
 * success, -EEXIST if the marker conflicts with an existing one, or
 * -EINVAL if the marker is in conflict (ie, before) the daemon's existing
 * marker.
 *
 * @param op The op to add the update to
 * @param progress The progress marker to send
 */
void cls_replica_log_update_bound(librados::ObjectWriteOperation& op,
                                  const cls_replica_log_progress_marker& progress);

/**
 * Remove an entity's progress marker from the replica log. The op will return
 * 0 on success, -ENOENT if the entity does not exist on the replica log, or
 * -ENOTEMPTY if the items list on the marker is not empty.
 *
 * @param op The op to add the delete to
 * @param entity The entity whose progress should be removed
 */
void cls_replica_log_delete_bound(librados::ObjectWriteOperation& op,
                                  const string& entity);

/**
 * Read the bounds on a replica log.
 *
 * @param io_ctx The IoCtx to use for the read
 * @param oid The oid to direct the read to
 * @param position_marker [out] The lowest marker key that has been reached
 * @param oldest_time [out] Timestamp corresponding to the position marker or
 * oldest in-progress item.
 * @param markers [out] List of progress markers for individual daemons
 */
int cls_replica_log_get_bounds(librados::IoCtx& io_ctx, const string& oid,
                                string& position_marker,
                                utime_t& oldest_time,
                                list<cls_replica_log_progress_marker>& markers);

#endif /* CLS_REPLICA_LOG_CLIENT_H_ */