DataProxy.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 DATAPROXY_H
#define DATAPROXY_H

#include "DataTypes.h"
#include "PDBPage.h"
#include "PDBCommunicator.h"
#include "SharedMem.h"
#include "PageScanner.h"

#include <memory>
using namespace std;
class DataProxy;
typedef shared_ptr<DataProxy> DataProxyPtr;

/*
 * The DataProxy class will use a BackEndCommunicator instance to interact with Storage to do all
 *stuffs like
 * addTempSet, removeTempSet, addTempPage, pinTempPage, unpinTempPage, pinUserPage, unpinUserPage,
 *getScanner, and closeCleaner.
 * Because multiple threads can not share one communicator, a data proxy instance can only be
 *owned/accessed by one thread.
 **/
class DataProxy {
public:
    DataProxy(NodeID nodeId,
              pdb::PDBCommunicatorPtr communicator,
              SharedMemPtr shm,
              pdb::PDBLoggerPtr logger);
    ~DataProxy();

    bool addTempSet(string setName, SetID& setId, bool needMem = true, int numTries = 0);

    bool removeTempSet(SetID setId, bool needMem = true, int numTries = 0);

    bool addTempPage(SetID setId, PDBPagePtr& page, bool needMem = true, int numTries = 0);

    bool addUserPage(DatabaseID dbId,
                     UserTypeID typeId,
                     SetID setId,
                     PDBPagePtr& page,
                     bool needMem = true,
                     int numTries = 0);

    bool pinTempPage(
        SetID setId, PageID pageId, PDBPagePtr& page, bool needMem = true, int numTries = 0);

    bool unpinTempPage(SetID setId, PDBPagePtr page, bool needMem = true, int numTries = 0);

    bool pinUserPage(NodeID nodeId,
                     DatabaseID dbId,
                     UserTypeID typeId,
                     SetID setId,
                     PageID pageId,
                     PDBPagePtr& page,
                     bool needMem = true,
                     int numTries = 0);

    bool pinBytes(DatabaseID dbId,
                  UserTypeID typeId,
                  SetID setId,
                  size_t sizeOfBytes,
                  void* bytes,
                  bool needMem = true,
                  int numTries = 0);


    bool unpinUserPage(NodeID nodeId,
                       DatabaseID dbId,
                       UserTypeID typeId,
                       SetID setId,
                       PDBPagePtr page,
                       bool needMem = true,
                       int numTries = 0);

    PageScannerPtr getScanner(int numThreads);


private:
    pdb::PDBCommunicatorPtr communicator;
    SharedMemPtr shm;
    pdb::PDBLoggerPtr logger;
    NodeID nodeId;
};
#endif /* DATAPROXY_H */