[PATCH] D117444: [NFC] [docs] BitCodeFormat: fill in FUNCTION and USELIST blocks

[William Woodruff via Phabricator via llvm-commits]

woodruffw created this revision.
woodruffw added a project: LLVM.
woodruffw requested review of this revision.
Herald added a subscriber: llvm-commits.

This fills in a small amount of missing detail in the current bitcode format docs:

- The `FUNCTION_BLOCK` section is updated to add references to other sub-blocks that can be present
- The `USELIST_BLOCK` section was added, with stub sub-sections for each record code


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D117444

Files:
  llvm/docs/BitCodeFormat.rst


Index: llvm/docs/BitCodeFormat.rst
===================================================================
--- llvm/docs/BitCodeFormat.rst
+++ llvm/docs/BitCodeFormat.rst
@@ -1355,6 +1355,8 @@
 * `CONSTANTS_BLOCK`_
 * `VALUE_SYMTAB_BLOCK`_
 * `METADATA_ATTACHMENT`_
+* `METADATA_BLOCK`_
+* `USELIST_BLOCK`_
 
 .. _VALUE_SYMTAB_BLOCK:
 
@@ -1393,3 +1395,29 @@
 not succeeded by another intervening ``STRTAB`` block. Normally a bitcode
 file will have a single string table, but it may have more than one if it
 was created by binary concatenation of multiple bitcode files.
+
+.. _USELIST_BLOCK:
+
+USELIST_BLOCK Contents
+----------------------
+
+The ``USELIST_BLOCK`` block (id 18) contains records mapping LLVM values to
+their users.
+
+.. _USELIST_CODE_DEFAULT:
+
+USELIST_CODE_DEFAULT
+^^^^^^^^^^^^^^^^^^^^
+
+``[DEFAULT, index..., value-id]``
+
+The ``DEFAULT`` record (code 1) ...
+
+.. _USELIST_CODE_BB:
+
+USELIST_CODE_BB
+^^^^^^^^^^^^^^^
+
+``[BB, index..., bb-id]``
+
+The ``BB`` record (code 2) ...


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D117444.400409.patch
Type: text/x-patch
Size: 1008 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220117/702fbea8/attachment.bin>