cds/init.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_INIT_H
  32 #define CDSLIB_INIT_H
  33
  34 #include <cds/details/defs.h>
  35 #include <cds/os/topology.h>
  36 #include <cds/threading/model.h>
  37 #include <cds/details/lib.h>
  38
  39 namespace cds {
  40
  41     //@cond
  42     namespace details {
  43         bool CDS_EXPORT_API init_first_call();
  44         bool CDS_EXPORT_API fini_last_call();
  45     }   // namespace details
  46     //@endcond
  47
  48     /// Initialize CDS library
  49     /**
  50         The function initializes \p CDS library framework.
  51         Before usage of \p CDS library features your application must initialize it
  52         by calling \p %Initialize() function, see \ref cds_how_to_use "how to use the library".
  53
  54         You can call \p Initialize several times, only first call is significant others will be ignored.
  55         To terminate the \p CDS library correctly, each call to \p %Initialize() must be balanced
  56         by a corresponding \p Terminate() call.
  57
  58         Note, that this function does not initialize garbage collectors. To use GC you need you should call
  59         GC-specific constructor function to initialize internal structures of GC.
  60         See \p cds::gc for details.
  61     */
  62     static inline void Initialize(
  63         unsigned int nFeatureFlags = 0  ///< for future use, must be zero.
  64     )
  65     {
  66         CDS_UNUSED( nFeatureFlags );
  67
  68         if ( cds::details::init_first_call() )
  69         {
  70             cds::OS::topology::init();
  71             cds::threading::ThreadData::s_nProcCount = cds::OS::topology::processor_count();
  72             if ( cds::threading::ThreadData::s_nProcCount == 0 )
  73                 cds::threading::ThreadData::s_nProcCount = 1;
  74
  75             cds::threading::Manager::init();
  76         }
  77     }
  78
  79     /// Terminate CDS library
  80     /**
  81         This function terminates \p CDS library.
  82         After \p %Terminate() calling many features of the library are unavailable.
  83         This call should be the last call of \p CDS library in your application,
  84         see \ref cds_how_to_use "how to use the library".
  85     */
  86     static inline void Terminate()
  87     {
  88         if ( cds::details::fini_last_call() ) {
  89             cds::threading::Manager::fini();
  90
  91             cds::OS::topology::fini();
  92         }
  93     }
  94
  95 }   // namespace cds
  96
  97 #endif // CDSLIB_INIT_H