motr-design-doc-list.rst

Motr - Design Document List

No.	Ref file from Motr Source Code	Line No	PDF File Link	Github Link	Google Drive Link	Corresponding Sharepoint link
1	capa/capa.h	48	HLD of Capability in Motr	HLD_Capability_Motr.rst	HLD of capability in Motr	HLD of capability in Motr
2	cas/service.c	274	HLD of Catalogue Service	HLD_of_Catalogue_Service.rst	HLD of catalogue service	HLD of catalogue service
3	cm/cm.c	420			Copy Machine redesign.	TBD : Link is broken
			HLD of SNS Repair		HLD of copy machine and agents	HLD of SNS Repair
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of SNS Repair	HLD of SNS Repair
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of SNS Repair	HLD of SNS Repair
4	cm/cp.c	377	HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of Copy machine and agents	HLD of SNS Repair
5	conf/confd.h	101	HLD of Configuration Schema	HLD_Configuration_Schema.rst	HLD of Motr’s configuration database schema	HLD of Motr’s configuration database schema
			HLD of Configuration Caching	HLD_of_Motr_Caching.rst	HLD of configuration caching	HLD of configuration caching
			HLD of Configuration Schema	HLD_Configuration_Schema.rst	HLD of configuration.schema	HLD of configuration.schema
6	conf/obj.c	298			Configuration one-pager	Configuration one-pager
7	conf/objs/pool.c	155	Pools in Configuration Schema	Pools_in_configuration_schema.rst	Pools in Configuration Schema	Pools in Configuration Schema
8	conf/schema.h	65	HLD of Configuration Schema	HLD_Configuration_Schema.rst	HLD of configuration schema	HLD of configuration schema
9	dix/client.h	153	HLD of Distributed Indexing	HLD_of_Distributed_Indexing.rst	HLD of the distributed indexing	HLD of the distributed indexing
10	dix/cm/cm.c	292			Copy Machine redesign	TBD : Link is broken
					HLD of copy machine and agents	TBD : Link is broken
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of SNS Repair	HLD of SNS Repair
11	doc/dld/dld-index.c	57			Google Drive Motr Design Folder	TBD : Link is broken
12	doc/dld/dld-template.c	523			Detailed level design HOWTO	TBD : Link is broken
13	doc/reading-list.md	4	Reading List	reading-list.md	Motr Reading List	Motr Reading List
		5	Data Organization	Data_Organization.rst	Motr data organization	Motr data organization
		6	Motr Architectural 2 Pager	Motr_Architectural_2.rst	Motr architecture 2-pager	Motr architecture 2-pager
		7			Summary of M0 architecture	TBD : Link is broken
		11	Motr Architecture	CORTX_MOTR_ARCHITECTURE.rst	M0 Architecture Documentation	M0 Architecture Documentation
		12	FAQs		FAQ	FAQ
		13	Glossary		Glossary	Glossary
		18	Containers Overview	Containers.rst	containers 1-pager	containers 1-pager
		23	DTM Overview	DTM.rst	1-pager	1-pager
		24		HLD_Resource_Management_Interface.rst	High level design of resource management interfaces	High level design of resource management interfaces
		29		DTM.rst	DTM [1-pager]	TBD : Link is broken
		30	DTM Overview	DTM.rst	overview	Overview
		31	HLD of Version Numbers	HLD_Version_Numbers.rst	High level design of version numbers	High level design of version numbers
		47	Paxos	Paxos.rst	Paxos overview	Paxos overview
		52	Request Handler	Request_Handler.rst	request handler 1-pager	request handler 1-pager
		53	HLD of FOP State Machine	HLD_FOP_State_Machine.rst	High level design of fop state machine	High level design of fop state machine
		54	HLD of Request Handler	Request_Handler.rst	High level design of M0 request handler	High level design of M0 request handler
		55			Non-blocking server and locality of reference	TBD : Link is broken
		60			sns 1-pager	TBD : Link is broken
		61	SNS Overview	SNS_Overview.rst	sns overview	sns overview
		62			High level design of a parity de-clustering algorithm	High level design of a parity de-clustering algorithm
		67	Motr Layouts		On layouts	On layouts
		77	AR of RPC Layer	AR_RPC_Layer.rst	AR of rpc layer	AR of rpc layer
		89	ADDB Overview	ADDB.rst	addb 1-pager	addb 1-pager
