]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/mapgen/mapgen.cpp
fix integer overflow in mapgen (#11641)
[dragonfireclient.git] / src / mapgen / mapgen.cpp
index 67e9d644d094d700be852f96cb9c8a6255de7012..1f2ac491e952331e41aac3249760d5d18be5c3f7 100644 (file)
@@ -28,7 +28,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "mapblock.h"
 #include "mapnode.h"
 #include "map.h"
-#include "content_sao.h"
 #include "nodedef.h"
 #include "emerge.h"
 #include "voxelalgorithms.h"
@@ -39,6 +38,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "serialization.h"
 #include "util/serialize.h"
 #include "util/numeric.h"
+#include "util/directiontables.h"
 #include "filesys.h"
 #include "log.h"
 #include "mapgen_carpathian.h"
@@ -58,6 +58,7 @@ FlagDesc flagdesc_mapgen[] = {
        {"light",       MG_LIGHT},
        {"decorations", MG_DECORATIONS},
        {"biomes",      MG_BIOMES},
+       {"ores",        MG_ORES},
        {NULL,          0}
 };
 
@@ -81,15 +82,21 @@ struct MapgenDesc {
 //// Built-in mapgens
 ////
 
+// Order used here defines the order of appearence in mainmenu.
+// v6 always last to discourage selection.
+// Special mapgens flat, fractal, singlenode, next to last. Of these, singlenode
+// last to discourage selection.
+// Of the remaining, v5 last due to age, v7 first due to being the default.
+// The order of 'enum MapgenType' in mapgen.h must match this order.
 static MapgenDesc g_reg_mapgens[] = {
-       {"v5",         true},
-       {"v6",         true},
        {"v7",         true},
+       {"valleys",    true},
+       {"carpathian", true},
+       {"v5",         true},
        {"flat",       true},
        {"fractal",    true},
-       {"valleys",    true},
        {"singlenode", true},
-       {"carpathian", true},
+       {"v6",         true},
 };
 
 STATIC_ASSERT(
@@ -100,8 +107,8 @@ STATIC_ASSERT(
 //// Mapgen
 ////
 
-Mapgen::Mapgen(int mapgenid, MapgenParams *params, EmergeManager *emerge) :
-       gennotify(emerge->gen_notify_on, &emerge->gen_notify_on_deco_ids)
+Mapgen::Mapgen(int mapgenid, MapgenParams *params, EmergeParams *emerge) :
+       gennotify(emerge->gen_notify_on, emerge->gen_notify_on_deco_ids)
 {
        id           = mapgenid;
        water_level  = params->water_level;
@@ -150,7 +157,7 @@ const char *Mapgen::getMapgenName(MapgenType mgtype)
 
 
 Mapgen *Mapgen::createMapgen(MapgenType mgtype, MapgenParams *params,
-       EmergeManager *emerge)
+       EmergeParams *emerge)
 {
        switch (mgtype) {
        case MAPGEN_CARPATHIAN:
@@ -208,6 +215,17 @@ void Mapgen::getMapgenNames(std::vector<const char *> *mgnames, bool include_hid
        }
 }
 
+void Mapgen::setDefaultSettings(Settings *settings)
+{
+       settings->setDefault("mg_flags", flagdesc_mapgen,
+                MG_CAVES | MG_DUNGEONS | MG_LIGHT | MG_DECORATIONS | MG_BIOMES | MG_ORES);
+
+       for (int i = 0; i < (int)MAPGEN_INVALID; ++i) {
+               MapgenParams *params = createMapgenParams((MapgenType)i);
+               params->setDefaultSettings(settings);
+               delete params;
+       }
+}
 
 u32 Mapgen::getBlockSeed(v3s16 p, s32 seed)
 {
@@ -220,32 +238,13 @@ u32 Mapgen::getBlockSeed(v3s16 p, s32 seed)
 
 u32 Mapgen::getBlockSeed2(v3s16 p, s32 seed)
 {
-       u32 n = 1619 * p.X + 31337 * p.Y + 52591 * p.Z + 1013 * seed;
+       // Multiply by unsigned number to avoid signed overflow (UB)
+       u32 n = 1619U * p.X + 31337U * p.Y + 52591U * p.Z + 1013U * seed;
        n = (n >> 13) ^ n;
        return (n * (n * n * 60493 + 19990303) + 1376312589);
 }
 
 
-// Returns Y one under area minimum if not found
-s16 Mapgen::findGroundLevelFull(v2s16 p2d)
-{
-       const v3s16 &em = vm->m_area.getExtent();
-       s16 y_nodes_max = vm->m_area.MaxEdge.Y;
-       s16 y_nodes_min = vm->m_area.MinEdge.Y;
-       u32 i = vm->m_area.index(p2d.X, y_nodes_max, p2d.Y);
-       s16 y;
-
-       for (y = y_nodes_max; y >= y_nodes_min; y--) {
-               MapNode &n = vm->m_data[i];
-               if (ndef->get(n).walkable)
-                       break;
-
-               VoxelArea::add_y(em, i, -1);
-       }
-       return (y >= y_nodes_min) ? y : y_nodes_min - 1;
-}
-
-
 // Returns -MAX_MAP_GENERATION_LIMIT if not found
 s16 Mapgen::findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax)
 {
@@ -416,7 +415,7 @@ void Mapgen::updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nm
 
 void Mapgen::setLighting(u8 light, v3s16 nmin, v3s16 nmax)
 {
-       ScopeProfiler sp(g_profiler, "EmergeThread: mapgen lighting update", SPT_AVG);
+       ScopeProfiler sp(g_profiler, "EmergeThread: update lighting", SPT_AVG);
        VoxelArea a(nmin, nmax);
 
        for (int z = a.MinEdge.Z; z <= a.MaxEdge.Z; z++) {
@@ -429,7 +428,8 @@ void Mapgen::setLighting(u8 light, v3s16 nmin, v3s16 nmax)
 }
 
 
-void Mapgen::lightSpread(VoxelArea &a, v3s16 p, u8 light)
+void Mapgen::lightSpread(VoxelArea &a, std::queue<std::pair<v3s16, u8>> &queue,
+       const v3s16 &p, u8 light)
 {
        if (light <= 1 || !a.contains(p))
                return;
@@ -449,8 +449,8 @@ void Mapgen::lightSpread(VoxelArea &a, v3s16 p, u8 light)
        // Bail out only if we have no more light from either bank to propogate, or
        // we hit a solid block that light cannot pass through.
        if ((light_day  <= (n.param1 & 0x0F) &&
-               light_night <= (n.param1 & 0xF0)) ||
-               !ndef->get(n).light_propagates)
+                       light_night <= (n.param1 & 0xF0)) ||
+                       !ndef->get(n).light_propagates)
                return;
 
        // Since this recursive function only terminates when there is no light from
@@ -461,19 +461,15 @@ void Mapgen::lightSpread(VoxelArea &a, v3s16 p, u8 light)
 
        n.param1 = light;
 
-       lightSpread(a, p + v3s16(0, 0, 1), light);
-       lightSpread(a, p + v3s16(0, 1, 0), light);
-       lightSpread(a, p + v3s16(1, 0, 0), light);
-       lightSpread(a, p - v3s16(0, 0, 1), light);
-       lightSpread(a, p - v3s16(0, 1, 0), light);
-       lightSpread(a, p - v3s16(1, 0, 0), light);
+       // add to queue
+       queue.emplace(p, light);
 }
 
 
 void Mapgen::calcLighting(v3s16 nmin, v3s16 nmax, v3s16 full_nmin, v3s16 full_nmax,
        bool propagate_shadow)
 {
-       ScopeProfiler sp(g_profiler, "EmergeThread: mapgen lighting update", SPT_AVG);
+       ScopeProfiler sp(g_profiler, "EmergeThread: update lighting", SPT_AVG);
        //TimeTaker t("updateLighting");
 
        propagateSunlight(nmin, nmax, propagate_shadow);
@@ -519,9 +515,10 @@ void Mapgen::propagateSunlight(v3s16 nmin, v3s16 nmax, bool propagate_shadow)
 }
 
 
-void Mapgen::spreadLight(v3s16 nmin, v3s16 nmax)
+void Mapgen::spreadLight(const v3s16 &nmin, const v3s16 &nmax)
 {
        //TimeTaker t("spreadLight");
+       std::queue<std::pair<v3s16, u8>> queue;
        VoxelArea a(nmin, nmax);
 
        for (int z = a.MinEdge.Z; z <= a.MaxEdge.Z; z++) {
@@ -545,18 +542,24 @@ void Mapgen::spreadLight(v3s16 nmin, v3s16 nmax)
 
                                u8 light = n.param1;
                                if (light) {
-                                       lightSpread(a, v3s16(x,     y,     z + 1), light);
-                                       lightSpread(a, v3s16(x,     y + 1, z    ), light);
-                                       lightSpread(a, v3s16(x + 1, y,     z    ), light);
-                                       lightSpread(a, v3s16(x,     y,     z - 1), light);
-                                       lightSpread(a, v3s16(x,     y - 1, z    ), light);
-                                       lightSpread(a, v3s16(x - 1, y,     z    ), light);
+                                       const v3s16 p(x, y, z);
+                                       // spread to all 6 neighbor nodes
+                                       for (const auto &dir : g_6dirs)
+                                               lightSpread(a, queue, p + dir, light);
                                }
                        }
                }
        }
 
-       //printf("spreadLight: %dms\n", t.stop());
+       while (!queue.empty()) {
+               const auto &i = queue.front();
+               // spread to all 6 neighbor nodes
+               for (const auto &dir : g_6dirs)
+                       lightSpread(a, queue, i.first + dir, i.second);
+               queue.pop();
+       }
+
+       //printf("spreadLight: %lums\n", t.stop());
 }
 
 
@@ -564,7 +567,7 @@ void Mapgen::spreadLight(v3s16 nmin, v3s16 nmax)
 //// MapgenBasic
 ////
 
-MapgenBasic::MapgenBasic(int mapgenid, MapgenParams *params, EmergeManager *emerge)
+MapgenBasic::MapgenBasic(int mapgenid, MapgenParams *params, EmergeParams *emerge)
        : Mapgen(mapgenid, params, emerge)
 {
        this->m_emerge = emerge;
@@ -593,7 +596,8 @@ MapgenBasic::MapgenBasic(int mapgenid, MapgenParams *params, EmergeManager *emer
        this->heightmap = new s16[csize.X * csize.Z];
 
        //// Initialize biome generator
-       biomegen = m_bmgr->createBiomeGen(BIOMEGEN_ORIGINAL, params->bparams, csize);
+       biomegen = emerge->biomegen;
+       biomegen->assertChunkSize(csize);
        biomemap = biomegen->biomemap;
 
        //// Look up some commonly used content
@@ -607,13 +611,21 @@ MapgenBasic::MapgenBasic(int mapgenid, MapgenParams *params, EmergeManager *emer
        // Lava falls back to water as both are suitable as cave liquids.
        if (c_lava_source == CONTENT_IGNORE)
                c_lava_source = c_water_source;
+
+       if (c_stone == CONTENT_IGNORE)
+               errorstream << "Mapgen: Mapgen alias 'mapgen_stone' is invalid!" << std::endl;
+       if (c_water_source == CONTENT_IGNORE)
+               errorstream << "Mapgen: Mapgen alias 'mapgen_water_source' is invalid!" << std::endl;
+       if (c_river_water_source == CONTENT_IGNORE)
+               warningstream << "Mapgen: Mapgen alias 'mapgen_river_water_source' is invalid!" << std::endl;
 }
 
 
 MapgenBasic::~MapgenBasic()
 {
-       delete biomegen;
        delete []heightmap;
+
+       delete m_emerge; // destroying EmergeParams is our responsibility
 }
 
 
@@ -820,7 +832,9 @@ void MapgenBasic::dustTopNodes()
 
 void MapgenBasic::generateCavesNoiseIntersection(s16 max_stone_y)
 {
-       if (node_min.Y > max_stone_y)
+       // cave_width >= 10 is used to disable generation and avoid the intensive
+       // 3D noise calculations. Tunnels already have zero width when cave_width > 1.
+       if (node_min.Y > max_stone_y || cave_width >= 10.0f)
                return;
 
        CavesNoiseIntersection caves_noise(ndef, m_bmgr, csize,
@@ -830,20 +844,33 @@ void MapgenBasic::generateCavesNoiseIntersection(s16 max_stone_y)
 }
 
 
-void MapgenBasic::generateCavesRandomWalk(s16 max_stone_y, s16 large_cave_depth)
+void MapgenBasic::generateCavesRandomWalk(s16 max_stone_y, s16 large_cave_ymax)
 {
-       if (node_min.Y > max_stone_y || node_max.Y > large_cave_depth)
+       if (node_min.Y > max_stone_y)
                return;
 
        PseudoRandom ps(blockseed + 21343);
-       u32 bruises_count = ps.range(0, 2);
+       // Small randomwalk caves
+       u32 num_small_caves = ps.range(small_cave_num_min, small_cave_num_max);
 
-       for (u32 i = 0; i < bruises_count; i++) {
+       for (u32 i = 0; i < num_small_caves; i++) {
                CavesRandomWalk cave(ndef, &gennotify, seed, water_level,
-                       c_water_source, c_lava_source, lava_depth, biomegen);
+                       c_water_source, c_lava_source, large_cave_flooded, biomegen);
+               cave.makeCave(vm, node_min, node_max, &ps, false, max_stone_y, heightmap);
+       }
+
+       if (node_max.Y > large_cave_ymax)
+               return;
 
-               cave.makeCave(vm, node_min, node_max, &ps, true, max_stone_y,
-                       heightmap);
+       // Large randomwalk caves below 'large_cave_ymax'.
+       // 'large_cave_ymax' can differ from the 'large_cave_depth' mapgen parameter,
+       // it is set to world base to disable large caves in or near caverns.
+       u32 num_large_caves = ps.range(large_cave_num_min, large_cave_num_max);
+
+       for (u32 i = 0; i < num_large_caves; i++) {
+               CavesRandomWalk cave(ndef, &gennotify, seed, water_level,
+                       c_water_source, c_lava_source, large_cave_flooded, biomegen);
+               cave.makeCave(vm, node_min, node_max, &ps, true, max_stone_y, heightmap);
        }
 }
 
@@ -862,7 +889,8 @@ bool MapgenBasic::generateCavernsNoise(s16 max_stone_y)
 
 void MapgenBasic::generateDungeons(s16 max_stone_y)
 {
-       if (max_stone_y < node_min.Y)
+       if (node_min.Y > max_stone_y || node_min.Y > dungeon_ymax ||
+                       node_max.Y < dungeon_ymin)
                return;
 
        u16 num_dungeons = std::fmax(std::floor(
@@ -871,26 +899,28 @@ void MapgenBasic::generateDungeons(s16 max_stone_y)
                return;
 
        PseudoRandom ps(blockseed + 70033);
-       
+
        DungeonParams dp;
 
        dp.np_alt_wall =
                NoiseParams(-0.4, 1.0, v3f(40.0, 40.0, 40.0), 32474, 6, 1.1, 2.0);
 
        dp.seed                = seed;
-       dp.num_dungeons        = num_dungeons;
        dp.only_in_ground      = true;
+       dp.num_dungeons        = num_dungeons;
+       dp.notifytype          = GENNOTIFY_DUNGEON;
        dp.num_rooms           = ps.range(2, 16);
-       dp.room_size_min       = v3s16(6, 5, 6);
-       dp.room_size_max       = v3s16(10, 6, 10);
-       dp.room_size_large_min = v3s16(10, 8, 10);
-       dp.room_size_large_max = v3s16(18, 16, 18);
-       dp.large_room_chance   = (ps.range(1, 4) == 1) ? 1 : 0;
-       dp.holesize            = v3s16(2, 3, 2);
+       dp.room_size_min       = v3s16(5, 5, 5);
+       dp.room_size_max       = v3s16(12, 6, 12);
+       dp.room_size_large_min = v3s16(12, 6, 12);
+       dp.room_size_large_max = v3s16(16, 16, 16);
+       dp.large_room_chance   = (ps.range(1, 4) == 1) ? 8 : 0;
+       dp.diagonal_dirs       = ps.range(1, 8) == 1;
+       // Diagonal corridors must have 'hole' width >=2 to be passable
+       u8 holewidth           = (dp.diagonal_dirs) ? 2 : ps.range(1, 2);
+       dp.holesize            = v3s16(holewidth, 3, holewidth);
        dp.corridor_len_min    = 1;
        dp.corridor_len_max    = 13;
-       dp.diagonal_dirs       = ps.range(1, 12) == 1;
-       dp.notifytype          = GENNOTIFY_DUNGEON;
 
        // Get biome at mapchunk midpoint
        v3s16 chunk_mid = node_min + (node_max - node_min) / v3s16(2, 2, 2);
@@ -928,32 +958,20 @@ void MapgenBasic::generateDungeons(s16 max_stone_y)
 ////
 
 GenerateNotifier::GenerateNotifier(u32 notify_on,
-       std::set<u32> *notify_on_deco_ids)
+       const std::set<u32> *notify_on_deco_ids)
 {
        m_notify_on = notify_on;
        m_notify_on_deco_ids = notify_on_deco_ids;
 }
 
 
-void GenerateNotifier::setNotifyOn(u32 notify_on)
-{
-       m_notify_on = notify_on;
-}
-
-
-void GenerateNotifier::setNotifyOnDecoIds(std::set<u32> *notify_on_deco_ids)
-{
-       m_notify_on_deco_ids = notify_on_deco_ids;
-}
-
-
 bool GenerateNotifier::addEvent(GenNotifyType type, v3s16 pos, u32 id)
 {
        if (!(m_notify_on & (1 << type)))
                return false;
 
        if (type == GENNOTIFY_DECORATION &&
-               m_notify_on_deco_ids->find(id) == m_notify_on_deco_ids->end())
+               m_notify_on_deco_ids->find(id) == m_notify_on_deco_ids->cend())
                return false;
 
        GenNotifyEvent gne;
@@ -1001,10 +1019,11 @@ MapgenParams::~MapgenParams()
 
 void MapgenParams::readParams(const Settings *settings)
 {
-       std::string seed_str;
-       const char *seed_name = (settings == g_settings) ? "fixed_map_seed" : "seed";
+       // should always be used via MapSettingsManager
+       assert(settings != g_settings);
 
-       if (settings->getNoEx(seed_name, seed_str)) {
+       std::string seed_str;
+       if (settings->getNoEx("seed", seed_str)) {
                if (!seed_str.empty())
                        seed = read_seed(seed_str.c_str());
                else
@@ -1039,7 +1058,7 @@ void MapgenParams::writeParams(Settings *settings) const
        settings->setS16("water_level", water_level);
        settings->setS16("mapgen_limit", mapgen_limit);
        settings->setS16("chunksize", chunksize);
-       settings->setFlagStr("mg_flags", flags, flagdesc_mapgen, U32_MAX);
+       settings->setFlagStr("mg_flags", flags, flagdesc_mapgen);
 
        if (bparams)
                bparams->writeParams(settings);