Light calculation: New bulk node lighting code
[oweals/minetest.git] / src / mapblock.cpp
index 4cc0abc8176104c5a5a922205d6067de223e7df2..840cb9b3994a28da789db0f898433e8da1cc49dd 100644 (file)
@@ -35,8 +35,31 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #endif
 #include "util/string.h"
 #include "util/serialize.h"
+#include "util/basic_macros.h"
+
+static const char *modified_reason_strings[] = {
+       "initial",
+       "reallocate",
+       "setIsUnderground",
+       "setLightingExpired",
+       "setGenerated",
+       "setNode",
+       "setNodeNoCheck",
+       "setTimestamp",
+       "NodeMetaRef::reportMetadataChange",
+       "clearAllObjects",
+       "Timestamp expired (step)",
+       "addActiveObjectRaw",
+       "removeRemovedObjects/remove",
+       "removeRemovedObjects/deactivate",
+       "Stored list cleared in activateObjects due to overflow",
+       "deactivateFarObjects: Static data moved in",
+       "deactivateFarObjects: Static data moved out",
+       "deactivateFarObjects: Static data changed considerably",
+       "finishBlockMake: expireDayNightDiff",
+       "unknown",
+};
 
-#define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
 
 /*
        MapBlock
@@ -45,12 +68,12 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 MapBlock::MapBlock(Map *parent, v3s16 pos, IGameDef *gamedef, bool dummy):
                m_parent(parent),
                m_pos(pos),
+               m_pos_relative(pos * MAP_BLOCKSIZE),
                m_gamedef(gamedef),
                m_modified(MOD_STATE_WRITE_NEEDED),
-               m_modified_reason("initial"),
-               m_modified_reason_too_long(false),
+               m_modified_reason(MOD_REASON_INITIAL),
                is_underground(false),
-               m_lighting_expired(true),
+               m_lighting_complete(0xFFFF),
                m_day_night_differs(false),
                m_day_night_differs_expired(true),
                m_generated(false),
@@ -72,7 +95,7 @@ MapBlock::~MapBlock()
 {
 #ifndef SERVER
        {
-               //JMutexAutoLock lock(mesh_mutex);
+               //MutexAutoLock lock(mesh_mutex);
 
                if(mesh)
                {
@@ -109,7 +132,28 @@ MapNode MapBlock::getNodeParent(v3s16 p, bool *is_valid_position)
        }
        if (is_valid_position)
                *is_valid_position = true;
-       return data[p.Z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + p.Y*MAP_BLOCKSIZE + p.X];
+       return data[p.Z * zstride + p.Y * ystride + p.X];
+}
+
+std::string MapBlock::getModifiedReasonString()
+{
+       std::string reason;
+
+       const u32 ubound = MYMIN(sizeof(m_modified_reason) * CHAR_BIT,
+               ARRLEN(modified_reason_strings));
+
+       for (u32 i = 0; i != ubound; i++) {
+               if ((m_modified_reason & (1 << i)) == 0)
+                       continue;
+
+               reason += modified_reason_strings[i];
+               reason += ", ";
+       }
+
+       if (reason.length() > 2)
+               reason.resize(reason.length() - 2);
+
+       return reason;
 }
 
 /*
@@ -330,47 +374,42 @@ void MapBlock::copyFrom(VoxelManipulator &dst)
 void MapBlock::actuallyUpdateDayNightDiff()
 {
        INodeDefManager *nodemgr = m_gamedef->ndef();
+
        // Running this function un-expires m_day_night_differs
        m_day_night_differs_expired = false;
 
-       if(data == NULL)
-       {
+       if (data == NULL) {
                m_day_night_differs = false;
                return;
        }
 
-       bool differs = false;
+       bool differs;
 
        /*
                Check if any lighting value differs
        */