14	dtm/dtm.h	71	HLD of DTM		HLD of Distributed Transaction Manager	HLD of Distributed Transaction Manager
15	fd/fd.h	82			HLD for details of the algorithm	TBD : Link is broken
16	fdmi/fdmi.c	842	HLD of FDMI	HLD_of_FDMI.rst	Motr FDMI HLD	Motr FDMI HLD
17	file/di.h	55			Docment	TBD : Link is broken
18	file/file.c	122	HLD of RM Interfaces	HLD_Resource_Management_Interface.rst	HLD of resource manager Interfaces	HLD of resource manager Interfaces
19	fol/fol.h	35			HLD for the description of requirements, usage patterns and constraints on fol, as well as important terminology (update, operation, etc.)	TBD : Link is broken
20	fop/fom_generic.h	50	HLD of fop object iterator	HLD_fop_object_iterator.rst	HLD of FOP object iterator	HLD of FOP object iterator
21	fop/fom.h	191			Document	TBD : Link is broken
22	ioservice/io_foms.c	556	FOPFOM Programming Guide	FOPFOM_Programming_Guide.rst	FOPFOM Programming Guide	FOPFOM Programming Guide
			HLD of fop state machine	HLD_FOP_State_Machine.rst	High Level Design - FOP State Machine	High Level Design - FOP State Machine
			HLD of rpc layer core	RPC_Layer_Core.rst	High level design of rpc layer core	High level design of rpc layer core
23	ioservice/io_fops.c	526	HLD of version numbers	HLD_Version_Numbers.rst	HLD of version numbers	HLD of version numbers
			HLD of FOL	HLD_of_FOL.rst	HLD of FOL	HLD of FOL
			HLD of Data Block Allocator	HLD_Data_Block_Allocator.rst	HLD of data block allocator	HLD of data block allocator
24	ioservice/io_fops.c	795	RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
					Detailed level design	TBD : Link is broken
25	iscservice/isc.h	101	ISC Service User Guide	ISC_Service_User_Guide.rst	ISC service user Guide	ISC service User Guide
26	layout/layout_db.c	57	HLD of Object Index	HLD_of_Motr_Object_Index.rst	High level design of a Motr Object Index	High level design of a Motr Object Index
27	layout/layout_db.c	336	HLD of Layout Schema	HLD_Layout_Schema.rst	HLD of Layout Schema	HLD of Layout Schema
			Understanding Layout Schema	Understanding_Layout_Schema.rst	Understanding Layout Schema	Understanding Layout Schema
28	layout/pdclust.h	63			Document	TBD : Link is broken
29	m0t1fs/linux_kernel/file_internal.h	1037			Detailed level design	TBD : Link is broken
30	m0t1fs/linux_kernel/file.c	306	HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of SNS repair	HLD of SNS repair
31	motr/client.h	511			Document	TBD : Link is broken
32	motr/iem.c	28			Document	Document Link
33	net/bulk_emulation/mem_xprt.h	95	RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
34	net/lnet/bev_cqueue.c	61	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
35	net/lnet/bev_cqueue.c	472	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
					Writing Lock-Free Code: A Corrected Queue, Herb Sutter, in Dr Dobbs Journal, 2008	TBD : Link is broken
36	net/lnet/linux_kernel/klnet_core.c	66	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
37	net/lnet/linux_kernel/klnet_core.c	778	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
38	net/lnet/linux_kernel/klnet_drv.c	70	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
39	net/lnet/linux_kernel/klnet_drv.c	228	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
40	net/lnet/linux_kernel/klnet_drv.c	811	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
41	net/lnet/lnet_main.c	72	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
42	net/lnet/lnet_main.c	582	RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
43	net/lnet/lnet_main.c	746	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
			RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
44	net/lnet/ulnet_core.c	67	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
45	net/lnet/ulnet_core.c	138	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
46	net/lnet/ulnet_core.c	465	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
47	net/lnet/ulnet_core.c	479	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
48	net/net.h	62	RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
49	net/net.h	68	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
50	net/test/node.c	693		HLD_of_Motr_Network_Benchmark.rst	Motr Network Benchmark HLD	TBD : Link is broken
51	net/tm_provision.c	48	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
52	net/tm_provision.c	57	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
53	net/tm_provision.c	399	HLD of Motr LNet Transport	Motr_LNet_Transport.rst	HLD of Motr LNet Transport	HLD of Motr LNet Transport
			RPC Bulk Transfer Task Plan		RPC Bulk Transfer Task Plan	RPC Bulk Transfer Task Plan
