View source for Common Log File System

{{Short description|Component of the Windows operating system}}
'''Common Log File System''' ('''CLFS''') is a general-purpose logging subsystem that is accessible to both [[kernel-mode]] as well as [[user-mode]] applications for building high-performance [[transaction (database)|transaction]] logs. It was introduced with [[Windows Server 2003]] R2 and included in later [[Microsoft Windows|Windows]] operating systems. CLFS can be used for both [[Computer data logging|data logging]] as well as for [[event logging]]. CLFS is used by [[TxF]] and [[TxR]] to store transactional state changes before they commit a transaction. Binary Log File(s) created from CLFS can not be viewed by any integrated Windows tool.

==Overview==
The job of CLFS, like any other transactional logging system, is to record a series of steps required for some action so that they can be either played back accurately in the future to commit the transaction to secondary storage or undone if required. CLFS first [[Marshalling (computer science)|marshals]] logs records to in-memory buffers and then writes them to log-files on [[secondary storage]] (''stable media'' in CLFS terminology) for permanent persistence. When the data will be flushed to stable media is controlled by built-in policies, but a CLFS client application can override that and force a flush. CLFS allows for customizable log formats, expansion and truncation of logs according to defined policies, as well as simultaneous use by multiple client applications. CLFS is able to store log files anywhere on the file system.<ref name="clfs">{{cite web | url = https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/introduction-to-the-common-log-file-system | title = Introduction to the Common Log File System | publisher = [[MSDN]] | access-date = 2018-01-08}}</ref>

CLFS defines a [[device driver]] [[interface (computing)|interface]] (DDI), via which physical storage system specific drivers plug into the CLFS API. The CLFS driver implements the [[Algorithms for Recovery and Isolation Exploiting Semantics|ARIES]] recovery algorithm; other algorithms can be supported by using custom drivers.<ref name="clfs"/>

CLFS supports both dedicated logs, as well as multiplexed logs. A dedicated log contains a single stream of log records whereas multiplexed log contain multiple streams, each stream for a different application. Even though a multiplexed log has multiple streams, logs are flushed to the streams sequentially, in a single batch. CLFS can allocate space for a set of log records ahead-of-time (before the logs are actually generated) to make sure the operation does not fail due to lack of storage space.<ref name="clfs"/>

A log record in a CLFS stream is first placed to ''Log I/O Block'' in a buffer in system memory. Periodically blocks are flushed to stable storage devices. On the storage device, a log contains a set of ''Containers'', which are allocated contiguously, each containing multiple Log I/O Blocks. New log records are appended to the present set. Each record is identified by a ''Log Sequence Number'' (LSN), an increasing 32-bit sequence number. The LSN and other metadata are stored in the record header. The LSN encodes the identifier of the container, the offset to the record and the identifier of the record - this information is used to access the log record subsequently. However, the container identifiers are logical identifiers, they must be mapped to physical containers. The mapping is done by CLFS itself.<ref name="stable">{{cite web | url = https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/clfs-stable-storage | title = CLFS Stable Storage | publisher = [[MSDN]] | access-date = 2018-01-08}}</ref>

==References==
{{reflist}}

==External links==
*[http://msdn2.microsoft.com/en-us/library/bb986747.aspx Common Log File System (Windows SDK)]
*[https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/using-common-log-file-system Common Log File System (Windows Driver Kit)]
*[http://www.devx.com/VistaSpecialReport/Article/33848/1954?pf=true Fast and Flexible Logging with Vista's Common Log File System]

{{Windows Components}}
{{Microsoft APIs}}

[[Category:Microsoft application programming interfaces]]
[[Category:Windows components]]
[[Category:Log file formats]]