PageScanner.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.                                           *
 *                                                                           *
 *****************************************************************************/
/*
 * File:   PageScanner.h
 * Author: Jia
 *
 * Created on November 17, 2015, 10:04 AM
 */

#ifndef PAGESCANNER_H
#define PAGESCANNER_H

#include "PDBCommunicator.h"
#include "PDBLogger.h"
#include "PageCircularBufferIterator.h"
#include "SharedMem.h"
#include "DataTypes.h"
#include "StoragePagePinned.h"
#include <string.h>
#include <pthread.h>
#include <memory>
using namespace std;

class PageScanner;
typedef shared_ptr<PageScanner> PageScannerPtr;

class PageScanner {

public:
    PageScanner(pdb::PDBCommunicatorPtr communicator,
                SharedMemPtr shm,
                pdb::PDBLoggerPtr logger,
                int numThreads,
                int recvBufSize,
                NodeID nodeId);
    ~PageScanner();

    vector<PageCircularBufferIteratorPtr> getSetIterators(NodeID nodeId,
                                                          DatabaseID dbId,
                                                          UserTypeID typeId,
                                                          SetID setId);

    bool acceptPagePinned(pdb::PDBCommunicatorPtr myCommunicator,
                          string& errMsg,
                          bool& morePagesToLoad,
                          NodeID& dataNodeId,
                          DatabaseID& dataDbId,
                          UserTypeID& dataTypeId,
                          SetID& dataSetId,
                          PageID& dataPageId,
                          size_t& pageSize,
                          size_t& offset);

    bool sendPagePinnedAck(pdb::PDBCommunicatorPtr myCommunicator,
                           bool wasError,
                           string info,
                           string& errMsg);

    bool recvPagesLoop(pdb::Handle<pdb::StoragePagePinned> pinnedPage,
                       pdb::PDBCommunicatorPtr myCommunicator);

    void closeBuffer();

    void openBuffer();


private:
    pdb::PDBCommunicatorPtr communicator;
    pdb::PDBLoggerPtr logger;
    PageCircularBufferPtr buffer;
    unsigned int numThreads;
    SharedMemPtr shm;
    NodeID nodeId;
};


#endif /* PAGESCANNER_H */