mariadb/ndb/include/kernel/signaldata/FsReadWriteReq.hpp
unknown 6386c55cee Initial revision of NDB Cluster files
BitKeeper/etc/logging_ok:
  Logging to logging@openlogging.org accepted
2004-04-14 10:53:21 +02:00

152 lines
3.4 KiB
C++

/* Copyright (C) 2003 MySQL AB
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
#ifndef FS_READWRITEREQ_H
#define FS_READWRITEREQ_H
#include "SignalData.hpp"
/**
* FsReadWriteReq - Common signal class for FSWRITEREQ and FSREADREQ
*
*/
/**
*
* SENDER:
* RECIVER: Ndbfs
*/
class FsReadWriteReq {
/**
* Reciver(s)
*/
friend class Ndbfs;
friend class VoidFs;
/**
* Sender(s)
*/
friend class Dbdict;
/**
* For printing
*/
friend bool printFSREADWRITEREQ(FILE * output, const Uint32 * theData, Uint32 len, Uint16 receiverBlockNo);
public:
/**
* Enum type for errorCode
*/
enum NdbfsFormatType {
fsFormatListOfPairs=0,
fsFormatArrayOfPages=1,
fsFormatListOfMemPages=2,
fsFormatMax
};
/**
* Length of signal
*/
private:
/**
* DATA VARIABLES
*/
UintR filePointer; // DATA 0
UintR userReference; // DATA 1
UintR userPointer; // DATA 2
UintR operationFlag; // DATA 3
UintR varIndex; // DATA 4
UintR numberOfPages; // DATA 5
//-------------------------------------------------------------
// Variable sized part. Those will contain
// info about memory/file pages to read/write
//-------------------------------------------------------------
union {
UintR pageData[16]; // DATA 6 - 21
struct {
Uint32 varIndex; // In unit cluster size
Uint32 fileOffset; // In unit page size
} listOfPair[8];
struct {
Uint32 varIndex;
Uint32 fileOffset;
} arrayOfPages;
struct {
Uint32 varIndex[1]; // Size = numberOfPages
Uint32 fileOffset;
} listOfMemPages;
} data;
static Uint8 getSyncFlag(const UintR & opFlag);
static void setSyncFlag(UintR & opFlag, Uint8 flag);
static NdbfsFormatType getFormatFlag(const UintR & opFlag);
static void setFormatFlag(UintR & opFlag, Uint8 flag);
};
/**
* Operation flag
*
f = Format of pageData - 4 Bits -> max 15
s = sync after write flag - 1 Bit
1111111111222222222233
01234567890123456789012345678901
ffffs
*/
#define SYNC_SHIFT (4)
#define SYNC_MASK (0x01)
#define FORMAT_MASK (0x0F)
inline
Uint8
FsReadWriteReq::getSyncFlag(const UintR & opFlag){
return (Uint8)((opFlag >> SYNC_SHIFT) & SYNC_MASK);
}
inline
FsReadWriteReq::NdbfsFormatType
FsReadWriteReq::getFormatFlag(const UintR & opFlag){
return (NdbfsFormatType)(opFlag & FORMAT_MASK);
}
inline
void
FsReadWriteReq::setSyncFlag(UintR & opFlag, Uint8 flag){
ASSERT_BOOL(flag, "FsReadWriteReq::setSyncFlag");
opFlag |= (flag << SYNC_SHIFT);
}
inline
void
FsReadWriteReq::setFormatFlag(UintR & opFlag, Uint8 flag){
ASSERT_MAX(flag, fsFormatMax, "FsReadWriteReq::setSyncFlag");
opFlag |= flag;
}
#endif