54	reqh/reqh.h	56	HLD of Request Handler	Request_Handler.rst	High level design of M0 request handler	High level design of M0 request handler
55	rm/rm_rwlock.c	145	HLD of RM Interfaces	HLD_Resource_Management_Interface.rst	HLD of resource manager Interfaces	HLD of resource manager Interfaces
56	rm/rm.h	210	HLD of RM Interfaces	HLD_Resource_Management_Interface.rst	HLD of resource management interfaces	HLD of resource management interfaces
57	rpc/at.h	203		RPC_Adaptive_Transmission.rst	RPC AT Requirements	RPC AT Requirements
58	rpc/rpc.h	29			Document	TBD : Link is broken
59	sns/cm/cm.c	353			Copy Machine redesign	TBD : Link is broken
					HLD of copy machine and agents	TBD : Link is broken
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	HLD of SNS repair	HLD of SNS repair
60	stats/stats_srv.c	172			DLD-stats-svc-ref References	TBD : Link is broken
61	udb/udb.h	32			Enterprise User Data-base HLD	TBD : Link is broken
			HLD of Function Shipping	HLD_of_Function_Shipping_and_In-Storage_Compute.rst	HLD of Function Shipping and In-Storage Compute	HLD of Function Shipping and In-Storage Compute
			HLD of ADDB Monitoring	ADDB_Monitoring.rst	ADDB	ADDB
			HLD of ADDB Monitoring	ADDB_Monitoring.rst	ADDB	ADDB
			HLD of Auxillary Databases	HLD_of_Auxillary_Databases.rst	High level design of Auxiliary Databases for SNS repair	High level design of Auxiliary Databases for SNS repair
			HLD of Background Scrub	HLD_Background_Scrub.rst	High Level Design of Background Scrub	High Level Design of Background Scrub
			HLD of Motr Lostore	HLD_of_Motr_Lostore.rst	High level design of a Motr lostore module	High level design of a Motr lostore module
			HLD of Motr Network Benchmark		High level design of Motr Network Benchmark	High level design of Motr Network Benchmark
			HLD of Configuration Caching	HLD_of_Motr_Caching.rst	High level design of Motr configuration caching	High level design of Motr configuration caching
			HLD of Configuration Schema	HLD_Configuration_Schema.rst	High level design of Motr’s configuration database schema	High level design of Motr’s configuration database schema
			HLD of Data Block Allocator	HLD_Data_Block_Allocator.rst	High level design of a data-block-allocator	High level design of a data-block-allocator
			HLD of Data Integrity in Motr	End-to-end_Data_Integrity.rst	High level design of End-to-end data integrity in Motr	High level design of End-to-end data integrity in Motr
			HLD of FDMI	HLD_of_FDMI.rst	HLD of FDMI	HLD of FDMI
			HLD of FOL	HLD_of_FOL.rst	High level design of a file operations log	High level design of a file operations log
			HLD of fop object iterator	HLD_fop_object_iterator.rst	High level design of a fop object iterator	High level design of a fop object iterator
			HLD of fop state machine	HLD_FOP_State_Machine.rst	High level design of fop state machine	High level design of fop state machine
			HLD of HA Interface	HLD_of_Motr_HA_Interface.rst	High level design of Motr HA interface	High level design of Motr HA interface
			HLD of Layout Schema	HLD_Layout_Schema.rst	High level design of a layout schema	High level design of a layout schema
			HLD of Meta Data Back End	HLD_Meta_Data_Back_End.rst	High level design of meta-data back-end	High level design of meta-data back-end
			HLD of NBA		High level design of non-blocking availability module for Motr port	High level design of non-blocking availability module for Motr port
			HLD of Object Index	HLD_of_Motr_Object_Index.rst	High level design of a Motr Object Index	High level design of a Motr Object Index
			HLD of Request Handler	Request_Handler.rst	High level design of M0 request handler	High level design of M0 request handler
			HLD of RM Interfaces	HLD_Resource_Management_Interface.rst	High level design of resource management interfaces	High level design of resource management interfaces
			HLD of RPC Formation	RPC_Formation.rst	High level design of RPC Formation	High level design of RPC Formation
			HLD of RPC Layer Core	RPC_Layer_Core.rst	High level design of rpc layer core	High level design of rpc layer core
			HLD of SNS Client	HLD_of_SNS_Client.rst	High level design of an SNS client module for C2 T1	High level design of an SNS client module for C2 T1
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	High Level Design of SNS Repair	High Level Design of SNS Repair
			HLD of SNS Repair	HLD_of_SNS_Repair.rst	High Level Design of SNS Repair	High Level Design of SNS Repair
			HLD of SNS Server	HLD_of_SNS_Server.rst	High level design of an SNS server server for C2 T1	High level design of an SNS server server for C2 T1
			HLD of Version Numbers	HLD_Version_Numbers.rst	High level design of version numbers	High level design of version numbers
			HLD of Spiel API	HLD_of_Spiel_API.rst	High level design of Motr Spiel API	High level design of Motr Spiel API
			Repair Auxdb	Repair_auxdb.rst	Repair Aux-db	Repair Aux-db
			HLD of SSPL	SSPL_HLD.rst	High Level Design Seagate Storage Platform Library	High Level Design Seagate Storage Platform Library
			HLD of Build Environment	Build_Environment.rst	Build Environment HLD for Motr project	Build Environment HLD for Motr project
			HLD of CaStor Management	Castor_Management.rst	CaStor Management & Monitoring High Level Design	CaStor Management & Monitoring High Level Design
			HLD of Meroepochs	Motr_Epochs_HLD.rst	Motr epochs - HLD	Motr epochs - HLD
			Data Integrity in Motr	End-to-end_Data_Migration.rst	Motr End-to-end Data integrity	Motr End-to-end Data integrity