linux-xfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] xfsdocs: clarify log item header structure
@ 2017-11-29  1:48 Darrick J. Wong
  0 siblings, 0 replies; only message in thread
From: Darrick J. Wong @ 2017-11-29  1:48 UTC (permalink / raw)
  To: xfs

From: Darrick J. Wong <darrick.wong@oracle.com>

Make it more explicit that each log item has to start with a type code
and size, except for transaction headers.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
---
 .../journaling_log.asciidoc                        |   12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/design/XFS_Filesystem_Structure/journaling_log.asciidoc b/design/XFS_Filesystem_Structure/journaling_log.asciidoc
index 0aec036..6109458 100644
--- a/design/XFS_Filesystem_Structure/journaling_log.asciidoc
+++ b/design/XFS_Filesystem_Structure/journaling_log.asciidoc
@@ -217,6 +217,18 @@ magic number to distinguish themselves.  Buffer data items only appear after
 | +XFS_LI_BUD+			| 0x1245        | xref:BUD_Log_Item[File Block Mapping Update Done]
 |=====
 
+Note that all log items (except for transaction headers) MUST start with
+the following header structure.  The type and size fields are baked into
+each log item header, but there is not a separately defined header.
+
+[source, c]
+----
+struct xfs_log_item {
+     __uint16_t                magic;
+     __uint16_t                size;
+};
+----
+
 [[Log_Transaction_Headers]]
 === Transaction Headers
 

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2017-11-29  1:48 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-11-29  1:48 [PATCH] xfsdocs: clarify log item header structure Darrick J. Wong

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).