/* * ORXONOX - the hottest 3D action shooter ever to exist * > www.orxonox.net < * * * License notice: * * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * Author: * Oliver Scheuss, (C) 2008 * Co-authors: * ... * */ #include "Gamestate.h" #include "network/ClientInformation.h" #include "network/GamestateHandler.h" #include "core/CoreIncludes.h" #include "core/Iterator.h" #include #include namespace orxonox { namespace packet { #define GAMESTATE_START(data) (data + sizeof(GamestateHeader)) #define GAMESTATE_HEADER(data) ((GamestateHeader *)data) #define HEADER GAMESTATE_HEADER(data_) #define PACKET_FLAG_GAMESTATE ENET_PACKET_FLAG_RELIABLE Gamestate::Gamestate() { flags_ = flags_ | PACKET_FLAG_GAMESTATE; } Gamestate::Gamestate(uint8_t *data, unsigned int clientID): Packet(data, clientID) { flags_ = flags_ | PACKET_FLAG_GAMESTATE; } Gamestate::Gamestate(uint8_t *data) { flags_ = flags_ | PACKET_FLAG_GAMESTATE; data_=data; } Gamestate::~Gamestate() { } bool Gamestate::collectData(int id, uint8_t mode) { unsigned int tempsize=0, currentsize=0; assert(data_==0); unsigned int size = calcGamestateSize(id, mode); COUT(4) << "G.ST.Man: producing gamestate with id: " << id << std::endl; if(size==0) return false; data_ = new unsigned char[size + sizeof(GamestateHeader)]; if(!data_){ COUT(2) << "GameStateManager: could not allocate memory" << std::endl; return false; } //start collect data synchronisable by synchronisable uint8_t *mem=data_; mem+=sizeof(GamestateHeader); ObjectList::iterator it; for(it = ObjectList::begin(); it; ++it){ tempsize=it->getSize(id, mode); if(currentsize+tempsize > size){ assert(0); // if we don't use multithreading this part shouldn't be neccessary // start allocate additional memory COUT(3) << "G.St.Man: need additional memory" << std::endl; ObjectList::iterator temp = it; int addsize=tempsize; while(++temp) addsize+=temp->getSize(id, mode); data_ = (uint8_t *)realloc(data_, sizeof(GamestateHeader) + currentsize + addsize); if(!data_) return false; size = currentsize+addsize; }// stop allocate additional memory //if(it->doSelection(id)) dataMap_[mem-data_]=(*it); // save the mem location of the synchronisable data if(!it->getData(mem, id, mode)) return false; // mem pointer gets automatically increased because of call by reference // increase size counter by size of current synchronisable currentsize+=tempsize; } //start write gamestate header HEADER->packetType = ENUM::Gamestate; HEADER->datasize = currentsize; HEADER->id = id; HEADER->diffed = false; HEADER->complete = true; HEADER->compressed = false; //stop write gamestate header COUT(5) << "G.ST.Man: Gamestate size: " << currentsize << std::endl; COUT(5) << "G.ST.Man: 'estimated' (and corrected) Gamestate size: " << size << std::endl; return true; } bool Gamestate::spreadData(uint8_t mode) { assert(data_); assert(!HEADER->compressed); assert(!HEADER->diffed); uint8_t *mem=data_+sizeof(GamestateHeader); // get the start of the Synchronisable list //ObjectList::iterator it=ObjectList::begin(); Synchronisable *s; // update the data of the objects we received while(mem < data_+sizeof(GamestateHeader)+HEADER->datasize){ synchronisableHeader *objectheader = (synchronisableHeader*)mem; s = Synchronisable::getSynchronisable( objectheader->objectID ); if(!s) { Synchronisable::fabricate(mem, mode); } else { bool b = s->updateData(mem, mode); assert(b); } } return true; } int Gamestate::getID(){ return HEADER->id; } unsigned int Gamestate::getSize() const { assert(data_); if(HEADER->compressed) return HEADER->compsize+sizeof(GamestateHeader); else { return HEADER->datasize+sizeof(GamestateHeader); } } bool Gamestate::operator==(packet::Gamestate gs){ uint8_t *d1 = data_+sizeof(GamestateHeader); uint8_t *d2 = gs.data_+sizeof(GamestateHeader); assert(!isCompressed()); assert(!gs.isCompressed()); while(d1datasize) { if(*d1!=*d2) return false; d1++; d2++; } return true; } bool Gamestate::process() { return GamestateHandler::addGamestate(this, getClientID()); } bool Gamestate::compressData() { assert(HEADER); assert(!HEADER->compressed); uLongf buffer = (uLongf)(((HEADER->datasize + 12)*1.01)+1); if(buffer==0) return false; uint8_t *ndata = new uint8_t[buffer+sizeof(GamestateHeader)]; uint8_t *dest = GAMESTATE_START(ndata); //unsigned char *dest = new unsigned char[buffer]; uint8_t *source = GAMESTATE_START(data_); int retval; retval = compress( dest, &buffer, source, (uLong)(HEADER->datasize) ); switch ( retval ) { case Z_OK: COUT(5) << "G.St.Man: compress: successfully compressed" << std::endl; break; case Z_MEM_ERROR: COUT(1) << "G.St.Man: compress: not enough memory available in gamestate.compress" << std::endl; return false; case Z_BUF_ERROR: COUT(2) << "G.St.Man: compress: not enough memory available in the buffer in gamestate.compress" << std::endl; return false; case Z_DATA_ERROR: COUT(2) << "G.St.Man: compress: data corrupted in gamestate.compress" << std::endl; return false; } #ifndef NDEBUG //decompress and compare the start and the decompressed data uint8_t *rdata = new uint8_t[HEADER->datasize+sizeof(GamestateHeader)]; uint8_t *d2 = GAMESTATE_START(rdata); uLongf length2 = HEADER->datasize; uncompress(d2, &length2, dest, buffer); for(unsigned int i=0; idatasize; i++){ assert(*(source+i)==*(d2+i)); } delete[] rdata; #endif //copy and modify header #ifndef NDEBUG HEADER->crc32 = calcCRC(data_+sizeof(GamestateHeader), HEADER->datasize); #endif *GAMESTATE_HEADER(ndata) = *HEADER; //delete old data delete[] data_; //save new data data_ = ndata; HEADER->compsize = buffer; HEADER->compressed = true; assert(HEADER->compressed); COUT(4) << "gamestate compress datasize: " << HEADER->datasize << " compsize: " << HEADER->compsize << std::endl; return true; } bool Gamestate::decompressData() { assert(HEADER); assert(HEADER->compressed); COUT(4) << "GameStateClient: uncompressing gamestate. id: " << HEADER->id << ", baseid: " << HEADER->base_id << ", datasize: " << HEADER->datasize << ", compsize: " << HEADER->compsize << std::endl; unsigned int datasize = HEADER->datasize; unsigned int compsize = HEADER->compsize; unsigned int bufsize; // assert(compsize<=datasize); bufsize = datasize; assert(bufsize!=0); uint8_t *ndata = new uint8_t[bufsize + sizeof(GamestateHeader)]; uint8_t *dest = ndata + sizeof(GamestateHeader); uint8_t *source = data_ + sizeof(GamestateHeader); int retval; uLongf length=bufsize; retval = uncompress( dest, &length, source, (uLong)compsize ); switch ( retval ) { case Z_OK: COUT(5) << "successfully decompressed" << std::endl; break; case Z_MEM_ERROR: COUT(1) << "not enough memory available" << std::endl; return false; case Z_BUF_ERROR: COUT(2) << "not enough memory available in the buffer" << std::endl; return false; case Z_DATA_ERROR: COUT(2) << "data corrupted (zlib)" << std::endl; return false; } #ifndef NDEBUG assert(HEADER->crc32==calcCRC(ndata+sizeof(GamestateHeader), HEADER->datasize)); #endif //copy over the header *GAMESTATE_HEADER(ndata) = *HEADER; if (this->bDataENetAllocated_){ // Memory was allocated by ENet. --> We let it be since enet_packet_destroy will // deallocated it anyway. So data and packet stay together. this->bDataENetAllocated_ = false; } else{ // We allocated the memory in the first place (unlikely). So we destroy the old data // and overwrite it with the new decompressed data. delete[] this->data_; } //set new pointers data_ = ndata; HEADER->compressed = false; assert(HEADER->datasize==datasize); assert(HEADER->compsize==compsize); return true; } Gamestate *Gamestate::diff(Gamestate *base) { assert(HEADER); assert(!HEADER->compressed); assert(!HEADER->diffed); //unsigned char *basep = base->getGs()/*, *gs = getGs()*/; uint8_t *basep = GAMESTATE_START(base->data_), *gs = GAMESTATE_START(this->data_); unsigned int of=0; // pointers offset unsigned int dest_length=0; dest_length=HEADER->datasize; if(dest_length==0) return NULL; uint8_t *ndata = new uint8_t[dest_length*sizeof(uint8_t)+sizeof(GamestateHeader)]; uint8_t *dest = ndata + sizeof(GamestateHeader); while(of < GAMESTATE_HEADER(base->data_)->datasize && of < HEADER->datasize){ *(dest+of)=*(basep+of)^*(gs+of); // do the xor ++of; } if(GAMESTATE_HEADER(base->data_)->datasize!=HEADER->datasize){ uint8_t n=0; if(GAMESTATE_HEADER(base->data_)->datasize < HEADER->datasize){ while(ofdiffed = true; GAMESTATE_HEADER(ndata)->base_id = base->getID(); Gamestate *g = new Gamestate(ndata, getClientID()); g->flags_=flags_; g->packetDirection_ = packetDirection_; return g; } Gamestate* Gamestate::doSelection(unsigned int clientID){ assert(data_); std::map::iterator it; // allocate memory for new data uint8_t *gdata = new uint8_t[HEADER->datasize+sizeof(GamestateHeader)]; // create a gamestate out of it Gamestate *gs = new Gamestate(gdata); uint8_t *newdata = gdata + sizeof(GamestateHeader); uint8_t *origdata = GAMESTATE_START(data_); //copy the GamestateHeader *(GamestateHeader*)gdata = *HEADER; synchronisableHeader *oldobjectheader, *newobjectheader; unsigned int objectOffset; //copy in the zeros for(it=dataMap_.begin(); it!=dataMap_.end(); it++){ oldobjectheader = (synchronisableHeader*)origdata; newobjectheader = (synchronisableHeader*)newdata; unsigned int objectsize = oldobjectheader->size; assert(it->second->objectID==oldobjectheader->objectID); *newobjectheader = *oldobjectheader; objectOffset=sizeof(synchronisableHeader); //skip the size and the availableData variables in the objectheader if(it->second->doSelection(HEADER->id)){ newobjectheader->dataAvailable=true; //TODO: probably not neccessary while(objectOffsetdataAvailable=false; while(objectOffsetdata_); assert(!GAMESTATE_HEADER(base->data_)->diffed); assert(!GAMESTATE_HEADER(base->data_)->compressed); assert(!HEADER->compressed); assert(!HEADER->diffed); //preparations std::map::iterator it; uint8_t *origdata, *basedata, *destdata, *ndata; unsigned int objectOffset, streamOffset=0; //data offset unsigned int minsize = (HEADER->datasize < GAMESTATE_HEADER(base->data_)->datasize) ? HEADER->datasize : GAMESTATE_HEADER(base->data_)->datasize; synchronisableHeader *origheader; synchronisableHeader *destheader; origdata = GAMESTATE_START(this->data_); basedata = GAMESTATE_START(base->data_); ndata = new uint8_t[HEADER->datasize + sizeof(GamestateHeader)]; destdata = ndata + sizeof(GamestateHeader); // do the diff for(it=dataMap_.begin(); it!=dataMap_.end(); it++){ assert(streamOffsetdatasize); bool sendData = it->second->doSelection(HEADER->id); origheader = (synchronisableHeader *)(origdata+streamOffset); destheader = (synchronisableHeader *)(destdata+streamOffset); //copy and partially diff the object header assert(sizeof(synchronisableHeader)==3*sizeof(unsigned int)+sizeof(bool)); *(uint32_t*)destdata = *(uint32_t*)origdata; //size (do not diff) *(bool*)(destdata+sizeof(uint32_t)) = sendData; if(sendData){ *(uint32_t*)(destdata+sizeof(uint32_t)+sizeof(bool)) = *(uint32_t*)(basedata+sizeof(uint32_t)+sizeof(bool)) ^ *(uint32_t*)(origdata+sizeof(uint32_t)+sizeof(bool)); //objectid (diff it) *(uint32_t*)(destdata+2*sizeof(uint32_t)+sizeof(bool)) = *(uint32_t*)(basedata+2*sizeof(uint32_t)+sizeof(bool)) ^ *(uint32_t*)(origdata+2*sizeof(uint32_t)+sizeof(bool)); //classid (diff it) }else{ *(uint32_t*)(destdata+sizeof(uint32_t)+sizeof(bool)) = 0; *(uint32_t*)(destdata+2*sizeof(uint32_t)+sizeof(bool)) = 0; } objectOffset=sizeof(synchronisableHeader); streamOffset+=sizeof(synchronisableHeader); //now handle the object data or fill with zeros while(objectOffsetsize ){ if(sendData && streamOffsetdiffed=true; return gs; } Gamestate* Gamestate::intelligentUnDiff(Gamestate *base){ // asserts assert(data_); assert(base->data_); assert(!GAMESTATE_HEADER(base->data_)->diffed); assert(!GAMESTATE_HEADER(base->data_)->compressed); assert(!HEADER->compressed); assert(HEADER->diffed); //preparations std::map::iterator it; uint8_t *origdata, *basedata, *destdata, *ndata; unsigned int objectOffset, streamOffset=0; //data offset unsigned int minsize = (HEADER->datasize < GAMESTATE_HEADER(base->data_)->datasize) ? HEADER->datasize : GAMESTATE_HEADER(base->data_)->datasize; synchronisableHeader *origheader; synchronisableHeader *destheader; origdata = GAMESTATE_START(this->data_); basedata = GAMESTATE_START(base->data_); ndata = new uint8_t[HEADER->datasize + sizeof(GamestateHeader)]; destdata = ndata + sizeof(GamestateHeader); // do the undiff for(it=dataMap_.begin(); it!=dataMap_.end(); it++){ assert(streamOffsetdatasize); origheader = (synchronisableHeader *)(origdata+streamOffset); destheader = (synchronisableHeader *)(destdata+streamOffset); bool sendData; //copy and partially diff the object header assert(sizeof(synchronisableHeader)==3*sizeof(unsigned int)+sizeof(bool)); *(unsigned int*)destdata = *(unsigned int*)origdata; //size (do not diff) *(bool*)(destdata+sizeof(unsigned int)) = *(bool*)(origdata+sizeof(unsigned int)); sendData = *(bool*)(origdata+sizeof(unsigned int)); if(sendData){ *(unsigned int*)(destdata+sizeof(unsigned int)+sizeof(bool)) = *(unsigned int*)(basedata+sizeof(unsigned int)+sizeof(bool)) ^ *(unsigned int*)(origdata+sizeof(unsigned int)+sizeof(bool)); //objectid (diff it) *(unsigned int*)(destdata+2*sizeof(unsigned int)+sizeof(bool)) = *(unsigned int*)(basedata+2*sizeof(unsigned int)+sizeof(bool)) ^ *(unsigned int*)(origdata+2*sizeof(unsigned int)+sizeof(bool)); //classid (diff it) }else{ *(unsigned int*)(destdata+sizeof(unsigned int)+sizeof(bool)) = 0; *(unsigned int*)(destdata+2*sizeof(unsigned int)+sizeof(bool)) = 0; } objectOffset=sizeof(synchronisableHeader); streamOffset+=sizeof(synchronisableHeader); //now handle the object data or fill with zeros while(objectOffsetsize ){ if(sendData && streamOffsetdiffed=false; return gs; } Gamestate *Gamestate::undiff(Gamestate *base) { assert(this && base);assert(HEADER); assert(HEADER->diffed); assert(!HEADER->compressed && !GAMESTATE_HEADER(base->data_)->compressed); //unsigned char *basep = base->getGs()/*, *gs = getGs()*/; uint8_t *basep = GAMESTATE_START(base->data_); uint8_t *gs = GAMESTATE_START(this->data_); unsigned int of=0; // pointers offset unsigned int dest_length=0; dest_length=HEADER->datasize; if(dest_length==0) return NULL; uint8_t *ndata = new uint8_t[dest_length*sizeof(uint8_t)+sizeof(GamestateHeader)]; uint8_t *dest = ndata + sizeof(GamestateHeader); while(of < GAMESTATE_HEADER(base->data_)->datasize && of < HEADER->datasize){ *(dest+of)=*(basep+of)^*(gs+of); // do the xor ++of; } if(GAMESTATE_HEADER(base->data_)->datasize!=HEADER->datasize){ uint8_t n=0; if(GAMESTATE_HEADER(base->data_)->datasize < HEADER->datasize){ while(of < dest_length){ *(dest+of)=n^*(gs+of); of++; } } } *GAMESTATE_HEADER(ndata) = *HEADER; GAMESTATE_HEADER(ndata)->diffed = false; Gamestate *g = new Gamestate(ndata, getClientID()); g->flags_=flags_; g->packetDirection_ = packetDirection_; assert(!g->isDiffed()); assert(!g->isCompressed()); return g; } unsigned int Gamestate::calcGamestateSize(unsigned int id, uint8_t mode) { unsigned int size=0; // get the start of the Synchronisable list ObjectList::iterator it; // get total size of gamestate for(it = ObjectList::begin(); it; ++it) size+=it->getSize(id, mode); // size of the actual data of the synchronisable // size+=sizeof(GamestateHeader); return size; } /** * This function removes a Synchronisable out of the universe * @param it iterator of the list pointing to the object * @return iterator pointing to the next object in the list */ void Gamestate::removeObject(ObjectList::iterator &it) { ObjectList::iterator temp=it; ++it; delete *temp; } bool Gamestate::isDiffed(){ return HEADER->diffed; } bool Gamestate::isCompressed(){ return HEADER->compressed; } int Gamestate::getBaseID(){ return HEADER->base_id; } } }