[DAPL2] sync with WinOF 2.1 branch
[mirror/winof/.git] / inc / complib / comp_lib.h
1 /*\r
2  * Copyright (c) 2005 SilverStorm Technologies.  All rights reserved.\r
3  * Copyright (c) 1996-2003 Intel Corporation. All rights reserved. \r
4  *\r
5  * This software is available to you under the OpenIB.org BSD license\r
6  * below:\r
7  *\r
8  *     Redistribution and use in source and binary forms, with or\r
9  *     without modification, are permitted provided that the following\r
10  *     conditions are met:\r
11  *\r
12  *      - Redistributions of source code must retain the above\r
13  *        copyright notice, this list of conditions and the following\r
14  *        disclaimer.\r
15  *\r
16  *      - Redistributions in binary form must reproduce the above\r
17  *        copyright notice, this list of conditions and the following\r
18  *        disclaimer in the documentation and/or other materials\r
19  *        provided with the distribution.\r
20  *\r
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
24  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\r
25  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\r
26  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
27  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r
28  * SOFTWARE.\r
29  *\r
30  * $Id$\r
31  */\r
32 \r
33 \r
34 /*\r
35  * Abstract:\r
36  *      One stop shopping for component library headers.\r
37  *\r
38  * Environment:\r
39  *      All\r
40  */\r
41 \r
42 \r
43 #ifndef _CL_LIB_H_\r
44 #define _CL_LIB_H_\r
45 \r
46 \r
47 /****h* Component Library/Component Library \r
48 * NAME\r
49 *       component library \r
50 *\r
51 * DESCRIPTION\r
52 *       The component library is a collection of components that can be used to\r
53 *       create complex projects quickly and reliably.\r
54 *\r
55 *       The component library simplifies development by eliminating the need to\r
56 *       re-implement existing functionality. This contributes to shorter\r
57 *       development cycles as well as smaller code bases, helping reduce the\r
58 *       number of bugs by leveraging tried and tested code.\r
59 *\r
60 *       The component library also provides the same interface in multiple\r
61 *       environments, such as kernel mode and user mode, allowing code to be used\r
62 *       in both, again reducing code duplication and development life cycles.\r
63 *\r
64 *       Components of the library all follow the same usage model, as follows:\r
65 *               - The constructor for all components should be called before any other\r
66 *               function for that component.  It is acceptable to call the initializer\r
67 *               without first calling the constructor.\r
68 *\r
69 *               - The initializer for all components must be called successfully\r
70 *               before any function manipulating that component is called.\r
71 *\r
72 *               - The destructor for all components must be called if the initializer\r
73 *               was called.\r
74 *\r
75 *       In a debug build, the components assert that the proper sequence is\r
76 *       followed.\r
77 *********/\r
78 \r
79 \r
80 #include <complib/cl_types.h>\r
81 #include <complib/cl_debug.h>\r
82 #include <complib/cl_memory.h>\r
83 #include <complib/cl_atomic.h>\r
84 #include <complib/cl_byteswap.h>\r
85 #include <complib/cl_math.h>\r
86 #include <complib/cl_passivelock.h>\r
87 #include <complib/cl_spinlock.h>\r
88 #include <complib/cl_timer.h>\r
89 #include <complib/cl_event.h>\r
90 #include <complib/cl_waitobj.h>\r
91 #include <complib/cl_qlist.h>\r
92 #include <complib/cl_list.h>\r
93 #include <complib/cl_qcomppool.h>\r
94 #include <complib/cl_qpool.h>\r
95 #include <complib/cl_comppool.h>\r
96 #include <complib/cl_pool.h>\r
97 #include <complib/cl_reqmgr.h>\r
98 #include <complib/cl_vector.h>\r
99 #include <complib/cl_syscallback.h>\r
100 #include <complib/cl_thread.h>\r
101 #include <complib/cl_threadpool.h>\r
102 #include <complib/cl_perf.h>\r
103 #include <complib/cl_log.h>\r
104 #include <complib/cl_qmap.h>\r
105 #include <complib/cl_map.h>\r
106 #include <complib/cl_fleximap.h>\r
107 #include <complib/cl_async_proc.h>\r
108 #include <complib/cl_ptr_vector.h>\r
109 #include <complib/cl_qlockpool.h>\r
110 #include <complib/cl_mutex.h>\r
111 #include <complib/cl_obj.h>\r
112 #include <complib/cl_ioctl.h>\r
113 \r
114 \r
115 #endif  /* _CL_LIB_H_ */\r