Author: jstephens
Date: 2007-06-08 20:19:48 +0200 (Fri, 08 Jun 2007)
New Revision: 6732
Log:
New additions to Kernel Blocks section (Thanks, Jeb!)
Modified:
trunk/ndbapi/ndb-internals.xml
Modified: trunk/ndbapi/ndb-internals.xml
===================================================================
--- trunk/ndbapi/ndb-internals.xml 2007-06-08 17:45:33 UTC (rev 6731)
+++ trunk/ndbapi/ndb-internals.xml 2007-06-08 18:19:48 UTC (rev 6732)
Changed blocks: 3, Lines Added: 927, Lines Deleted: 889; 57045 bytes
@@ -8450,17 +8450,13 @@
<title><literal>NDB</literal> Kernel Blocks</title>
<para>
- This section lists and describes the major kernel blocks found in
- the <literal>NDB</literal> source code, under the directory
+ The following sections list and describe the major kernel blocks
+ found in the <literal>NDB</literal> source code. These are found
+ under the directory
<filename>storage/ndb/src/kernel/blocks/</filename>.
</para>
<remark role="note">
- [js] Using an itemizedlist for now, may want to promote list items
- to (sub)sections as more information is added?
- </remark>
-
- <remark role="note">
[js] I've omitted makefiles and SCCS subdirectories from the
kernel block file listings.
</remark>
@@ -8475,1122 +8471,1164 @@
the code in each one and what it does.
</remark>
- <itemizedlist>
+ <section id="ndb-internals-kernel-blocks-backup">
- <listitem>
- <formalpara>
+ <title>The <literal>BACKUP</literal> Block</title>
- <title><literal>BACKUP</literal></title>
+ <para>
+ This block is responsible for handling online backups and
+ checkpoints. It is found in
+ <filename>storage/ndb/src/kernel/blocks/backup/</filename>, and
+ contains the following files:
- <para>
- This block is responsible for handling online backups and
- checkpoints. It is found in
- <filename>storage/ndb/src/kernel/blocks/backup/</filename>,
- and contains the following files:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Backup.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Backup.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>BackupFormat.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>BackupFormat.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Backup.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Backup.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>BackupInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>BackupInit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Backup.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Backup.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>FsBuffer.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>FsBuffer.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>read.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>read.cpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- </itemizedlist>
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-cvvmi">
- <listitem>
- <formalpara>
+ <title>The <literal>CMVMI</literal> Block</title>
- <title><literal>CMVMI</literal></title>
+ <para>
+ This block is responsible for configuration management between
+ the kernel blocks and the <literal>NDB</literal> virtual
+ machine, as well as the cluster job que and cluster
+ transporters. It is found in
+ <filename>storage/ndb/src/kernel/blocks/cmvmi</filename>, and
+ contains these files:
- <para>
- This block is responsible for configuration management
- between the kernel blocks and the <literal>NDB</literal>
- virtual machine. It is found in
- <filename>storage/ndb/src/kernel/blocks/cmvmi</filename>,
- and contains these files:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Cmvmi.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Cmvmi.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Cmvmi.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Cmvmi.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- </itemizedlist>
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbacc">
- <listitem>
- <formalpara>
+ <title>The <literal>DBACC</literal> Block</title>
- <title><literal>DBACC</literal></title>
+ <para>
+ This is the access control and lock management module, found in
+ <filename>storage/ndb/src/kernel/blocks/dbacc</filename>. It
+ contains the following files:
- <para>
- This is the access control and lock management module, found
- in <filename>storage/ndb/src/kernel/blocks/dbacc</filename>.
- It contains the following files:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Dbacc.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbacc.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbaccInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbaccInit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbaccMain.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbaccMain.cpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- </itemizedlist>
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbdict">
- <listitem>
- <formalpara>
+ <title>The <literal>DBDICT</literal> Block</title>
- <title><literal>DBDICT</literal></title>
+ <para>
+ This block, the data dictionary block, is found in
+ <filename>storage/ndb/src/kernel/blocks/dbdict</filename>. It is
+ responsible for managing metadata via the cluster's master node
+ such as table and index definitions, as well as many Disk Data
+ operations. This block contains the following files:
- <para>
- This block, the data dictionary block, is found in
- <filename>storage/ndb/src/kernel/blocks/dbdict</filename>.
- It is responsible for managing metadata such as table and
- index definitions, as well as many Disk Data operations.
- This block contains the following files:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>CreateIndex.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>CreateIndex.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Dbdict.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbdict.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DictLock.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DictLock.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>printSchemaFile.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>printSchemaFile.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Slave_AddTable.sfl</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Slave_AddTable.sfl</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>CreateTable.new.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>CreateTable.new.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Dbdict.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbdict.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DropTable.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DropTable.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>CreateTable.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>CreateTable.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Dbdict.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbdict.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Event.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Event.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Master_AddTable.sfl</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Master_AddTable.sfl</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>SchemaFile.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>SchemaFile.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- </itemizedlist>
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbdih">
- <listitem>
- <formalpara>
+ <title>The <literal>DBDIH</literal> Block</title>
- <title><literal>DBLIH</literal></title>
+ <para>
+ This block provides data distribution (partitioning) management
+ services. It is responsible for maintaining data fragments and
+ replicas, handling of local and global checkpoints; it also
+ manages node and system restarts. It contains the following
+ files, all found in the directory
+ <filename>storage/ndb/src/kernel/blocks/dbdih</filename>:
- <para>
- This block provides data distribution management services.
- It is responsible for maintaining data fragments and
- replicas, handling of local and global checkpoints, and
- manages system restarts. It contains the following files,
- all found in the directory
- <filename>storage/ndb/src/kernel/blocks/dbdih</filename>:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Dbdih.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbdih.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbdihMain.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbdihMain.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>printSysfile/printSysfile.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>printSysfile/printSysfile.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbdihInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbdihInit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>LCP.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>LCP.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>printSysfile.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>printSysfile.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Sysfile.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Sysfile.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
- </itemizedlist>
+ This block often makes use of <literal>BACKUP</literal> blocks
+ on the data nodes to accomplish distributed tasks, such as
+ global checkpoints and system restarts.
+ </para>
- This block often makes use of <literal>BACKUP</literal>
- blocks on the data nodes to accomplish distributed tasks,
- such as global checkpoints and system restarts.
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dblqh">
- <listitem>
- <formalpara>
+ <title><literal>DBLQH</literal> Block</title>
- <title><literal>DBLQH</literal></title>
+ <para>
+ This is the local, low-level query handler block, which manages
+ data and transactions local to the cluster's data nodes. It is
+ made up of the following files, found in
+ <filename>storage/ndb/src/kernel/blocks/dblqh</filename>:
- <para>
- This is the local, low-level query handler block, which
- manages data and transactions local to the cluster's data
- nodes. It is made up of the following files, found in
- <filename>storage/ndb/src/kernel/blocks/dblqh</filename>:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Dblqh.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dblqh.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DblqhInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DblqhInit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DblqhMain.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DblqhMain.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>redoLogReader/records.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>redoLogReader/records.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>redoLogReader/records.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>redoLogReader/records.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>redoLogReader/redoLogFileReader.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>redoLogReader/redoLogFileReader.cpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
- </itemizedlist>
+ This block also handles redo logging, and helps oversee the
+ <literal>DBACC</literal>, <literal>DBTUP</literal>,
+ <literal>LGMAN</literal>, <literal>TSMAN</literal>,
+ <literal>PGMAN</literal>, and <literal>BACKUP</literal> blocks.
+ </para>
- This block also handles redo logging.
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbtc">
- <listitem>
- <formalpara>
+ <title>The <literal>DBTC</literal> Block</title>
- <title><literal>DBTC</literal></title>
+ <para>
+ This is the transaction coordinator block, which handles
+ distributed transactions and other data operations on a global
+ level (as opposed to <literal>DBLQH</literal> which deals with
+ such issues on individual data nodes). In the source code, it is
+ located in the directory
+ <filename>storage/ndb/src/kernel/blocks/dbtc</filename>, which
+ contains these files:
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <filename>Dbtc.hpp</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>DbtcInit.cpp</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>DbtcMain.cpp</filename>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <note>
<para>
- This is the transaction coordinator block, which handles
- distributed transactions and other data operations on a
- global level (as opposed to <literal>DBLQH</literal> which
- deals with such issues on individual data nodes). In the
- source code, it is located in the directory
- <filename>storage/ndb/src/kernel/blocks/dbtc</filename>,
- which contains these files:
+ Any data may act as the transaction coordinator.
+ </para>
+ </note>
+ </para>
- <itemizedlist>
+ <para>
+ This block also handles unique indexes, which must co-ordinated
+ across all data nodes simultaneously.
+ </para>
- <listitem>
- <para>
- <filename>Dbtc.hpp</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>DbtcInit.cpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbtup">
- <listitem>
- <para>
- <filename>DbtcMain.cpp</filename>
- </para>
- </listitem>
+ <title>The <literal>DBTUP</literal> Block</title>
- </itemizedlist>
+ <para>
+ This is the tuple manager, which manages the physical storage of
+ cluster data. It consists of the the following files found in
+ the directory
+ <filename>storage/ndb/src/kernel/blocks/dbtup</filename>:
- This block also handles unique indexes, which must
- co-ordinated across all data nodes simultaneously.
- </para>
+ <itemizedlist>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>AttributeOffset.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>DbtupDiskAlloc.cpp</filename>
+ </para>
+ </listitem>
- <title><literal>DBTUP</literal></title>
+ <listitem>
+ <para>
+ <filename>DbtupIndex.cpp</filename>
+ </para>
+ </listitem>
- <para>
- This is the tuple manager, which manages the physical
- storage of cluster data. It consists of the the following
- files found in the directory
- <filename>storage/ndb/src/kernel/blocks/dbtup</filename>:
+ <listitem>
+ <para>
+ <filename>DbtupScan.cpp</filename>
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>tuppage.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>AttributeOffset.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupAbort.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupDiskAlloc.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupExecQuery.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupIndex.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupMeta.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupScan.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupStoredProcDef.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>tuppage.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>tuppage.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupAbort.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupBuffer.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupExecQuery.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupFixAlloc.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupMeta.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupPageMap.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupStoredProcDef.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupTabDesMan.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>tuppage.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Notes.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupBuffer.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Undo_buffer.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupFixAlloc.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupCommit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupPageMap.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupGen.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupTabDesMan.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupPagMan.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Notes.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupTrigger.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Undo_buffer.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Undo_buffer.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupCommit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupDebug.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupGen.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Dbtup.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupPagMan.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupRoutines.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupTrigger.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtupVarAlloc.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Undo_buffer.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>test_varpage.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtupDebug.cpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
- <listitem>
- <para>
- <filename>Dbtup.hpp</filename>
- </para>
- </listitem>
+ This block also monitors changes in tuples.
+ </para>
- <listitem>
- <para>
- <filename>DbtupRoutines.cpp</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>DbtupVarAlloc.cpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbtux">
- <listitem>
- <para>
- <filename>test_varpage.cpp</filename>
- </para>
- </listitem>
+ <title><literal>DBTUX</literal> Block</title>
- </itemizedlist>
+ <para>
+ This kernel block handles the local management of ordered
+ indexes. It consists of the the following files found in the
+ <filename>storage/ndb/src/kernel/blocks/dbtux</filename>
+ directory:
- This block also monitors changes in tuples.
- </para>
+ <itemizedlist>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxCmp.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>DbtuxGen.cpp</filename>
+ </para>
+ </listitem>
- <title><literal>DBTUX</literal></title>
+ <listitem>
+ <para>
+ <filename>DbtuxMaint.cpp</filename>
+ </para>
+ </listitem>
- <para>
- This kernel block handles the local management of ordered
- indexes. It consists of the the following files found in the
- <filename>storage/ndb/src/kernel/blocks/dbtux</filename>
- directory:
+ <listitem>
+ <para>
+ <filename>DbtuxNode.cpp</filename>
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>DbtuxSearch.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxCmp.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxTree.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxGen.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Times.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxMaint.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxDebug.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxNode.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Dbtux.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxSearch.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxMeta.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxTree.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxScan.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Times.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbtuxStat.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>DbtuxDebug.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>tuxstatus.html</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Dbtux.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- <listitem>
- <para>
- <filename>DbtuxMeta.cpp</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>DbtuxScan.cpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-dbutil">
- <listitem>
- <para>
- <filename>DbtuxStat.cpp</filename>
- </para>
- </listitem>
+ <title>The <literal>DBUTIL</literal> Block</title>
- <listitem>
- <para>
- <filename>tuxstatus.html</filename>
- </para>
- </listitem>
+ <para>
+ This block provides internal interfaces to transaction and data
+ operations, performing essential operations on signals passed
+ between nodes. It is also used in building online indexes, and
+ is found in
+ <filename>storage/ndb/src/kernel/blocks/dbutil</filename>, which
+ includes these files:
- </itemizedlist>
- </para>
+ <itemizedlist>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>DbUtil.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>DbUtil.hpp</filename>
+ </para>
+ </listitem>
- <title><literal>DBUTIL</literal></title>
+ <listitem>
+ <para>
+ <filename>DbUtil.txt</filename>
+ </para>
+ </listitem>
- <para>
- This block provides internal interfaces to transaction and
- data operations. It is found in
- <filename>storage/ndb/src/kernel/blocks/dbutil</filename>,
- and includes these files:
+ </itemizedlist>
- <itemizedlist>
+ Among the duties performed by this block is the maintenance of
+ sequences for backup IDs and other distributed identifiers.
+ </para>
- <listitem>
- <para>
- <filename>DbUtil.cpp</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>DbUtil.hpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-lgman">
- <listitem>
- <para>
- <filename>DbUtil.txt</filename>
- </para>
- </listitem>
+ <title>The <literal>LGMAN</literal> Block</title>
- </itemizedlist>
+ <para>
+ This block is responsible for handling the undo logs for Disk
+ Data tables. It consists of these files in the
+ <filename>storage/ndb/src/kernel/blocks</filename> directory:
- Among the duties performed by this block is the maintenance
- of sequences for backup IDs and other distributed
- identifiers.
- </para>
+ <itemizedlist>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>lgman.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>lgman.hpp</filename>
+ </para>
+ </listitem>
- <title><literal>NDBCNTR</literal></title>
+ </itemizedlist>
+ </para>
- <para>
- This is a cluster management block that handles block
- initialisation and configuration. It is located in
- <filename>storage/ndb/src/kernel/blocks/ndbcntr</filename>,
- and contains these files:
+ </section>
- <itemizedlist>
+ <section id="ndb-internals-kernel-blocks-ndbcntr">
- <listitem>
- <para>
- <filename>Ndbcntr.hpp</filename>
- </para>
- </listitem>
+ <title><literal>NDBCNTR</literal> Block</title>
- <listitem>
- <para>
- <filename>NdbcntrInit.cpp</filename>
- </para>
- </listitem>
+ <para>
+ This is a cluster management block that handles block
+ initialisation and configuration. During the data node startup
+ process, it takes over from the <literal>QMGR</literal> block
+ and continues the process. It also assist with graceful
+ (planned) shutdowns of data nodes. Ths block is located in
+ <filename>storage/ndb/src/kernel/blocks/ndbcntr</filename>, and
+ contains these files:
- <listitem>
- <para>
- <filename>NdbcntrMain.cpp</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>NdbcntrSysTable.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Ndbcntr.hpp</filename>
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <filename>NdbcntrInit.cpp</filename>
+ </para>
+ </listitem>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>NdbcntrMain.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>NdbcntrSysTable.cpp</filename>
+ </para>
+ </listitem>
- <title><literal>NDBFS</literal></title>
+ </itemizedlist>
+ </para>
- <para>
- This block provides the <literal>NDB</literal> filesystem
- abstraction layer, and is located in the directory
- <filename>storage/ndb/src/kernel/blocks/ndbfs</filename>,
- which contains the following files:
+ </section>
- <itemizedlist>
+ <section id="ndb-internals-kernel-blocks-ndbfs">
- <listitem>
- <para>
- <filename>AsyncFile.cpp</filename>
- </para>
- </listitem>
+ <title>The <literal>NDBFS</literal> Block</title>
- <listitem>
- <para>
- <filename>CircularIndex.cpp</filename>
- </para>
- </listitem>
+ <para>
+ This block provides the <literal>NDB</literal> filesystem
+ abstraction layer, and is located in the directory
+ <filename>storage/ndb/src/kernel/blocks/ndbfs</filename>, which
+ contains the following files:
- <listitem>
- <para>
- <filename>Filename.hpp</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>MemoryChannelTest/MemoryChannelTest.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>AsyncFile.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>OpenFiles.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>CircularIndex.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>VoidFs.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Filename.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>AsyncFile.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>MemoryChannelTest/MemoryChannelTest.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>CircularIndex.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>OpenFiles.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>MemoryChannel.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>VoidFs.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Ndbfs.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>AsyncFile.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Pool.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>CircularIndex.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>AsyncFileTest/AsyncFileTest.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>MemoryChannel.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Filename.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Ndbfs.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>MemoryChannel.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Pool.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Ndbfs.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>AsyncFileTest/AsyncFileTest.cpp</filename>
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <filename>Filename.cpp</filename>
+ </para>
+ </listitem>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>MemoryChannel.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>Ndbfs.hpp</filename>
+ </para>
+ </listitem>
- <title><literal>QMGR</literal></title>
+ </itemizedlist>
+ </para>
- <para>
- This is the logical cluster management block, and handles
- node membership in the cluster via heartbeats. It contains
- the following files, found in
- <filename>storage/ndb/src/kernel/blocks/qmgr</filename>:
+ </section>
- <itemizedlist>
+ <section id="ndb-internals-kernel-blocks-pgman">
- <listitem>
- <para>
- <filename>Qmgr.hpp</filename>
- </para>
- </listitem>
+ <title>The <literal>PGMAN</literal> Block</title>
- <listitem>
- <para>
- <filename>QmgrInit.cpp</filename>
- </para>
- </listitem>
+ <para>
+ This block provides page and buffer management services for Disk
+ Data tables. It includes these files:
- <listitem>
- <para>
- <filename>QmgrMain.cpp</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>timer.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>diskpage.cpp</filename>
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <filename>diskpage.hpp</filename>
+ </para>
+ </listitem>
- </formalpara>
- </listitem>
+ <listitem>
+ <para>
+ <filename>pgman.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <formalpara>
+ <listitem>
+ <para>
+ <filename>pgman.hpp</filename>
+ </para>
+ </listitem>
- <title><literal>RESTORE</literal></title>
+ </itemizedlist>
+ </para>
- <para>
- This block consists of the files
- <filename>restore.cpp</filename> and
- <filename>restore.hpp</filename>, in the
- <filename>storage/ndb/src/kernel/blocks</filename>
- directory. It handles restoration of the cluster from online
- backups.
- </para>
+ </section>
- </formalpara>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-qmgr">
- <listitem>
- <formalpara>
+ <title>The <literal>QMGR</literal> Block</title>
- <title><literal>SUMA</literal></title>
+ <para>
+ This is the logical cluster management block, and handles node
+ membership in the cluster via heartbeats.
+ <literal>QMGR</literal> is responsible for polling the data
+ nodes when a data node failure occurs and determining that the
+ node has actually failed and should be dropped from the cluster.
+ This block contains the following files, found in
+ <filename>storage/ndb/src/kernel/blocks/qmgr</filename>:
- <para>
- The cluster subscription manager, which handles event
- logging and reporting functions. It consists of the
- following files, found in the directory
- <filename>storage/ndb/src/kernel/blocks/suma/</filename>:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>Qmgr.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Suma.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>QmgrInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Suma.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>QmgrMain.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>SumaInit.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>timer.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>Suma.txt</filename>
- </para>
- </listitem>
+ </itemizedlist>
- </itemizedlist>
- </para>
+ This block also assists in the early phases of data node
+ startup.
+ </para>
- </formalpara>
- </listitem>
+ </section>
- <listitem>
- <formalpara>
+ <section id="ndb-internals-kernel-blocks-restore">
- <title><literal>TRIX</literal></title>
+ <title>The <literal>RESTORE</literal> Block</title>
- <para>
- This kernel block is responsible for the building of unique
- indexes. It is found in the directory
- <filename>storage/ndb/src/kernel/blocks/trix</filename>, and
- includes these files:
+ <para>
+ This block consists of the files
+ <filename>restore.cpp</filename> and
+ <filename>restore.hpp</filename>, in the
+ <filename>storage/ndb/src/kernel/blocks</filename> directory. It
+ handles restoration of the cluster from online backups.
+ </para>
- <itemizedlist>
+ </section>
- <listitem>
- <para>
- <filename>Trix.cpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-suma">
- <listitem>
- <para>
- <filename>Trix.hpp</filename>
- </para>
- </listitem>
+ <title>The <literal>SUMA</literal> Block</title>
- </itemizedlist>
- </para>
+ <para>
+ The cluster subscription manager, which handles event logging
+ and reporting functions. It also figures prominently in MySQL
+ CLuster Replication. <literal>SUMA</literal> consists of the
+ following files, found in the directory
+ <filename>storage/ndb/src/kernel/blocks/suma/</filename>:
- </formalpara>
- </listitem>
+ <itemizedlist>
- </itemizedlist>
+ <listitem>
+ <para>
+ <filename>Suma.cpp</filename>
+ </para>
+ </listitem>
- <para>
- In addition, the following files are found in the
- <filename>storage/ndb/src/kernel/blocks</filename> directory:
+ <listitem>
+ <para>
+ <filename>Suma.hpp</filename>
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <filename>SumaInit.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>diskpage.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Suma.txt</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>pgman.cpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- <listitem>
- <para>
- <filename>SystemRestart.new.txt</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>diskpage.hpp</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-tsman">
- <listitem>
- <para>
- <filename>pgman.hpp</filename>
- </para>
- </listitem>
+ <title>The <literal>TSMAN</literal> Block</title>
- <listitem>
- <para>
- <filename>SystemRestart.txt</filename>
- </para>
- </listitem>
+ <para>
+ This is the tablespace manager block for Disk Data tables, and
+ includes the following files from
+ <filename>storage/ndb/src/kernel/blocks</filename>:
- <listitem>
- <para>
- <filename>ERROR_codes.txt</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>NodeRestart.new.txt</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>tsman.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>print_file.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>tsman.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>mutexes.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- <listitem>
- <para>
- <filename>NodeRestart.txt</filename>
- </para>
- </listitem>
+ </section>
- <listitem>
- <para>
- <filename>Start.txt</filename>
- </para>
- </listitem>
+ <section id="ndb-internals-kernel-blocks-trix">
- <listitem>
- <para>
- <filename>lgman.cpp</filename>
- </para>
- </listitem>
+ <title>The <literal>TRIX</literal> Block</title>
- <listitem>
- <para>
- <filename>lgman.hpp</filename>
- </para>
- </listitem>
+ <para>
+ This kernel block is responsible for the building of unique
+ indexes. This block, like <literal>DBUTIL</literal>, is a
+ utility block containing many helper functions for building
+ indexes and handling signlas betweens nodes. It is found in the
+ directory
+ <filename>storage/ndb/src/kernel/blocks/trix</filename>, and
+ includes these files:
- <listitem>
- <para>
- <filename>OptNR.txt</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>record_types.hpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Trix.cpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>tsman.cpp</filename>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <filename>Trix.hpp</filename>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <filename>tsman.hpp</filename>
- </para>
- </listitem>
+ </itemizedlist>
+ </para>
- </itemizedlist>
- </para>
+ </section>
+ <section id="ndb-internals-kernel-blocks-misc">
+
+ <title>Miscellaneous</title>
+
+ <para>
+ In addition, the following files are found in the
+ <filename>storage/ndb/src/kernel/blocks</filename> directory:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <filename>SystemRestart.new.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>SystemRestart.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>ERROR_codes.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>NodeRestart.new.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>print_file.cpp</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>mutexes.hpp</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>NodeRestart.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>Start.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>OptNR.txt</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <filename>record_types.hpp</filename>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </section>
+
</section>
<section id="ndb-internals-glossary">
@@ -9632,7 +9670,7 @@
</para>
<para>
- <emphasis role="bold">DI</emphasis>stribution
+ <emphasis role="bold">DI</emphasis>stribution
<emphasis role="bold">H</emphasis>andler.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r6732 - trunk/ndbapi | jon | 8 Jun |
