Cleanup: Store BLF Glyph cache with C++ Vector, use std::mutex #118222

Merged
Hans Goudey merged 2 commits from HooglyBoogly/blender:cleanup-glyph-cache-vector into main 2024-02-19 03:34:44 +01:00
Member
  • Store glyph cache entries as unique pointers in a vector
  • Use std::mutex instead of ThreadMutex
- Store glyph cache entries as unique pointers in a vector - Use std::mutex instead of `ThreadMutex`
Hans Goudey added 1 commit 2024-02-13 21:43:56 +01:00
buildbot/vexp-code-patch-lint Build done. Details
buildbot/vexp-code-patch-linux-x86_64 Build done. Details
buildbot/vexp-code-patch-darwin-x86_64 Build done. Details
buildbot/vexp-code-patch-windows-amd64 Build done. Details
buildbot/vexp-code-patch-coordinator Build done. Details
fab9e279e8
Cleanup: Store BLF Glyph cache with C++ Vector, use std::mutex
Hans Goudey requested review from Harley Acheson 2024-02-16 19:01:46 +01:00
Hans Goudey added this to the User Interface project 2024-02-16 19:01:50 +01:00
Author
Member

@blender-bot build

@blender-bot build
Member

@HooglyBoogly

Sorry for the delay in looking at this in detail.

This works great. And I can see the point of it being much simpler than mine. At the time I liked the idea of making it more object-y, but in hindsight it was a bit weird to make a new object just to manage the cache. This is a lot easier to follow.

Love that use of std::lock_guard - that is pretty cool.

One change, that I could just do afterward, is that blf_glyph_cache_find doesn't need that size argument as it is only ever called with font->size anyway. I should have changed that years ago.

I realize that a large part of this PR is as a teaching moment for me, to show a simpler alternative to mine, and to show me what we consider best practices. Of your changes everything makes perfect sense, except for the uses of unique_ptr so this is definitely something I have to learn more about.

A very obvious next step here seems to be replacement of GlyphCacheBLF->bucket, which is an array of 257 ListBases that act as a hash table. I did try replacing this with what I think is an obvious choice, std::unordered_map. This seemed to work okay when I just had it storing pointers to GlyphBLF, but I had no luck when I tried storing unique_ptr to them instead. Perhaps I could try again after this PR goes in and you could assist if I run into trouble again?

@HooglyBoogly Sorry for the delay in looking at this in detail. This works great. And I can see the point of it being much simpler than mine. At the time I liked the idea of making it more object-y, but in hindsight it was a bit weird to make a new object just to manage the cache. This is a lot easier to follow. Love that use of std::lock_guard - that is pretty cool. One change, that I could just do afterward, is that `blf_glyph_cache_find` doesn't need that `size` argument as it is only ever called with font->size anyway. I should have changed that years ago. I realize that a large part of this PR is as a teaching moment for me, to show a simpler alternative to mine, and to show me what we consider best practices. Of your changes everything makes perfect sense, except for the uses of `unique_ptr` so this is definitely something I have to learn more about. A very obvious next step here seems to be replacement of GlyphCacheBLF->bucket, which is an array of 257 ListBases that act as a hash table. I did try replacing this with what I think is an obvious choice, std::unordered_map. This seemed to work okay when I just had it storing pointers to GlyphBLF, but I had no luck when I tried storing `unique_ptr` to them instead. Perhaps I could try again after this PR goes in and you could assist if I run into trouble again?
Harley Acheson approved these changes 2024-02-18 03:31:06 +01:00
Hans Goudey added 1 commit 2024-02-19 02:17:02 +01:00
buildbot/vexp-code-patch-lint Build done. Details
buildbot/vexp-code-patch-linux-x86_64 Build done. Details
buildbot/vexp-code-patch-darwin-x86_64 Build done. Details
buildbot/vexp-code-patch-windows-amd64 Build done. Details
buildbot/vexp-code-patch-darwin-arm64 Build done. Details
buildbot/vexp-code-patch-coordinator Build done. Details
4fee33d770
Merge branch 'main' into cleanup-glyph-cache-vector
Author
Member

@blender-bot build

@blender-bot build
Author
Member

Thanks for checking it out.

Of your changes everything makes perfect sense, except for the uses of unique_ptr so this is definitely something I have to learn more about.

Let me know if you have any questions. Basically it's just nice that when we use this we don't have to worry about memory leaks or manually freeing things.

A very obvious next step here seems to be replacement of GlyphCacheBLF->bucket, which is an array of 257 ListBases that act as a hash table. I did try replacing this with what I think is an obvious choice, std::unordered_map

Yeah, I'd be happy to help with that. Indeed, that could be so much nicer. We do have Map as a better (faster) option than std::unordered_map BTW.

Thanks for checking it out. > Of your changes everything makes perfect sense, except for the uses of unique_ptr so this is definitely something I have to learn more about. Let me know if you have any questions. Basically it's just nice that when we use this we don't have to worry about memory leaks or manually freeing things. >A very obvious next step here seems to be replacement of GlyphCacheBLF->bucket, which is an array of 257 ListBases that act as a hash table. I did try replacing this with what I think is an obvious choice, std::unordered_map Yeah, I'd be happy to help with that. Indeed, that could be so much nicer. We do have `Map` as a better (faster) option than `std::unordered_map` BTW.
Hans Goudey merged commit fb8f9deaab into main 2024-02-19 03:34:44 +01:00
Hans Goudey deleted branch cleanup-glyph-cache-vector 2024-02-19 03:34:47 +01:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#118222
No description provided.