{"id":21,"date":"2014-07-26T20:46:02","date_gmt":"2014-07-26T20:46:02","guid":{"rendered":"http:\/\/www.jacobpike.com\/blog\/?p=21"},"modified":"2014-07-26T20:51:57","modified_gmt":"2014-07-26T20:51:57","slug":"fixing-memory-usage-issue-for-noahs-ark","status":"publish","type":"post","link":"http:\/\/www.jacobpike.com\/blog\/2014\/07\/26\/fixing-memory-usage-issue-for-noahs-ark\/","title":{"rendered":"Fixing Memory Usage Issue for Noah’s Ark"},"content":{"rendered":"

I recently ran into a memory usage defect for my Noah’s Ark game<\/a>. Basically, as the player scrolled to different tile maps in the overworld, memory usage would continue to climb, eventually bringing the game to a crawl. The fix was really simple but involved some more subtleties of C++ smart pointers, so it seemed worth writing about.<\/p>\n

Graphics Management<\/strong>
\nFirst, it is important to understand how graphics are currently managed in the game code. Different types of graphics components<\/a> are created from the GraphicsSystem<\/a><\/code>. The GraphicsSystem<\/code> is then responsible for rendering all of the graphics on screen.<\/p>\n

I’m not necessarily sure this is the “best design” for the game (if you have other ideas, feel free to suggest them!). It is just something I’m experimenting with from various things I’ve read (mostly on entity component systems or ways to avoid having all of my game objects have explicit render methods). My main goal was to be able to easily apply global settings to all of the rendered graphics without having to touch a bunch of classes. Time will tell how well this works out.<\/p>\n

Map Scrolling<\/strong>
\nThe second major piece of the puzzle is to understand how the game scrolls between individual tile maps in the overworld. At any given time, the OverworldMap<\/a><\/code> holds the current, top, bottom, left, and right TileMaps<\/a><\/code> (assuming they exist):<\/p>\n

\"The<\/p>\n

When the player reaches the edge of the current map, the game scrolls to the appropriate adjacent map (if one exists), and then reloads any new maps surrounding this new map being scrolled to.<\/p>\n

The Bug<\/strong>
\nThere is a bit of a problem with the above approach, if you look at the details of the specific data types used. The graphics components created by the GraphicsSystem<\/code> are returned as shared_ptrs<\/a><\/code> and were (before the fix) also being stored as shared_ptrs<\/code> in the GraphicsSystem<\/code> class. These shared_ptrs<\/code> are then used by whatever objects the graphics are for. In this case, these shared_ptrs<\/code> were also used by Tiles<\/a><\/code> in the TileMap<\/code> class.<\/p>\n

When scrolling to new TileMaps<\/code>, the old TileMaps<\/code> would be destructed, decrementing the reference counts for the shared_ptrs<\/code> for Tiles<\/code> in the map. However, since the GraphicsSystem<\/code> still stored these shared_ptrs<\/code> for the tile graphics, the reference count would still be 1, so the tile graphics would persist in memory. New maps would be loaded, creating new tile graphics components, but all of the old tiles would still exist. Obviously, this is problematic and leads to increasing memory usage over time, which ended up slowing the game to a crawl.<\/p>\n

The Solution<\/strong>
\nI actually was aware of this problem during original implementation of the design outlined above but forgot about it by the time the defect actually manifested itself. This was a pretty major architecture problem, but I didn’t want to abandon the idea of having a centralized place (away from the main game objects) to control rendering.<\/p>\n

I couldn’t use unique_ptrs<\/a><\/code> since the graphics components needed to be accessible by both the GraphicsSystem<\/code> and the individual objects the graphics are for. There are ways around this, such as using raw pointers, but that would make communicating when the resources were to be deleted from the GraphicsSystem<\/code> pretty ugly (I also don’t like the lack of clarity that raw pointers can present when reading code, but that is for another blog post).<\/p>\n

Fortunately, C++ had an elegant solution. Enter the weak_ptr<\/a><\/code>. The description on the linked page is best to read for an understanding (and examples help), but a weak_ptr<\/code> allowed me to break the > 0 reference count problem described above in a pretty nice way.<\/p>\n

When an object like a Tile<\/code> (part of a TileMap<\/code>) is destructed, I wanted it to communicate to the GraphicsSystem<\/code> that the graphics for the Tile<\/code> could be deleted. To accomplish this, I made the following changes:<\/p>\n

The GraphicsSystem<\/code> was changed to store its graphics components as weak_ptrs<\/code> instead of shared_ptrs<\/code>:<\/p>\n

std::list< std::weak_ptr<IGraphicsComponent> > m_graphicsComponents;<\/code><\/p>\n

One nice thing is that the weak_ptr<\/code> class has a constructor that allows it to be constructed from a shared_ptr<\/code>, meaning I didn’t have to touch the code that added items to the above container.<\/p>\n

Next, I had to update the for<\/code> loops that iterated over the graphics components to use weak_ptrs<\/code> instead of shared_ptrs<\/code>. Before updating\/rendering an individual graphics component, I needed to check if the object had already been deleted elsewhere (i.e. the Tile<\/code> destructor) using the expired<\/a><\/code> method:<\/p>\n

if (!graphicsComponentWeakReference.expired())<\/code><\/p>\n

(See the Wikipedia page for an overview of the concept of weak references<\/a>.)<\/p>\n

Assuming that the weak_ptr<\/code> hasn’t expired, then the lock<\/a><\/code> method can be called to obtain a usable shared_ptr<\/code> to the object:<\/p>\n

std::shared_ptr<IGraphicsComponent> graphicsComponent = graphicsComponentWeakReference.lock();<\/code><\/p>\n

Tada! We’re almost done. The above code allows for checking if a graphics component has been deleted elsewhere, but it doesn’t actually solve the problem of increasing memory usage. The weak_ptrs<\/code> are still stored in the list, so they need to be removed at some point. Fortunately, the list<\/code> container has a remove_if<\/a><\/code> that allows us to easily remove elements from the container that meet a certain condition (without resorting to the erase-remove idiom<\/a>). Removing\u00a0the expired graphics components can be done in what is effectively a single line of code:<\/p>\n

m_graphicsComponents.remove_if([](std::weak_ptr<IGraphicsComponent>& graphicsComponent) { return graphicsComponent.expired(); });<\/code><\/p>\n

That’s it! You can browse the full set of changes for this fix here<\/a>. Finding and fixing this bug was a good learning experience for me, so hopefully it will be of use to some of you.<\/p>\n","protected":false},"excerpt":{"rendered":"

I recently ran into a memory usage defect for my Noah’s Ark game. Basically, as the player scrolled to different tile maps in the overworld, memory usage would continue to climb, eventually bringing the game to a crawl. The fix was really simple but involved some more subtleties of C++ smart pointers, so it seemed … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[10,8,11],"class_list":["post-21","post","type-post","status-publish","format-standard","hentry","category-noahs-ark-game","tag-memory","tag-noahs-ark","tag-pointers"],"_links":{"self":[{"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/posts\/21","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/comments?post=21"}],"version-history":[{"count":2,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/posts\/21\/revisions"}],"predecessor-version":[{"id":24,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/posts\/21\/revisions\/24"}],"wp:attachment":[{"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/media?parent=21"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/categories?post=21"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.jacobpike.com\/blog\/wp-json\/wp\/v2\/tags?post=21"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}