开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
ncbicntr.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：15k
源码类别：

生物技术

开发平台：

C/C++

ncbicntr.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: ncbicntr.hpp,v $
  4.  * PRODUCTION Revision 1000.4  2004/06/01 19:07:55  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.24
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef NCBICNTR__HPP
  11. #define NCBICNTR__HPP
  13. /*  $Id: ncbicntr.hpp,v 1000.4 2004/06/01 19:07:55 gouriano Exp $
  14. * ===========================================================================
  15. *
  16. *                            PUBLIC DOMAIN NOTICE
  17. *               National Center for Biotechnology Information
  18. *
  19. *  This software/database is a "United States Government Work" under the
  20. *  terms of the United States Copyright Act.  It was written as part of
  21. *  the author's official duties as a United States Government employee and
  22. *  thus cannot be copyrighted.  This software/database is freely available
  23. *  to the public for use. The National Library of Medicine and the U.S.
  24. *  Government have not placed any restriction on its use or reproduction.
  25. *
  26. *  Although all reasonable efforts have been taken to ensure the accuracy
  27. *  and reliability of the software and data, the NLM and the U.S.
  28. *  Government do not and cannot warrant the performance or results that
  29. *  may be obtained by using this software or data. The NLM and the U.S.
  30. *  Government disclaim all warranties, express or implied, including
  31. *  warranties of performance, merchantability or fitness for any particular
  32. *  purpose.
  33. *
  34. *  Please cite the author in any work or product based on this material.
  35. *
  36. * ===========================================================================
  37. *
  38. * Author:  Aaron Ucko
  39. *
  40. *
  41. */
  43. /// @file ncbictr.hpp
  44. /// Efficient atomic counters (for CObject reference counts)
  45. /// Note that the special value 0x3FFFFFFF is used to indicate
  46. /// locked counters on some platforms.
  49. #include <corelib/ncbistd.hpp>
  51. #if defined(HAVE_SCHED_YIELD) && !defined(NCBI_NO_THREADS)
  52. extern "C" {
  53. #  include <sched.h>
  54. }
  55. #  define NCBI_SCHED_INIT() int spin_counter = 0
  56. #  define NCBI_SCHED_YIELD() if ( !(++spin_counter & 3) ) sched_yield()
  57. #else
  58. #  define NCBI_SCHED_INIT()
  59. #  define NCBI_SCHED_YIELD()
  60. #endif
  62. #ifdef NCBI_COMPILER_GCC
  63. #  if NCBI_COMPILER_VERSION >= 300
  64. #    define NCBI_COMPILER_GCC3 1
  65. #  endif
  66. #elif defined(NCBI_COMPILER_ICC)
  67. #  if NCBI_COMPILER_VERSION >= 600
  68. #    define NCBI_COMPILER_ICC6
  69. #  endif
  70. #endif
  72. #undef NCBI_COUNTER_UNSIGNED
  73. #undef NCBI_COUNTER_RESERVED_VALUE
  74. #undef NCBI_COUNTER_ASM_OK
  75. #undef NCBI_COUNTER_USE_ASM
  76. #undef NCBI_COUNTER_ADD
  77. #undef NCBI_COUNTER_NEED_MUTEX
  79. // Messy system-specific details; they're mostly grouped together here
  80. // to ensure consistency.
  82. #if defined(NCBI_COMPILER_GCC) || defined(NCBI_COMPILER_WORKSHOP) || (defined(NCBI_COMPILER_KCC) && defined(NCBI_OS_LINUX)) || defined(NCBI_COMPILER_ICC6)
  83. #  define NCBI_COUNTER_ASM_OK
  84. #endif
  86. /// Define platform specific counter-related macros/values.
  87. ///
  88. /// TNCBIAtomicValue "type" is defined based on facilities available for a
  89. /// compiler/platform. TNCBIAtomicValue is used in the CAtomicCounter class
  90. /// for defining the internal represntation of the counter.
  91. ///
  92. /// Where possible NCBI_COUNTER_ADD is defined in terms of compiler/platform
  93. /// specific features.
  94. #ifdef NCBI_NO_THREADS
  95.    typedef unsigned int TNCBIAtomicValue;
  96. #  define NCBI_COUNTER_UNSIGNED 1
  97. #  define NCBI_COUNTER_ADD(p, d) ((*p) += d)
  98. #elif defined(NCBI_COUNTER_ASM_OK) && defined(__sparc) && !defined(__sparcv9)
  99. // Always use our own code on pre-V9 SPARC; GCC 3's implementation
  100. // uses a global lock.
  101.    typedef unsigned int TNCBIAtomicValue;
  102. #  define NCBI_COUNTER_UNSIGNED 1
  103. #  define NCBI_COUNTER_RESERVED_VALUE 0x3FFFFFFF
  104. #  define NCBI_COUNTER_USE_ASM 1
  105. #elif defined(NCBI_COMPILER_GCC3)
  106. #  include <bits/atomicity.h>
  107.    typedef _Atomic_word TNCBIAtomicValue;
  108. #  if NCBI_COMPILER_VERSION >= 340
  109. #    define NCBI_COUNTER_ADD(p, d) (__gnu_cxx::__exchange_and_add(p, d) + d)
  110. #  else
  111. #    define NCBI_COUNTER_ADD(p, d) (__exchange_and_add(p, d) + d)
  112. #  endif
  113. #elif defined(NCBI_COMPILER_COMPAQ)
  114. #  include <machine/builtins.h>
  115.    typedef int TNCBIAtomicValue;
  116. #  define NCBI_COUNTER_ADD(p, d) (__ATOMIC_ADD_LONG(p, d) + d)
  117. #elif defined(NCBI_OS_SOLARIS) && 0 // Kernel-only. :-/
  118. #  include <sys/atomic.h>
  119.    typedef uint32_t TNCBIAtomicValue;
  120. #  define NCBI_COUNTER_UNSIGNED 1
  121. #  define NCBI_COUNTER_ADD(p, d) atomic_add_32_nv(p, d)
  122. #elif defined(NCBI_OS_IRIX)
  123. #  include <mutex.h>
  124.    typedef __uint32_t TNCBIAtomicValue;
  125. #  define NCBI_COUNTER_UNSIGNED 1
  126. #  define NCBI_COUNTER_ADD(p, d) add_then_test32(p, d)
  127. #elif defined(NCBI_OS_AIX)
  128. #  include <sys/atomic_op.h>
  129.    typedef int TNCBIAtomicValue;
  130. #  define NCBI_COUNTER_ADD(p, d) (fetch_and_add(p, d) + d)
  131. #elif defined(NCBI_OS_DARWIN)
  132. #  ifdef __MWERKS__
  133.     // necessary so Metrowerks can compile the following header properly
  134.     // unfortunately, there's no way to save the old value of the macro,
  135.     // so NCBI_verify_save must be just a flag.
  136. #    define __NOEXTENSIONS__
  137. #    ifdef verify
  138. #      define NCBI_verify_save verify
  139. #      undef verify
  140. #    endif
  141. #  endif
  142. #  include <CoreServices/CoreServices.h>
  143. // Darwin's <AssertMacros.h> defines check as a variant of assert....
  144. #  ifdef check
  145. #    undef check
  146. #  endif
  147. #  ifdef NCBI_verify_save
  148. #    undef verify
  149. #    if defined(NDEBUG) || !defined(_DEBUG)
  150. #      define verify(expr) (void) expr
  151. #    else
  152. #      define verify(expr) assert(expr)
  153. #    endif
  154. #  endif
  155.    typedef SInt32 TNCBIAtomicValue;
  156. #  define NCBI_COUNTER_ADD(p, d) (AddAtomic(d, p) + d)
  157. #elif defined(NCBI_OS_MAC)
  158. #  include <OpenTransport.h> // Is this right?
  159.    typedef SInt32 TNCBIAtomicValue;
  160. #  define NCBI_COUNTER_ADD(p, d) OTAtomicAdd32(d, p)
  161. #elif defined(NCBI_OS_MSWIN)
  162. #  include <corelib/ncbi_os_mswin.hpp>
  163.    typedef LONG TNCBIAtomicValue;
  164. #  define NCBI_COUNTER_ADD(p, d) (InterlockedExchangeAdd(p, d) + d)
  165. #else
  166.    typedef unsigned int TNCBIAtomicValue;
  167. #  define NCBI_COUNTER_UNSIGNED 1
  168. #  if defined (NCBI_COUNTER_ASM_OK) && (defined(__i386) || defined(__sparc))
  169. #    define NCBI_COUNTER_USE_ASM 1
  170. #  else
  171. #    define NCBI_COUNTER_NEED_MUTEX 1
  172. #  endif
  173. #endif
  176. /** @addtogroup Counters
  177.  *
  178.  * @{
  179.  */
  182. BEGIN_NCBI_SCOPE
  184. /////////////////////////////////////////////////////////////////////////////
  185. ///
  186. /// CAtomicCounter --
  187. ///
  188. /// Define a basic atomic counter.
  189. ///
  190. /// Provide basic counter operations for an atomic counter represented
  191. /// internally by TNCBIAtomicValue. 
  193. class CAtomicCounter
  194. {
  195. public:
  196.     typedef TNCBIAtomicValue TValue;  ///< Alias TValue for TNCBIAtomicValue
  198.     /// Get atomic counter value.
  199.     TValue Get(void) const THROWS_NONE;
  201.     /// Set atomic counter value.
  202.     void   Set(TValue new_value) THROWS_NONE;
  204.     /// Atomically add value (=delta), and return new counter value.
  205.     TValue Add(int delta) THROWS_NONE;
  206.     
  207.     /// Define NCBI_COUNTER_ADD if one has not been defined.
  208. #if defined(NCBI_COUNTER_USE_ASM)
  209.     static TValue x_Add(volatile TValue* value, int delta) THROWS_NONE;
  210. #  if !defined(NCBI_COUNTER_ADD)
  211. #     define NCBI_COUNTER_ADD(value, delta) NCBI_NS_NCBI::CAtomicCounter::x_Add((value), (delta))
  212. #  endif
  213. #endif
  215. private:
  216.     volatile TValue m_Value;  ///< Internal counter value
  218.     // CObject's constructor needs to read m_Value directly when checking
  219.     // for the magic number left by operator new.
  220.     friend class CObject;
  221. };
  224. /////////////////////////////////////////////////////////////////////////////
  225. ///
  226. /// CMutableAtomicCounter --
  227. ///
  228. /// Define a mutable atomic counter.
  229. ///
  230. /// Provide mutable counter operations for an atomic counter represented
  231. /// internally by CAtomicCounter. 
  233. class NCBI_XNCBI_EXPORT CMutableAtomicCounter
  234. {
  235. public:
  236.     typedef CAtomicCounter::TValue TValue; ///< Alias TValue simplifies syntax
  238.     /// Get atomic counter value.
  239.     TValue Get(void) const THROWS_NONE
  240.         { return m_Counter.Get(); }
  242.     /// Set atomic counter value.
  243.     void   Set(TValue new_value) const THROWS_NONE
  244.         { m_Counter.Set(new_value); }
  246.     /// Atomically add value (=delta), and return new counter value.
  247.     TValue Add(int delta) const THROWS_NONE
  248.         { return m_Counter.Add(delta); }
  250. private:
  251.     mutable CAtomicCounter m_Counter;      ///< Mutable atomic counter value
  252. };
  255. /* @} */
  258. //////////////////////////////////////////////////////////////////////
  259. // 
  260. // Inline methods
  262. inline
  263. CAtomicCounter::TValue CAtomicCounter::Get(void) const THROWS_NONE
  264. {
  265. #ifdef NCBI_COUNTER_RESERVED_VALUE
  266.     TValue value = m_Value;
  267.     NCBI_SCHED_INIT();
  268.     while (value == NCBI_COUNTER_RESERVED_VALUE) {
  269.         NCBI_SCHED_YIELD();
  270.         value = m_Value;
  271.     }
  272.     return value;
  273. #else
  274.     return m_Value;
  275. #endif
  276. }
  279. inline
  280. void CAtomicCounter::Set(CAtomicCounter::TValue new_value) THROWS_NONE
  281. {
  282.     m_Value = new_value;
  283. }
  286. // With WorkShop, sanely inlining assembly requires the use of ".il" files.
  287. // In order to keep the toolkit's external interface sane, we therefore
  288. // force this method out-of-line and into ncbicntr_workshop.o.
  289. #if defined(NCBI_COUNTER_USE_ASM) && (!defined(NCBI_COMPILER_WORKSHOP) || defined(NCBI_COUNTER_IMPLEMENTATION))
  290. #  ifdef NCBI_COMPILER_WORKSHOP
  291. #    ifdef __sparcv9
  292. extern "C"
  293. CAtomicCounter::TValue NCBICORE_asm_cas(CAtomicCounter::TValue new_value,
  294.                                         CAtomicCounter::TValue* address,
  295.                                         CAtomicCounter::TValue old_value);
  296. #    elif defined(__sparc)
  297. extern "C"
  298. CAtomicCounter::TValue NCBICORE_asm_swap(CAtomicCounter::TValue new_value,
  299.                                          CAtomicCounter::TValue* address);
  300. #    elif defined(__i386)
  301. extern "C"
  302. CAtomicCounter::TValue NCBICORE_asm_lock_xaddl(CAtomicCounter::TValue* address,
  303.                                                int delta);
  304. #    endif
  305. #  else
  306. inline
  307. #  endif
  308. CAtomicCounter::TValue
  309. CAtomicCounter::x_Add(volatile CAtomicCounter::TValue* value_p, int delta)
  310. THROWS_NONE
  311. {
  312.     TValue result;
  313.     TValue* nv_value_p = const_cast<TValue*>(value_p);
  314. #  ifdef __sparcv9
  315.     NCBI_SCHED_INIT();
  316.     for (;;) {
  317.         TValue old_value = *value_p;
  318.         result = old_value + delta;
  319.         // Atomic compare-and-swap: if *value_p == old_value, swap it
  320.         // with result; otherwise, just put the current value in result.
  321. #    ifdef NCBI_COMPILER_WORKSHOP
  322.         result = NCBICORE_asm_cas(result, nv_value_p, old_value);
  323. #    else
  324.         asm volatile("cas [%3], %2, %1" : "=m" (*nv_value_p), "+r" (result)
  325.                      : "r" (old_value), "r" (nv_value_p), "m" (*nv_value_p));
  326. #    endif
  327.         if (result == old_value) { // We win
  328.             break;
  329.         }
  330.         NCBI_SCHED_YIELD();
  331.     }
  332.     result += delta;
  333. #  elif defined(__sparc)
  334.     result = NCBI_COUNTER_RESERVED_VALUE;
  335.     NCBI_SCHED_INIT();
  336.     for (;;) {
  337. #    ifdef NCBI_COMPILER_WORKSHOP
  338.         result = NCBICORE_asm_swap(result, nv_value_p);
  339. #    else
  340.         asm volatile("swap [%2], %1" : "=m" (*nv_value_p), "+r" (result)
  341.                      : "r" (nv_value_p), "m" (*nv_value_p));
  342. #    endif
  343.         if (result != NCBI_COUNTER_RESERVED_VALUE) {
  344.             break;
  345.         }
  346.         NCBI_SCHED_YIELD();
  347.     }
  348.     result += delta;
  349.     *value_p = result;
  350. #  elif defined(__i386)
  351.     // Yay CISC. ;-)
  352. #    ifdef NCBI_COMPILER_WORKSHOP
  353.     result = NCBICORE_asm_lock_xaddl(nv_value_p, delta) + delta;
  354. #    else
  355.     asm volatile("lock; xaddl %1, %0" : "=m" (*nv_value_p), "=r" (result)
  356.                  : "1" (delta), "m" (*nv_value_p));
  357.     result += delta;
  358. #    endif
  359. #  else
  360. #    error "Unsupported processor type for assembly implementation!"
  361. #  endif
  362.     return result;
  363. }
  364. #endif
  366. #if !defined(NCBI_COUNTER_NEED_MUTEX)
  367. inline
  368. CAtomicCounter::TValue CAtomicCounter::Add(int delta) THROWS_NONE
  369. {
  370.     TValue* nv_value_p = const_cast<TValue*>(&m_Value);
  371.     return NCBI_COUNTER_ADD(nv_value_p, delta);
  372. }
  373. #endif
  375. END_NCBI_SCOPE
  377. /*
  378. * ===========================================================================
  379. *
  380. * $Log: ncbicntr.hpp,v $
  381. * Revision 1000.4  2004/06/01 19:07:55  gouriano
  382. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.24
  383. *
  384. * Revision 1.24  2004/05/14 16:15:41  dicuccio
  385. * Remove unneeded export specifier for CAtomicCounter - the class is entirely
  386. * inline for MSVC
  387. *
  388. * Revision 1.23  2004/04/26 14:31:46  ucko
  389. * GCC 3.4 has moved __exchange_and_add to the __gnu_cxx namespace.
  390. * Split up "+m" constraints for GCC assembly, as versions 3.4 and up
  391. * complain about them.
  392. *
  393. * Revision 1.22  2004/02/19 16:46:21  vasilche
  394. * Added spin counter before calling sched_yield().
  395. * Use volatile version of pointer for assignment in x_Add().
  396. *
  397. * Revision 1.21  2004/02/18 23:28:46  ucko
  398. * Clean up after previous (mislogged) commit, and honor volatility better.
  399. *
  400. * Revision 1.20  2004/02/17 20:35:23  rsmith
  401. * Deal with stray definition of verify() on Mac.
  402. *
  403. * Revision 1.19  2004/02/04 00:38:03  ucko
  404. * Centralize undefinition of Darwin's check macro.
  405. *
  406. * Revision 1.18  2004/02/03 19:28:30  ucko
  407. * Darwin: include the master CoreServices header because
  408. * DriverSynchronization.h is officially internal.
  409. *
  410. * Revision 1.17  2003/07/11 12:47:09  siyan
  411. * Documentation changes.
  412. *
  413. * Revision 1.16  2003/06/03 18:24:28  rsmith
  414. * wrap includes of sched.h (explicit and implicit) in extern "c" blocks, since Apples headers do not do it themselves.
  415. *
  416. * Revision 1.15  2003/06/03 15:35:07  rsmith
  417. * OS_DARWIN's AddAtomic returns the previous value, not the incremented value as we require.
  418. *
  419. * Revision 1.14  2003/05/23 18:16:07  rsmith
  420. * proper definitions for NCBI_COUNTER_ADD on Mac/Darwin
  421. *
  422. * Revision 1.13  2003/03/31 14:07:04  siyan
  423. * Added doxygen support
  424. *
  425. * Revision 1.12  2003/03/06 19:38:48  ucko
  426. * Make CObject a friend, so that InitCounter can read m_Value directly
  427. * rather than going through Get(), which would end up spinning forever
  428. * if it came across NCBI_COUNTER_RESERVED_VALUE.
  429. *
  430. * Revision 1.11  2002/12/18 22:53:21  dicuccio
  431. * Added export specifier for building DLLs in windows.  Added global list of
  432. * all such specifiers in mswin_exports.hpp, included through ncbistl.hpp
  433. *
  434. * Revision 1.10  2002/10/30 17:14:33  ucko
  435. * Enable inline asm for ICC 6, which seems to be okay with our (modern) syntax.
  436. *
  437. * Revision 1.9  2002/09/20 13:51:04  vasilche
  438. * Fixed volatile argument to NCBI_COUNTER_ADD
  439. *
  440. * Revision 1.8  2002/09/19 20:05:41  vasilche
  441. * Safe initialization of static mutexes
  442. *
  443. * Revision 1.7  2002/08/19 19:37:17  vakatov
  444. * Use <corelib/ncbi_os_mswin.hpp> in the place of <windows.h>
  445. *
  446. * Revision 1.6  2002/07/11 14:17:53  gouriano
  447. * exceptions replaced by CNcbiException-type ones
  448. *
  449. * Revision 1.5  2002/05/31 17:48:56  grichenk
  450. * +CMutableAtomicCounter
  451. *
  452. * Revision 1.4  2002/05/24 18:43:34  ucko
  453. * Use trivial implementation for single-threaded builds.
  454. *
  455. * Revision 1.3  2002/05/24 18:06:55  ucko
  456. * Inline assembly leads to ICC compiler errors in some cases, so stop
  457. * defining NCBI_COUNTER_ASM_OK for ICC.
  458. *
  459. * Revision 1.2  2002/05/24 14:20:04  ucko
  460. * Fix Intel extended assembly.
  461. * Drop use of FreeBSD <machine/atomic.h>; those functions return void.
  462. * Fix name of "nv_value_p" in Add(), and declare it only when needed.
  463. *
  464. * Revision 1.1  2002/05/23 22:24:21  ucko
  465. * Use low-level atomic operations for reference counts
  466. *
  467. *
  468. * ===========================================================================
  469. */
  471. #endif  /* NCBICNTR__HPP */