Data Handles

	Data Structures	Source Location
	WT_DHANDLE	src/include/dhandle.h src/conn/conn_dhandle.c src/session/session_dhandle.c

Caution: the Architecture Guide is not updated in lockstep with the code base and is not necessarily correct or complete for any specific release.

The data handle (dhandle) (WT_DATA_HANDLE) is a generic representation of any named data source. Dhandles are required to access any data source in the system. For the dhandle of B-Tree type, the void *handle field can be used like so (WT_BTREE *)dhandle->handle to get the B-Tree. For other data sources such as the table, LSM or tiered storage types, a type cast can be used on the dhandle itself to gain access to the structure for the data source. The dhandle structure also contains a set of flags, some reference counts, and individual data source statistics.

Data Handle Lifecycle

Dhandles are owned by the connection and shared among sessions. WiredTiger maintains all dhandles in a global dhandle list accessed from the connection. Multiple sessions access this list, which is protected by a R/W lock. Each session also maintains a session dhandle cache which is a cache of dhandles a session has operated upon. The entries in the cache are references into the global dhandle list.

Data Handle Creation

Generally, dhandles are created when accessing tables and other data sources that have not been accessed before. When a cursor in a session is opened on a WiredTiger table, it first attempts to find the dhandle in the session dhandle cache. If the dhandle is not found in the session dhandle cache, it searches the global dhandle list while holding the read lock. In the case that it doesn't find the dhandle there, it creates a dhandle for this table and puts it in the global dhandle list while holding the write lock on the global dhandle list. Finally, the cursor operation puts a reference to the dhandle in the session's dhandle cache.

Data Handle Reference Counts

There are two relevant reference counters in the dhandle structure, references and session_inuse. references counts the number of session dhandle cache lists that contain this dhandle. session_inuse is a count of the number of cursors opened and operating on this dhandle. Both these counters are incremented by the session as the cursor is opened on this dhandle. session_inuse is decremented when the operation completes and the cursor is closed.

Sweep-Server Dhandle Sweep

WiredTiger maintains a sweep server in the background for the cleanup of the global dhandle list. As dictated by the close_scan_interval variable, the sweep server periodically revisits the dhandles in the global list and if a dhandle is no longer being used (signified by the session_inuse count going to 0), it assigns the current time as the time of death if not already done before.

Dhandles are not immediately closed when the time of death field is set. The sweep server will keep the dhandle there for a configured amount of idle time (close_idle_time), and will only close the associated data source if it remained idle for that amount of time since time of death. The closure of the dhandle often occurs on the next iteration of the sweep when the sweep server detects the dhandle has remained idle for long enough. The server marks the dhandle as dead so that the next time a session with a reference walks its own cache list, it will see the handle marked dead and remove it from the session's dhandle cache list.

The sweep server then checks for any sessions that are referencing this dhandle. If a dhandle stays referenced by at least one session (references count > 0), the dhandle cannot be removed from the global list. If the dhandle is not referenced by any session, the sweep server removes the dhandle from the global dhandle list and frees any remaining resources associated with it. The removal of the dhandle from the global list completes the lifecycle, and any future access of the associated table will require the dhandle to be created again.

Dhandle Session Cache Sweep

A session's dhandle cache list is periodically cleaned out through a dhandle cache sweep, which removes references to the dhandles that have not been accessed by the session in a long time. Sessions have their own sweeps; since a session is single-threaded, a session's dhandle cache can only be altered by that session alone.

Each time a session accesses a dhandle, it checks if enough time has elapsed to do a session cache sweep for that session. As it walks the session dhandle cache list, it notices if any dhandle on its list has been marked dead (idle for too long). If it has, the session removes that dhandle from its list and decrements the references count.