LocalitySet.h

Go to the documentation of this file.

/*****************************************************************************
 *                                                                           *
 *  Copyright 2018 Rice University                                           *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *      http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 *****************************************************************************/

#ifndef LOCALITY_SET_H
#define LOCALITY_SET_H

#include "PDBPage.h"
#include "DataTypes.h"
#include <list>
#include <vector>
#include <memory>
using namespace std;

class LocalitySet;
typedef shared_ptr<LocalitySet> LocalitySetPtr;
class LocalitySet {
public:
    /*
     * Constructor
     */
    LocalitySet(LocalityType localityType,
                LocalitySetReplacementPolicy replacementPolicy,
                OperationType operationType,
                DurabilityType durabilityType,
                PersistenceType persistenceType);

    /*
     * Destructor
     */
    ~LocalitySet();

    /*
     * To add a newly cached page to the locality set
     */
    void addCachedPage(PDBPagePtr page);

    /*
     * To update a cached page with new access sequenceId
     */
    void updateCachedPage(PDBPagePtr page);

    /*
     * To remove a cached page
     */
    void removeCachedPage(PDBPagePtr page);

    /*
     * To select a page from the locality set for replacement based on the replacement policy, and
     * also remove the page from the list.
     */
    PDBPagePtr selectPageForReplacement();

    vector<PDBPagePtr>* selectPagesForReplacement();

    void pin(LocalitySetReplacementPolicy policy, OperationType operationType);

    void unpin();


    /*
     * Getters/Setters
     */

    LocalityType getLocalityType();

    void setLocalityType(LocalityType type);

    LocalitySetReplacementPolicy getReplacementPolicy();

    void setReplacementPolicy(LocalitySetReplacementPolicy policy);

    OperationType getOperationType();

    void setOperationType(OperationType type);

    DurabilityType getDurabilityType();

    void setDurabilityType(DurabilityType type);

    PersistenceType getPersistenceType();

    void setPersistenceType(PersistenceType type);

    bool isLifetimeEnded();

    void setLifetimeEnd(bool lifetimeEnded);

protected:
    list<PDBPagePtr>* cachedPages;


    /*
     * Types of the data in the set:
     * 1. JobData: job input/output
     * 2. ShuffleData: shuffle data
     * 3. HashPartitionData: hash partition data
     * 4. PartialAggregationData: spilled key-value pairs from a hash partition
     *
     * This property should be set at construction time.
     */
    LocalityType localityType;

    /*
     * Replacement policy in the set:
     * 1. LRU
     * 2. MRU
     * 3. Random
     *
     * This property should be set at construction time, and can be modified at pin time.
     */
    LocalitySetReplacementPolicy replacementPolicy;

    /*
     * On-going operation of the set:
     * 1. Read
     * 2. RepeatedRead
     * 3. Write
     *
     * This property should be set at construction time, and can be modified at pin time.
     */
    OperationType operationType;

    DurabilityType durabilityType;

    PersistenceType persistenceType;

    bool lifetimeEnded;
};


#endif