-       for(u32 i=0; i<MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE; i++)
-       {
+       for (u32 i = 0; i < nodecount; i++) {
                MapNode &n = data[i];
-               if(n.getLight(LIGHTBANK_DAY, nodemgr) != n.getLight(LIGHTBANK_NIGHT, nodemgr))
-               {
-                       differs = true;
+
+               differs = !n.isLightDayNightEq(nodemgr);
+               if (differs)
                        break;
-               }
        }
 
        /*
                If some lighting values differ, check if the whole thing is
-               just air. If it is, differ = false
+               just air. If it is just air, differs = false
        */
-       if(differs)
-       {
+       if (differs) {
                bool only_air = true;
-               for(u32 i=0; i<MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE; i++)
-               {
+               for (u32 i = 0; i < nodecount; i++) {
                        MapNode &n = data[i];
-                       if(n.getContent() != CONTENT_AIR)
-                       {
+                       if (n.getContent() != CONTENT_AIR) {
                                only_air = false;
                                break;
                        }
                }
-               if(only_air)
+               if (only_air)
                        differs = false;
        }
 
@@ -426,16 +465,15 @@ s16 MapBlock::getGroundLevel(v2s16 p2d)
 // sure we can handle all content ids. But it's absolutely worth it as it's
 // a speedup of 4 for one of the major time consuming functions on storing
 // mapblocks.
-static content_t getBlockNodeIdMapping_mapping[USHRT_MAX];
+static content_t getBlockNodeIdMapping_mapping[USHRT_MAX + 1];
 static void getBlockNodeIdMapping(NameIdMapping *nimap, MapNode *nodes,
                INodeDefManager *nodedef)
 {
-       memset(getBlockNodeIdMapping_mapping, 0xFF, USHRT_MAX * sizeof(content_t));
+       memset(getBlockNodeIdMapping_mapping, 0xFF, (USHRT_MAX + 1) * sizeof(content_t));
 
        std::set<content_t> unknown_contents;
        content_t id_counter = 0;
-       for(u32 i=0; i<MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE; i++)
-       {
+       for (u32 i = 0; i < MapBlock::nodecount; i++) {
                content_t global_id = nodes[i].getContent();
                content_t id = CONTENT_IGNORE;
 
@@ -462,7 +500,7 @@ static void getBlockNodeIdMapping(NameIdMapping *nimap, MapNode *nodes,
        }
        for(std::set<content_t>::const_iterator
                        i = unknown_contents.begin();
-                       i != unknown_contents.end(); i++){
+                       i != unknown_contents.end(); ++i){
                errorstream<<"getBlockNodeIdMapping(): IGNORING ERROR: "
                                <<"Name for node id "<<(*i)<<" not known"<<std::endl;
        }
@@ -480,8 +518,7 @@ static void correctBlockNodeIds(const NameIdMapping *nimap, MapNode *nodes,
        // correct ids.
        std::set<content_t> unnamed_contents;
        std::set<std::string> unallocatable_contents;
-       for(u32 i=0; i<MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE; i++)
-       {
+       for (u32 i = 0; i < MapBlock::nodecount; i++) {
                content_t local_id = nodes[i].getContent();
                std::string name;
                bool found = nimap->getName(local_id, name);
@@ -502,14 +539,14 @@ static void correctBlockNodeIds(const NameIdMapping *nimap, MapNode *nodes,
        }
        for(std::set<content_t>::const_iterator
                        i = unnamed_contents.begin();
-                       i != unnamed_contents.end(); i++){
+                       i != unnamed_contents.end(); ++i){
                errorstream<<"correctBlockNodeIds(): IGNORING ERROR: "
                                <<"Block contains id "<<(*i)
                                <<" with no name mapping"<<std::endl;
        }
        for(std::set<std::string>::const_iterator
                        i = unallocatable_contents.begin();
-                       i != unallocatable_contents.end(); i++){
+                       i != unallocatable_contents.end(); ++i){
                errorstream<<"correctBlockNodeIds(): IGNORING ERROR: "
                                <<"Could not allocate global id for node name \""
                                <<(*i)<<"\""<<std::endl;
@@ -526,11 +563,7 @@ void MapBlock::serialize(std::ostream &os, u8 version, bool disk)
                throw SerializationError("ERROR: Not writing dummy block.");
        }
 
-       // Can't do this anymore; we have 16-bit dynamically allocated node IDs
-       // in memory; conversion just won't work in this direction.
-       if(version < 24)
-               throw SerializationError("MapBlock::serialize: serialization to "
-                               "version < 24 not possible");
+       FATAL_ERROR_IF(version < SER_FMT_VER_LOWEST_WRITE, "Serialisation version error");
 
        // First byte
        u8 flags = 0;
@@ -538,17 +571,17 @@ void MapBlock::serialize(std::ostream &os, u8 version, bool disk)
                flags |= 0x01;
        if(getDayNightDiff())
                flags |= 0x02;
-       if(m_lighting_expired)
-               flags |= 0x04;
        if(m_generated == false)
                flags |= 0x08;
        writeU8(os, flags);
+       if (version >= 27) {
+               writeU16(os, m_lighting_complete);
+       }
 
        /*
                Bulk node data
        */
        NameIdMapping nimap;
-       u32 nodecount = MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE;
        if(disk)
        {
                MapNode *tmp_nodes = new MapNode[nodecount];
@@ -640,7 +673,11 @@ void MapBlock::deSerialize(std::istream &is, u8 version, bool disk)
        u8 flags = readU8(is);
        is_underground = (flags & 0x01) ? true : false;
        m_day_night_differs = (flags & 0x02) ? true : false;
-       m_lighting_expired = (flags & 0x04) ? true : false;
+       if (version < 27) {
+               m_lighting_complete = 0xFFFF;
+       } else {
+               m_lighting_complete = readU16(is);
+       }
        m_generated = (flags & 0x08) ? false : true;
 
        /*
@@ -648,7 +685,6 @@ void MapBlock::deSerialize(std::istream &is, u8 version, bool disk)
        */
        TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
                        <<": Bulk node data"<<std::endl);
-       u32 nodecount = MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE;
        u8 content_width = readU8(is);
        u8 params_width = readU8(is);
        if(content_width != 1 && content_width != 2)
@@ -664,20 +700,18 @@ void MapBlock::deSerialize(std::istream &is, u8 version, bool disk)
        TRACESTREAM(<<"MapBlock::deSerialize "<<PP(getPos())
                        <<": Node metadata"<<std::endl);
        // Ignore errors
-       try{
+       try {
                std::ostringstream oss(std::ios_base::binary);
                decompressZlib(is, oss);
                std::istringstream iss(oss.str(), std::ios_base::binary);
-               if(version >= 23)
-                       m_node_metadata.deSerialize(iss, m_gamedef);
+               if (version >= 23)
+                       m_node_metadata.deSerialize(iss, m_gamedef->idef());
                else
                        content_nodemeta_deserialize_legacy(iss,
-                                       &m_node_metadata, &m_node_timers,
-                                       m_gamedef);
-       }
-       catch(SerializationError &e)
-       {
-               errorstream<<"WARNING: MapBlock::deSerialize(): Ignoring an error"
+                               &m_node_metadata, &m_node_timers,
+                               m_gamedef->idef());
+       } catch(SerializationError &e) {
+               warningstream<<"MapBlock::deSerialize(): Ignoring an error"
                                <<" while deserializing node metadata at ("
                                <<PP(getPos())<<": "<<e.what()<<std::endl;
        }
@@ -740,7 +774,7 @@ void MapBlock::deSerializeNetworkSpecific(std::istream &is)
        }
        catch(SerializationError &e)
        {
-               errorstream<<"WARNING: MapBlock::deSerializeNetworkSpecific(): Ignoring an error"
+               warningstream<<"MapBlock::deSerializeNetworkSpecific(): Ignoring an error"
                                <<": "<<e.what()<<std::endl;
        }
 }
@@ -751,12 +785,10 @@ void MapBlock::deSerializeNetworkSpecific(std::istream &is)
 
 void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
 {
-       u32 nodecount = MAP_BLOCKSIZE*MAP_BLOCKSIZE*MAP_BLOCKSIZE;
-
        // Initialize default flags
        is_underground = false;
        m_day_night_differs = false;
-       m_lighting_expired = false;
+       m_lighting_complete = 0xFFFF;
        m_generated = true;
 
        // Make a temporary buffer
@@ -764,23 +796,20 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
        SharedBuffer<u8> databuf_nodelist(nodecount * ser_length);
 
        // These have no compression
-       if(version <= 3 || version == 5 || version == 6)
-       {
+       if (version <= 3 || version == 5 || version == 6) {
                char tmp;
                is.read(&tmp, 1);
-               if(is.gcount() != 1)
-                       throw SerializationError
-                                       ("MapBlock::deSerialize: no enough input data");
+               if (is.gcount() != 1)
+                       throw SerializationError(std::string(FUNCTION_NAME)
+                               + ": not enough input data");
                is_underground = tmp;
-               is.read((char*)*databuf_nodelist, nodecount * ser_length);
-               if((u32)is.gcount() != nodecount * ser_length)
-                       throw SerializationError
-                                       ("MapBlock::deSerialize: no enough input data");
-       }
-       else if(version <= 10)
-       {
+               is.read((char *)*databuf_nodelist, nodecount * ser_length);
+               if ((u32)is.gcount() != nodecount * ser_length)
+                       throw SerializationError(std::string(FUNCTION_NAME)
+                               + ": not enough input data");
+       } else if (version <= 10) {
                u8 t8;
-               is.read((char*)&t8, 1);
+               is.read((char *)&t8, 1);
                is_underground = t8;
 
                {
@@ -788,11 +817,10 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                        std::ostringstream os(std::ios_base::binary);
                        decompress(is, os, version);
                        std::string s = os.str();
-                       if(s.size() != nodecount)
-                               throw SerializationError
-                                               ("MapBlock::deSerialize: invalid format");
-                       for(u32 i=0; i<s.size(); i++)
-                       {
+                       if (s.size() != nodecount)
+                               throw SerializationError(std::string(FUNCTION_NAME)
+                                       + ": not enough input data");
+                       for (u32 i = 0; i < s.size(); i++) {
                                databuf_nodelist[i*ser_length] = s[i];
                        }
                }
@@ -801,38 +829,31 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                        std::ostringstream os(std::ios_base::binary);
                        decompress(is, os, version);
                        std::string s = os.str();
-                       if(s.size() != nodecount)
-                               throw SerializationError
-                                               ("MapBlock::deSerialize: invalid format");
-                       for(u32 i=0; i<s.size(); i++)
-                       {
+                       if (s.size() != nodecount)
+                               throw SerializationError(std::string(FUNCTION_NAME)
+                                       + ": not enough input data");
+                       for (u32 i = 0; i < s.size(); i++) {
                                databuf_nodelist[i*ser_length + 1] = s[i];
                        }
                }
 
-               if(version >= 10)
-               {
+               if (version >= 10) {
                        // Uncompress and set param2 data
                        std::ostringstream os(std::ios_base::binary);
                        decompress(is, os, version);
                        std::string s = os.str();
-                       if(s.size() != nodecount)
-                               throw SerializationError
-                                               ("MapBlock::deSerialize: invalid format");
-                       for(u32 i=0; i<s.size(); i++)
-                       {
+                       if (s.size() != nodecount)
+                               throw SerializationError(std::string(FUNCTION_NAME)
+                                       + ": not enough input data");
+                       for (u32 i = 0; i < s.size(); i++) {
                                databuf_nodelist[i*ser_length + 2] = s[i];
                        }
                }
-       }
-       // All other versions (newest)
-       else
-       {
+       } else { // All other versions (10 to 21)
                u8 flags;
                is.read((char*)&flags, 1);
                is_underground = (flags & 0x01) ? true : false;
                m_day_night_differs = (flags & 0x02) ? true : false;
-               m_lighting_expired = (flags & 0x04) ? true : false;
                if(version >= 18)
                        m_generated = (flags & 0x08) ? false : true;
 
@@ -840,14 +861,12 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                std::ostringstream os(std::ios_base::binary);
                decompress(is, os, version);
                std::string s = os.str();
-               if(s.size() != nodecount*3)
-                       throw SerializationError
-                                       ("MapBlock::deSerialize: decompress resulted in size"
-                                       " other than nodecount*3");
+               if (s.size() != nodecount * 3)
+                       throw SerializationError(std::string(FUNCTION_NAME)
+                               + ": decompress resulted in size other than nodecount*3");
 
                // deserialize nodes from buffer
-               for(u32 i=0; i<nodecount; i++)
-               {
+               for (u32 i = 0; i < nodecount; i++) {
                        databuf_nodelist[i*ser_length] = s[i];
                        databuf_nodelist[i*ser_length + 1] = s[i+nodecount];
                        databuf_nodelist[i*ser_length + 2] = s[i+nodecount*2];
@@ -856,53 +875,45 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                /*
                        NodeMetadata
                */
-               if(version >= 14)
-               {
+               if (version >= 14) {
                        // Ignore errors
-                       try{
-                               if(version <= 15)
-                               {
+                       try {
+                               if (version <= 15) {
                                        std::string data = deSerializeString(is);
                                        std::istringstream iss(data, std::ios_base::binary);
                                        content_nodemeta_deserialize_legacy(iss,
-                                                       &m_node_metadata, &m_node_timers,
-                                                       m_gamedef);
-                               }
-                               else
-                               {
+                                               &m_node_metadata, &m_node_timers,
+                                               m_gamedef->idef());
+                               } else {
                                        //std::string data = deSerializeLongString(is);
                                        std::ostringstream oss(std::ios_base::binary);
                                        decompressZlib(is, oss);
                                        std::istringstream iss(oss.str(), std::ios_base::binary);
                                        content_nodemeta_deserialize_legacy(iss,
-                                                       &m_node_metadata, &m_node_timers,
-                                                       m_gamedef);
+                                               &m_node_metadata, &m_node_timers,
+                                               m_gamedef->idef());
                                }
-                       }
-                       catch(SerializationError &e)
-                       {
-                               errorstream<<"WARNING: MapBlock::deSerialize(): Ignoring an error"
+                       } catch(SerializationError &e) {
+                               warningstream<<"MapBlock::deSerialize(): Ignoring an error"
                                                <<" while deserializing node metadata"<<std::endl;
                        }
                }
        }
 
        // Deserialize node data
-       for(u32 i=0; i<nodecount; i++)
-       {
-               data[i].deSerialize(&databuf_nodelist[i*ser_length], version);
+       for (u32 i = 0; i < nodecount; i++) {
+               data[i].deSerialize(&databuf_nodelist[i * ser_length], version);
        }
 
-       if(disk)
-       {
+       if (disk) {
                /*
                        Versions up from 9 have block objects. (DEPRECATED)
                */
-               if(version >= 9){
+               if (version >= 9) {
                        u16 count = readU16(is);
                        // Not supported and length not known if count is not 0
                        if(count != 0){
-                               errorstream<<"WARNING: MapBlock::deSerialize_pre22(): "
+                               warningstream<<"MapBlock::deSerialize_pre22(): "
                                                <<"Ignoring stuff coming at and after MBOs"<<std::endl;
                                return;
                        }
@@ -911,11 +922,11 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                /*
                        Versions up from 15 have static objects.
                */
-               if(version >= 15)
+               if (version >= 15)
                        m_static_objects.deSerialize(is);
 
                // Timestamp
-               if(version >= 17){
+               if (version >= 17) {
                        setTimestamp(readU32(is));
                        m_disk_timestamp = m_timestamp;
                } else {
@@ -925,7 +936,7 @@ void MapBlock::deSerialize_pre22(std::istream &is, u8 version, bool disk)
                // Dynamically re-set ids based on node names
                NameIdMapping nimap;
                // If supported, read node definition id mapping
-               if(version >= 21){
+               if (version >= 21) {
                        nimap.deSerialize(is);
                // Else set the legacy mapping
                } else {
@@ -1020,10 +1031,7 @@ std::string analyze_block(MapBlock *block)
        else
                desc<<"is_ug [ ], ";
 
-       if(block->getLightingExpired())
-               desc<<"lighting_exp [X], ";
-       else
-               desc<<"lighting_exp [ ], ";
+       desc<<"lighting_complete: "<<block->getLightingComplete()<<", ";
 
        if(block->isDummy())
        {