3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include "nodemetadata.h"
29 #include "nameidmapping.h"
30 #include "content_mapnode.h" // For legacy name-id mapping
31 #include "content_nodemeta.h" // For legacy deserialization
32 #include "serialization.h"
34 #include "client/mapblock_mesh.h"
37 #include "util/string.h"
38 #include "util/serialize.h"
39 #include "util/basic_macros.h"
41 static const char *modified_reason_strings[] = {
50 "NodeMetaRef::reportMetadataChange",
52 "Timestamp expired (step)",
54 "removeRemovedObjects/remove",
55 "removeRemovedObjects/deactivate",
56 "Stored list cleared in activateObjects due to overflow",
57 "deactivateFarObjects: Static data moved in",
58 "deactivateFarObjects: Static data moved out",
59 "deactivateFarObjects: Static data changed considerably",
60 "finishBlockMake: expireDayNightDiff",
69 MapBlock::MapBlock(Map *parent, v3s16 pos, IGameDef *gamedef, bool dummy):
72 m_pos_relative(pos * MAP_BLOCKSIZE),
91 bool MapBlock::isValidPositionParent(v3s16 p)
93 if (isValidPosition(p)) {
97 return m_parent->isValidPosition(getPosRelative() + p);
100 MapNode MapBlock::getNodeParent(v3s16 p, bool *is_valid_position)
102 if (!isValidPosition(p))
103 return m_parent->getNode(getPosRelative() + p, is_valid_position);
106 if (is_valid_position)
107 *is_valid_position = false;
108 return {CONTENT_IGNORE};
110 if (is_valid_position)
111 *is_valid_position = true;
112 return data[p.Z * zstride + p.Y * ystride + p.X];
115 std::string MapBlock::getModifiedReasonString()
119 const u32 ubound = MYMIN(sizeof(m_modified_reason) * CHAR_BIT,
120 ARRLEN(modified_reason_strings));
122 for (u32 i = 0; i != ubound; i++) {
123 if ((m_modified_reason & (1 << i)) == 0)
126 reason += modified_reason_strings[i];
130 if (reason.length() > 2)
131 reason.resize(reason.length() - 2);
137 void MapBlock::copyTo(VoxelManipulator &dst)
139 v3s16 data_size(MAP_BLOCKSIZE, MAP_BLOCKSIZE, MAP_BLOCKSIZE);
140 VoxelArea data_area(v3s16(0,0,0), data_size - v3s16(1,1,1));
142 // Copy from data to VoxelManipulator
143 dst.copyFrom(data, data_area, v3s16(0,0,0),
144 getPosRelative(), data_size);
147 void MapBlock::copyFrom(VoxelManipulator &dst)
149 v3s16 data_size(MAP_BLOCKSIZE, MAP_BLOCKSIZE, MAP_BLOCKSIZE);
150 VoxelArea data_area(v3s16(0,0,0), data_size - v3s16(1,1,1));
152 // Copy from VoxelManipulator to data
153 dst.copyTo(data, data_area, v3s16(0,0,0),
154 getPosRelative(), data_size);
157 void MapBlock::actuallyUpdateDayNightDiff()
159 const NodeDefManager *nodemgr = m_gamedef->ndef();
161 // Running this function un-expires m_day_night_differs
162 m_day_night_differs_expired = false;
165 m_day_night_differs = false;
169 bool differs = false;
172 Check if any lighting value differs
175 MapNode previous_n(CONTENT_IGNORE);
176 for (u32 i = 0; i < nodecount; i++) {
179 // If node is identical to previous node, don't verify if it differs
183 differs = !n.isLightDayNightEq(nodemgr);
190 If some lighting values differ, check if the whole thing is
191 just air. If it is just air, differs = false
194 bool only_air = true;
195 for (u32 i = 0; i < nodecount; i++) {
196 MapNode &n = data[i];
197 if (n.getContent() != CONTENT_AIR) {
206 // Set member variable
207 m_day_night_differs = differs;
210 void MapBlock::expireDayNightDiff()
213 m_day_night_differs = false;
214 m_day_night_differs_expired = false;
218 m_day_night_differs_expired = true;
221 s16 MapBlock::getGroundLevel(v2s16 p2d)
227 s16 y = MAP_BLOCKSIZE-1;
230 MapNode n = getNodeRef(p2d.X, y, p2d.Y);
231 if (m_gamedef->ndef()->get(n).walkable) {
232 if(y == MAP_BLOCKSIZE-1)
240 catch(InvalidPositionException &e)
249 // List relevant id-name pairs for ids in the block using nodedef
250 // Renumbers the content IDs (starting at 0 and incrementing
251 // use static memory requires about 65535 * sizeof(int) ram in order to be
252 // sure we can handle all content ids. But it's absolutely worth it as it's
253 // a speedup of 4 for one of the major time consuming functions on storing
255 static content_t getBlockNodeIdMapping_mapping[USHRT_MAX + 1];
256 static void getBlockNodeIdMapping(NameIdMapping *nimap, MapNode *nodes,
257 const NodeDefManager *nodedef)
259 memset(getBlockNodeIdMapping_mapping, 0xFF, (USHRT_MAX + 1) * sizeof(content_t));
261 std::set<content_t> unknown_contents;
262 content_t id_counter = 0;
263 for (u32 i = 0; i < MapBlock::nodecount; i++) {
264 content_t global_id = nodes[i].getContent();
265 content_t id = CONTENT_IGNORE;
267 // Try to find an existing mapping
268 if (getBlockNodeIdMapping_mapping[global_id] != 0xFFFF) {
269 id = getBlockNodeIdMapping_mapping[global_id];
273 // We have to assign a new mapping
275 getBlockNodeIdMapping_mapping[global_id] = id;
277 const ContentFeatures &f = nodedef->get(global_id);
278 const std::string &name = f.name;
280 unknown_contents.insert(global_id);
282 nimap->set(id, name);
285 // Update the MapNode
286 nodes[i].setContent(id);
288 for (u16 unknown_content : unknown_contents) {
289 errorstream << "getBlockNodeIdMapping(): IGNORING ERROR: "
290 << "Name for node id " << unknown_content << " not known" << std::endl;
293 // Correct ids in the block to match nodedef based on names.
294 // Unknown ones are added to nodedef.
295 // Will not update itself to match id-name pairs in nodedef.
296 static void correctBlockNodeIds(const NameIdMapping *nimap, MapNode *nodes,
299 const NodeDefManager *nodedef = gamedef->ndef();
300 // This means the block contains incorrect ids, and we contain
301 // the information to convert those to names.
302 // nodedef contains information to convert our names to globally
304 std::unordered_set<content_t> unnamed_contents;
305 std::unordered_set<std::string> unallocatable_contents;
307 bool previous_exists = false;
308 content_t previous_local_id = CONTENT_IGNORE;
309 content_t previous_global_id = CONTENT_IGNORE;
311 for (u32 i = 0; i < MapBlock::nodecount; i++) {
312 content_t local_id = nodes[i].getContent();
313 // If previous node local_id was found and same than before, don't lookup maps
314 // apply directly previous resolved id
315 // This permits to massively improve loading performance when nodes are similar
316 // example: default:air, default:stone are massively present
317 if (previous_exists && local_id == previous_local_id) {
318 nodes[i].setContent(previous_global_id);
323 if (!nimap->getName(local_id, name)) {
324 unnamed_contents.insert(local_id);
325 previous_exists = false;
330 if (!nodedef->getId(name, global_id)) {
331 global_id = gamedef->allocateUnknownNodeId(name);
332 if (global_id == CONTENT_IGNORE) {
333 unallocatable_contents.insert(name);
334 previous_exists = false;
338 nodes[i].setContent(global_id);
340 // Save previous node local_id & global_id result
341 previous_local_id = local_id;
342 previous_global_id = global_id;
343 previous_exists = true;
346 for (const content_t c: unnamed_contents) {
347 errorstream << "correctBlockNodeIds(): IGNORING ERROR: "
348 << "Block contains id " << c
349 << " with no name mapping" << std::endl;
351 for (const std::string &node_name: unallocatable_contents) {
352 errorstream << "correctBlockNodeIds(): IGNORING ERROR: "
353 << "Could not allocate global id for node name \""
354 << node_name << "\"" << std::endl;
358 void MapBlock::serialize(std::ostream &os_compressed, u8 version, bool disk, int compression_level)
360 if(!ser_ver_supported(version))
361 throw VersionMismatchException("ERROR: MapBlock format not supported");
364 throw SerializationError("ERROR: Not writing dummy block.");
366 FATAL_ERROR_IF(version < SER_FMT_VER_LOWEST_WRITE, "Serialisation version error");
368 std::ostringstream os_raw(std::ios_base::binary);
369 std::ostream &os = version >= 29 ? os_raw : os_compressed;
375 if(getDayNightDiff())
381 writeU16(os, m_lighting_complete);
388 SharedBuffer<u8> buf;
389 const u8 content_width = 2;
390 const u8 params_width = 2;
393 MapNode *tmp_nodes = new MapNode[nodecount];
394 memcpy(tmp_nodes, data, nodecount * sizeof(MapNode));
395 getBlockNodeIdMapping(&nimap, tmp_nodes, m_gamedef->ndef());
397 buf = MapNode::serializeBulk(version, tmp_nodes, nodecount,
398 content_width, params_width);
401 // write timestamp and node/id mapping first
403 writeU32(os, getTimestamp());
410 buf = MapNode::serializeBulk(version, data, nodecount,
411 content_width, params_width);
414 writeU8(os, content_width);
415 writeU8(os, params_width);
417 os.write(reinterpret_cast<char*>(*buf), buf.getSize());
419 // prior to 29 node data was compressed individually
420 compress(buf, os, version, compression_level);
427 m_node_metadata.serialize(os, version, disk);
429 // use os_raw from above to avoid allocating another stream object
430 m_node_metadata.serialize(os_raw, version, disk);
431 // prior to 29 node data was compressed individually
432 compress(os_raw.str(), os, version, compression_level);
436 Data that goes to disk, but not the network
442 m_node_timers.serialize(os, version);
446 m_static_objects.serialize(os);
450 writeU32(os, getTimestamp());
452 // Write block-specific node definition id mapping
458 m_node_timers.serialize(os, version);
463 // now compress the whole thing
464 compress(os_raw.str(), os_compressed, version, compression_level);
468 void MapBlock::serializeNetworkSpecific(std::ostream &os)
471 throw SerializationError("ERROR: Not writing dummy block.");
474 writeU8(os, 2); // version
477 void MapBlock::deSerialize(std::istream &in_compressed, u8 version, bool disk)
479 if(!ser_ver_supported(version))
480 throw VersionMismatchException("ERROR: MapBlock format not supported");
482 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())<<std::endl);
484 m_day_night_differs_expired = false;
488 deSerialize_pre22(in_compressed, version, disk);
492 // Decompress the whole block (version >= 29)
493 std::stringstream in_raw(std::ios_base::binary | std::ios_base::in | std::ios_base::out);
495 decompress(in_compressed, in_raw, version);
496 std::istream &is = version >= 29 ? in_raw : in_compressed;
498 u8 flags = readU8(is);
499 is_underground = (flags & 0x01) != 0;
500 m_day_night_differs = (flags & 0x02) != 0;
502 m_lighting_complete = 0xFFFF;
504 m_lighting_complete = readU16(is);
505 m_generated = (flags & 0x08) == 0;
508 if (disk && version >= 29) {
510 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
511 <<": Timestamp"<<std::endl);
512 setTimestampNoChangedFlag(readU32(is));
513 m_disk_timestamp = m_timestamp;
516 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
517 <<": NameIdMapping"<<std::endl);
518 nimap.deSerialize(is);
521 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
522 <<": Bulk node data"<<std::endl);
523 u8 content_width = readU8(is);
524 u8 params_width = readU8(is);
525 if(content_width != 1 && content_width != 2)
526 throw SerializationError("MapBlock::deSerialize(): invalid content_width");
527 if(params_width != 2)
528 throw SerializationError("MapBlock::deSerialize(): invalid params_width");
534 MapNode::deSerializeBulk(is, version, data, nodecount,
535 content_width, params_width);
537 // use in_raw from above to avoid allocating another stream object
538 decompress(is, in_raw, version);
539 MapNode::deSerializeBulk(in_raw, version, data, nodecount,
540 content_width, params_width);
546 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
547 <<": Node metadata"<<std::endl);
549 m_node_metadata.deSerialize(is, m_gamedef->idef());
555 decompress(is, in_raw, version);
557 m_node_metadata.deSerialize(in_raw, m_gamedef->idef());
559 content_nodemeta_deserialize_legacy(in_raw,
560 &m_node_metadata, &m_node_timers,
562 } catch(SerializationError &e) {
563 warningstream<<"MapBlock::deSerialize(): Ignoring an error"
564 <<" while deserializing node metadata at ("
565 <<PP(getPos())<<": "<<e.what()<<std::endl;
570 Data that is only on disk
580 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
581 <<": Node timers (ver==24)"<<std::endl);
582 m_node_timers.deSerialize(is, version);
586 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
587 <<": Static objects"<<std::endl);
588 m_static_objects.deSerialize(is);
592 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
593 <<": Timestamp"<<std::endl);
594 setTimestampNoChangedFlag(readU32(is));
595 m_disk_timestamp = m_timestamp;
598 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
599 <<": NameIdMapping"<<std::endl);
600 nimap.deSerialize(is);
603 // Dynamically re-set ids based on node names
604 correctBlockNodeIds(&nimap, data, m_gamedef);
607 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
608 <<": Node timers (ver>=25)"<<std::endl);
609 m_node_timers.deSerialize(is, version);
613 TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
614 <<": Done."<<std::endl);
617 void MapBlock::deSerializeNetworkSpecific(std::istream &is)
621 //const u8 version = readU8(is);
623 //throw SerializationError("unsupported MapBlock version");
625 } catch(SerializationError &e) {
626 warningstream<<"MapBlock::deSerializeNetworkSpecific(): Ignoring an error"
627 <<": "<<e.what()<<std::endl;
635 void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
637 // Initialize default flags
638 is_underground = false;
639 m_day_night_differs = false;
640 m_lighting_complete = 0xFFFF;
643 // Make a temporary buffer
644 u32 ser_length = MapNode::serializedLength(version);
645 SharedBuffer<u8> databuf_nodelist(nodecount * ser_length);
647 // These have no compression
648 if (version <= 3 || version == 5 || version == 6) {
651 if (is.gcount() != 1)
652 throw SerializationError(std::string(FUNCTION_NAME)
653 + ": not enough input data");
654 is_underground = tmp;
655 is.read((char *)*databuf_nodelist, nodecount * ser_length);
656 if ((u32)is.gcount() != nodecount * ser_length)
657 throw SerializationError(std::string(FUNCTION_NAME)
658 + ": not enough input data");
659 } else if (version <= 10) {
661 is.read((char *)&t8, 1);
665 // Uncompress and set material data
666 std::ostringstream os(std::ios_base::binary);
667 decompress(is, os, version);
668 std::string s = os.str();
669 if (s.size() != nodecount)
670 throw SerializationError(std::string(FUNCTION_NAME)
671 + ": not enough input data");
672 for (u32 i = 0; i < s.size(); i++) {
673 databuf_nodelist[i*ser_length] = s[i];
677 // Uncompress and set param data
678 std::ostringstream os(std::ios_base::binary);
679 decompress(is, os, version);
680 std::string s = os.str();
681 if (s.size() != nodecount)
682 throw SerializationError(std::string(FUNCTION_NAME)
683 + ": not enough input data");
684 for (u32 i = 0; i < s.size(); i++) {
685 databuf_nodelist[i*ser_length + 1] = s[i];
690 // Uncompress and set param2 data
691 std::ostringstream os(std::ios_base::binary);
692 decompress(is, os, version);
693 std::string s = os.str();
694 if (s.size() != nodecount)
695 throw SerializationError(std::string(FUNCTION_NAME)
696 + ": not enough input data");
697 for (u32 i = 0; i < s.size(); i++) {
698 databuf_nodelist[i*ser_length + 2] = s[i];
701 } else { // All other versions (10 to 21)
703 is.read((char*)&flags, 1);
704 is_underground = (flags & 0x01) != 0;
705 m_day_night_differs = (flags & 0x02) != 0;
707 m_generated = (flags & 0x08) == 0;
710 std::ostringstream os(std::ios_base::binary);
711 decompress(is, os, version);
712 std::string s = os.str();
713 if (s.size() != nodecount * 3)
714 throw SerializationError(std::string(FUNCTION_NAME)
715 + ": decompress resulted in size other than nodecount*3");
717 // deserialize nodes from buffer
718 for (u32 i = 0; i < nodecount; i++) {
719 databuf_nodelist[i*ser_length] = s[i];
720 databuf_nodelist[i*ser_length + 1] = s[i+nodecount];
721 databuf_nodelist[i*ser_length + 2] = s[i+nodecount*2];
731 std::string data = deSerializeString16(is);
732 std::istringstream iss(data, std::ios_base::binary);
733 content_nodemeta_deserialize_legacy(iss,
734 &m_node_metadata, &m_node_timers,
737 //std::string data = deSerializeString32(is);
738 std::ostringstream oss(std::ios_base::binary);
739 decompressZlib(is, oss);
740 std::istringstream iss(oss.str(), std::ios_base::binary);
741 content_nodemeta_deserialize_legacy(iss,
742 &m_node_metadata, &m_node_timers,
745 } catch(SerializationError &e) {
746 warningstream<<"MapBlock::deSerialize(): Ignoring an error"
747 <<" while deserializing node metadata"<<std::endl;
752 // Deserialize node data
753 for (u32 i = 0; i < nodecount; i++) {
754 data[i].deSerialize(&databuf_nodelist[i * ser_length], version);
759 Versions up from 9 have block objects. (DEPRECATED)
762 u16 count = readU16(is);
763 // Not supported and length not known if count is not 0
765 warningstream<<"MapBlock::deSerialize_pre22(): "
766 <<"Ignoring stuff coming at and after MBOs"<<std::endl;
772 Versions up from 15 have static objects.
775 m_static_objects.deSerialize(is);
779 setTimestampNoChangedFlag(readU32(is));
780 m_disk_timestamp = m_timestamp;
782 setTimestampNoChangedFlag(BLOCK_TIMESTAMP_UNDEFINED);
785 // Dynamically re-set ids based on node names
787 // If supported, read node definition id mapping
789 nimap.deSerialize(is);
790 // Else set the legacy mapping
792 content_mapnode_get_name_id_mapping(&nimap);
794 correctBlockNodeIds(&nimap, data, m_gamedef);
798 // Legacy data changes
799 // This code has to convert from pre-22 to post-22 format.
800 const NodeDefManager *nodedef = m_gamedef->ndef();
801 for(u32 i=0; i<nodecount; i++)
803 const ContentFeatures &f = nodedef->get(data[i].getContent());
805 if(nodedef->getId("default:stone") == data[i].getContent()
806 && data[i].getParam1() == 1)
808 data[i].setContent(nodedef->getId("default:stone_with_coal"));
809 data[i].setParam1(0);
811 else if(nodedef->getId("default:stone") == data[i].getContent()
812 && data[i].getParam1() == 2)
814 data[i].setContent(nodedef->getId("default:stone_with_iron"));
815 data[i].setParam1(0);
818 if(f.legacy_facedir_simple)
820 data[i].setParam2(data[i].getParam1());
821 data[i].setParam1(0);
824 if(f.legacy_wallmounted)
826 u8 wallmounted_new_to_old[8] = {0x04, 0x08, 0x01, 0x02, 0x10, 0x20, 0, 0};
827 u8 dir_old_format = data[i].getParam2();
828 u8 dir_new_format = 0;
829 for(u8 j=0; j<8; j++)
831 if((dir_old_format & wallmounted_new_to_old[j]) != 0)
837 data[i].setParam2(dir_new_format);
844 Get a quick string to describe what a block actually contains
846 std::string analyze_block(MapBlock *block)
851 std::ostringstream desc;
853 v3s16 p = block->getPos();
855 porting::mt_snprintf(spos, sizeof(spos), "(%2d,%2d,%2d), ", p.X, p.Y, p.Z);
858 switch(block->getModified())
860 case MOD_STATE_CLEAN:
863 case MOD_STATE_WRITE_AT_UNLOAD:
864 desc<<"WRITE_AT_UNLOAD, ";
866 case MOD_STATE_WRITE_NEEDED:
867 desc<<"WRITE_NEEDED, ";
870 desc<<"unknown getModified()="+itos(block->getModified())+", ";
873 if(block->isGenerated())
874 desc<<"is_gen [X], ";
876 desc<<"is_gen [ ], ";
878 if(block->getIsUnderground())
883 desc<<"lighting_complete: "<<block->getLightingComplete()<<", ";
891 bool full_ignore = true;
892 bool some_ignore = false;
893 bool full_air = true;
894 bool some_air = false;
895 for(s16 z0=0; z0<MAP_BLOCKSIZE; z0++)
896 for(s16 y0=0; y0<MAP_BLOCKSIZE; y0++)
897 for(s16 x0=0; x0<MAP_BLOCKSIZE; x0++)
900 MapNode n = block->getNodeNoEx(p);
901 content_t c = n.getContent();
902 if(c == CONTENT_IGNORE)
914 std::ostringstream ss;
917 ss<<"IGNORE (full), ";
926 if(ss.str().size()>=2)
927 desc<<ss.str().substr(0, ss.str().size()-2);
932 return desc.str().substr(0, desc.str().size()-2);