[thirdparty/gcc.git] / libstdc++-v3 / include / parallel / balanced_quicksort.h

// -*- C++ -*-

// Copyright (C) 2007-2020 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library.  This library is free
// software; you can redistribute it and/or modify it under the terms
// of the GNU General Public License as published by the Free Software
// Foundation; either version 3, or (at your option) any later
// version.

// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

/** @file parallel/balanced_quicksort.h
 *  @brief Implementation of a dynamically load-balanced parallel quicksort.
 *
 *  It works in-place and needs only logarithmic extra memory.
 *  The algorithm is similar to the one proposed in
 *
 *  P. Tsigas and Y. Zhang.
 *  A simple, fast parallel implementation of quicksort and
 *  its performance evaluation on SUN enterprise 10000.
 *  In 11th Euromicro Conference on Parallel, Distributed and
 *  Network-Based Processing, page 372, 2003.
 *
 *  This file is a GNU parallel extension to the Standard C++ Library.
 */

// Written by Johannes Singler.

#ifndef _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H
#define _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H 1

#include <parallel/basic_iterator.h>
#include <bits/stl_algo.h>
#include <bits/stl_function.h>

#include <parallel/settings.h>
#include <parallel/partition.h>
#include <parallel/random_number.h>
#include <parallel/queue.h>

#if _GLIBCXX_PARALLEL_ASSERTIONS
#include <parallel/checkers.h>
#ifdef _GLIBCXX_HAVE_UNISTD_H
#include <unistd.h>
#endif
#endif

namespace __gnu_parallel
{
  /** @brief Information local to one thread in the parallel quicksort run. */
  template<typename _RAIter>
    struct _QSBThreadLocal
    {
      typedef std::iterator_traits<_RAIter> _TraitsType;
      typedef typename _TraitsType::difference_type _DifferenceType;

      /** @brief Continuous part of the sequence, described by an
      iterator pair. */
      typedef std::pair<_RAIter, _RAIter> _Piece;

      /** @brief Initial piece to work on. */
      _Piece _M_initial;

      /** @brief Work-stealing queue. */
      _RestrictedBoundedConcurrentQueue<_Piece> _M_leftover_parts;

      /** @brief Number of threads involved in this algorithm. */
      _ThreadIndex _M_num_threads;

      /** @brief Pointer to a counter of elements left over to sort. */
      volatile _DifferenceType* _M_elements_leftover;

      /** @brief The complete sequence to sort. */
      _Piece _M_global;

      /** @brief Constructor.
       *  @param __queue_size size of the work-stealing queue. */
      _QSBThreadLocal(int __queue_size) : _M_leftover_parts(__queue_size) { }
    };

  /** @brief Balanced quicksort divide step.
    *  @param __begin Begin iterator of subsequence.
    *  @param __end End iterator of subsequence.
    *  @param __comp Comparator.
    *  @param __num_threads Number of threads that are allowed to work on
    *  this part.
    *  @pre @c (__end-__begin)>=1 */
  template<typename _RAIter, typename _Compare>
    typename std::iterator_traits<_RAIter>::difference_type
    __qsb_divide(_RAIter __begin, _RAIter __end,
		 _Compare __comp, _ThreadIndex __num_threads)
    {
      _GLIBCXX_PARALLEL_ASSERT(__num_threads > 0);

      typedef std::iterator_traits<_RAIter> _TraitsType;
      typedef typename _TraitsType::value_type _ValueType;
      typedef typename _TraitsType::difference_type _DifferenceType;

      _RAIter __pivot_pos =
	__median_of_three_iterators(__begin, __begin + (__end - __begin) / 2,
				    __end  - 1, __comp);

#if defined(_GLIBCXX_PARALLEL_ASSERTIONS)
      // Must be in between somewhere.
      _DifferenceType __n = __end - __begin;

      _GLIBCXX_PARALLEL_ASSERT((!__comp(*__pivot_pos, *__begin)
				&& !__comp(*(__begin + __n / 2),
					   *__pivot_pos))
			       || (!__comp(*__pivot_pos, *__begin)
				   && !__comp(*(__end - 1), *__pivot_pos))
			       || (!__comp(*__pivot_pos, *(__begin + __n / 2))
				   && !__comp(*__begin, *__pivot_pos))
			       || (!__comp(*__pivot_pos, *(__begin + __n / 2))
				   && !__comp(*(__end - 1), *__pivot_pos))
			       || (!__comp(*__pivot_pos, *(__end - 1))
				   && !__comp(*__begin, *__pivot_pos))
			       || (!__comp(*__pivot_pos, *(__end - 1))
				   && !__comp(*(__begin + __n / 2),
					      *__pivot_pos)));
#endif

      // Swap pivot value to end.
      if (__pivot_pos != (__end - 1))
	std::iter_swap(__pivot_pos, __end - 1);
      __pivot_pos = __end - 1;

      __gnu_parallel::__binder2nd<_Compare, _ValueType, _ValueType, bool>
	__pred(__comp, *__pivot_pos);

      // Divide, returning __end - __begin - 1 in the worst case.
      _DifferenceType __split_pos = __parallel_partition(__begin, __end - 1,
							 __pred,
							 __num_threads);

      // Swap back pivot to middle.
      std::iter_swap(__begin + __split_pos, __pivot_pos);
      __pivot_pos = __begin + __split_pos;

#if _GLIBCXX_PARALLEL_ASSERTIONS
      _RAIter __r;
      for (__r = __begin; __r != __pivot_pos; ++__r)
	_GLIBCXX_PARALLEL_ASSERT(__comp(*__r, *__pivot_pos));
      for (; __r != __end; ++__r)
	_GLIBCXX_PARALLEL_ASSERT(!__comp(*__r, *__pivot_pos));
#endif

      return __split_pos;
    }

  /** @brief Quicksort conquer step.
    *  @param __tls Array of thread-local storages.
    *  @param __begin Begin iterator of subsequence.
    *  @param __end End iterator of subsequence.
    *  @param __comp Comparator.
    *  @param __iam Number of the thread processing this function.
    *  @param __num_threads
    *          Number of threads that are allowed to work on this part. */
  template<typename _RAIter, typename _Compare>
    void
    __qsb_conquer(_QSBThreadLocal<_RAIter>** __tls,
		  _RAIter __begin, _RAIter __end,
		  _Compare __comp,
		  _ThreadIndex __iam, _ThreadIndex __num_threads,
		  bool __parent_wait)
    {
      typedef std::iterator_traits<_RAIter> _TraitsType;
      typedef typename _TraitsType::value_type _ValueType;
      typedef typename _TraitsType::difference_type _DifferenceType;

      _DifferenceType __n = __end - __begin;

      if (__num_threads <= 1 || __n <= 1)
	{
          __tls[__iam]->_M_initial.first  = __begin;
          __tls[__iam]->_M_initial.second = __end;

          __qsb_local_sort_with_helping(__tls, __comp, __iam, __parent_wait);

          return;
	}

      // Divide step.
      _DifferenceType __split_pos =
	__qsb_divide(__begin, __end, __comp, __num_threads);

#if _GLIBCXX_PARALLEL_ASSERTIONS
      _GLIBCXX_PARALLEL_ASSERT(0 <= __split_pos &&
                               __split_pos < (__end - __begin));
#endif

      _ThreadIndex
	__num_threads_leftside = std::max<_ThreadIndex>
	(1, std::min<_ThreadIndex>(__num_threads - 1, __split_pos
				   * __num_threads / __n));

#     pragma omp atomic
      *__tls[__iam]->_M_elements_leftover -= (_DifferenceType)1;

      // Conquer step.
#     pragma omp parallel num_threads(2)
      {
	bool __wait;
	if(omp_get_num_threads() < 2)
          __wait = false;
	else
          __wait = __parent_wait;

#       pragma omp sections
	{
#         pragma omp section
	  {
	    __qsb_conquer(__tls, __begin, __begin + __split_pos, __comp,
			  __iam, __num_threads_leftside, __wait);
	    __wait = __parent_wait;
	  }
	  // The pivot_pos is left in place, to ensure termination.
#         pragma omp section
	  {
	    __qsb_conquer(__tls, __begin + __split_pos + 1, __end, __comp,
			  __iam + __num_threads_leftside,
			  __num_threads - __num_threads_leftside, __wait);
	    __wait = __parent_wait;
	  }
	}
      }
    }

  /**
    *  @brief Quicksort step doing load-balanced local sort.
    *  @param __tls Array of thread-local storages.
    *  @param __comp Comparator.
    *  @param __iam Number of the thread processing this function.
    */
  template<typename _RAIter, typename _Compare>
    void
    __qsb_local_sort_with_helping(_QSBThreadLocal<_RAIter>** __tls,
				  _Compare& __comp, _ThreadIndex __iam,
				  bool __wait)
    {
      typedef std::iterator_traits<_RAIter> _TraitsType;
      typedef typename _TraitsType::value_type _ValueType;
      typedef typename _TraitsType::difference_type _DifferenceType;
      typedef std::pair<_RAIter, _RAIter> _Piece;

      _QSBThreadLocal<_RAIter>& __tl = *__tls[__iam];

      _DifferenceType
	__base_case_n = _Settings::get().sort_qsb_base_case_maximal_n;
      if (__base_case_n < 2)
	__base_case_n = 2;
      _ThreadIndex __num_threads = __tl._M_num_threads;

      // Every thread has its own random number generator.
      _RandomNumber __rng(__iam + 1);

      _Piece __current = __tl._M_initial;

      _DifferenceType __elements_done = 0;
#if _GLIBCXX_PARALLEL_ASSERTIONS
      _DifferenceType __total_elements_done = 0;
#endif

      for (;;)
	{
          // Invariant: __current must be a valid (maybe empty) range.
          _RAIter __begin = __current.first, __end = __current.second;
          _DifferenceType __n = __end - __begin;

          if (__n > __base_case_n)
            {
              // Divide.
              _RAIter __pivot_pos = __begin +  __rng(__n);

              // Swap __pivot_pos value to end.
              if (__pivot_pos != (__end - 1))
        	std::iter_swap(__pivot_pos, __end - 1);
              __pivot_pos = __end - 1;

              __gnu_parallel::__binder2nd
		<_Compare, _ValueType, _ValueType, bool>
		__pred(__comp, *__pivot_pos);

              // Divide, leave pivot unchanged in last place.
              _RAIter __split_pos1, __split_pos2;
              __split_pos1 = __gnu_sequential::partition(__begin, __end - 1,
							 __pred);

              // Left side: < __pivot_pos; __right side: >= __pivot_pos.
#if _GLIBCXX_PARALLEL_ASSERTIONS
              _GLIBCXX_PARALLEL_ASSERT(__begin <= __split_pos1
                                       && __split_pos1 < __end);
#endif
              // Swap pivot back to middle.
              if (__split_pos1 != __pivot_pos)
        	std::iter_swap(__split_pos1, __pivot_pos);
              __pivot_pos = __split_pos1;

              // In case all elements are equal, __split_pos1 == 0.
              if ((__split_pos1 + 1 - __begin) < (__n >> 7)
		  || (__end - __split_pos1) < (__n >> 7))
        	{
                  // Very unequal split, one part smaller than one 128th
                  // elements not strictly larger than the pivot.
                  __gnu_parallel::__unary_negate<__gnu_parallel::__binder1st
                    <_Compare, _ValueType, _ValueType, bool>, _ValueType>
                    __pred(__gnu_parallel::__binder1st
                	 <_Compare, _ValueType, _ValueType, bool>
			   (__comp, *__pivot_pos));

                  // Find other end of pivot-equal range.
                  __split_pos2 = __gnu_sequential::partition(__split_pos1 + 1,
							     __end, __pred);
        	}
              else
        	// Only skip the pivot.
        	__split_pos2 = __split_pos1 + 1;

              // Elements equal to pivot are done.
              __elements_done += (__split_pos2 - __split_pos1);
#if _GLIBCXX_PARALLEL_ASSERTIONS
              __total_elements_done += (__split_pos2 - __split_pos1);
#endif
              // Always push larger part onto stack.
              if (((__split_pos1 + 1) - __begin) < (__end - (__split_pos2)))
        	{
                  // Right side larger.
                  if ((__split_pos2) != __end)
                    __tl._M_leftover_parts.push_front
		      (std::make_pair(__split_pos2, __end));

                  //__current.first = __begin;    //already set anyway
                  __current.second = __split_pos1;
                  continue;
        	}
              else
        	{
                  // Left side larger.
                  if (__begin != __split_pos1)
                    __tl._M_leftover_parts.push_front(std::make_pair
						      (__begin, __split_pos1));

                  __current.first = __split_pos2;
                  //__current.second = __end;     //already set anyway
                  continue;
        	}
            }
          else
            {
              __gnu_sequential::sort(__begin, __end, __comp);
              __elements_done += __n;
#if _GLIBCXX_PARALLEL_ASSERTIONS
              __total_elements_done += __n;
#endif

              // Prefer own stack, small pieces.
              if (__tl._M_leftover_parts.pop_front(__current))
        	continue;

#             pragma omp atomic
              *__tl._M_elements_leftover -= __elements_done;

              __elements_done = 0;

#if _GLIBCXX_PARALLEL_ASSERTIONS
              double __search_start = omp_get_wtime();
#endif

              // Look for new work.
              bool __successfully_stolen = false;
              while (__wait && *__tl._M_elements_leftover > 0
                     && !__successfully_stolen
#if _GLIBCXX_PARALLEL_ASSERTIONS
                      // Possible dead-lock.
                     && (omp_get_wtime() < (__search_start + 1.0))
#endif
		     )
        	{
                  _ThreadIndex __victim;
                  __victim = __rng(__num_threads);

                  // Large pieces.
                  __successfully_stolen = (__victim != __iam)
		    && __tls[__victim]->_M_leftover_parts.pop_back(__current);
                  if (!__successfully_stolen)
                    __yield();
#if !defined(__ICC) && !defined(__ECC)
#                 pragma omp flush
#endif
        	}

#if _GLIBCXX_PARALLEL_ASSERTIONS
              if (omp_get_wtime() >= (__search_start + 1.0))
        	{
                  sleep(1);
                  _GLIBCXX_PARALLEL_ASSERT(omp_get_wtime()
                                           < (__search_start + 1.0));
        	}
#endif
              if (!__successfully_stolen)
        	{
#if _GLIBCXX_PARALLEL_ASSERTIONS
                  _GLIBCXX_PARALLEL_ASSERT(*__tl._M_elements_leftover == 0);
#endif
                  return;
        	}
            }
	}
    }

  /** @brief Top-level quicksort routine.
    *  @param __begin Begin iterator of sequence.
    *  @param __end End iterator of sequence.
    *  @param __comp Comparator.
    *  @param __num_threads Number of threads that are allowed to work on
    *  this part.
    */
  template<typename _RAIter, typename _Compare>
    void
    __parallel_sort_qsb(_RAIter __begin, _RAIter __end,
			_Compare __comp, _ThreadIndex __num_threads)
    {
      _GLIBCXX_CALL(__end - __begin)

      typedef std::iterator_traits<_RAIter> _TraitsType;
      typedef typename _TraitsType::value_type _ValueType;
      typedef typename _TraitsType::difference_type _DifferenceType;
      typedef std::pair<_RAIter, _RAIter> _Piece;

      typedef _QSBThreadLocal<_RAIter> _TLSType;

      _DifferenceType __n = __end - __begin;

      if (__n <= 1)
	return;

      // At least one element per processor.
      if (__num_threads > __n)
	__num_threads = static_cast<_ThreadIndex>(__n);

      // Initialize thread local storage
      _TLSType** __tls = new _TLSType*[__num_threads];
      _DifferenceType __queue_size = (__num_threads
				      * (_ThreadIndex)(__rd_log2(__n) + 1));
      for (_ThreadIndex __t = 0; __t < __num_threads; ++__t)
	__tls[__t] = new _QSBThreadLocal<_RAIter>(__queue_size);

      // There can never be more than ceil(__rd_log2(__n)) ranges on the
      // stack, because
      // 1. Only one processor pushes onto the stack
      // 2. The largest range has at most length __n
      // 3. Each range is larger than half of the range remaining
      volatile _DifferenceType __elements_leftover = __n;
      for (_ThreadIndex __i = 0; __i < __num_threads; ++__i)
	{
          __tls[__i]->_M_elements_leftover = &__elements_leftover;
          __tls[__i]->_M_num_threads = __num_threads;
          __tls[__i]->_M_global = std::make_pair(__begin, __end);

          // Just in case nothing is left to assign.
          __tls[__i]->_M_initial = std::make_pair(__end, __end);
	}

      // Main recursion call.
      __qsb_conquer(__tls, __begin, __begin + __n, __comp, 0,
		    __num_threads, true);

#if _GLIBCXX_PARALLEL_ASSERTIONS
      // All stack must be empty.
      _Piece __dummy;
      for (_ThreadIndex __i = 1; __i < __num_threads; ++__i)
	_GLIBCXX_PARALLEL_ASSERT(
          !__tls[__i]->_M_leftover_parts.pop_back(__dummy));
#endif

      for (_ThreadIndex __i = 0; __i < __num_threads; ++__i)
	delete __tls[__i];
      delete[] __tls;
    }
} // namespace __gnu_parallel

#endif /* _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H */
Commit	Line	Data
c2ba9709 JS	1	// -- C++ --
c2ba9709 JS	2
8d9254fc	3	// Copyright (C) 2007-2020 Free Software Foundation, Inc.
c2ba9709 JS	4	//
	5	// This file is part of the GNU ISO C++ Library. This library is free
	6	// software; you can redistribute it and/or modify it under the terms
	7	// of the GNU General Public License as published by the Free Software
748086b7	8	// Foundation; either version 3, or (at your option) any later
c2ba9709 JS	9	// version.
	10
	11	// This library is distributed in the hope that it will be useful, but
	12	// WITHOUT ANY WARRANTY; without even the implied warranty of
	13	// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	// General Public License for more details.
	15
748086b7 JJ	16	// Under Section 7 of GPL version 3, you are granted additional
	17	// permissions described in the GCC Runtime Library Exception, version
	18	// 3.1, as published by the Free Software Foundation.
	19
	20	// You should have received a copy of the GNU General Public License and
	21	// a copy of the GCC Runtime Library Exception along with this program;
	22	// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
	23	// <http://www.gnu.org/licenses/>.
c2ba9709 JS	24
	25	/** @file parallel/balanced_quicksort.h
	26	* @brief Implementation of a dynamically load-balanced parallel quicksort.
	27	*
	28	* It works in-place and needs only logarithmic extra memory.
1904bef1 JS	29	* The algorithm is similar to the one proposed in
	30	*
	31	* P. Tsigas and Y. Zhang.
	32	* A simple, fast parallel implementation of quicksort and
	33	* its performance evaluation on SUN enterprise 10000.
	34	* In 11th Euromicro Conference on Parallel, Distributed and
	35	* Network-Based Processing, page 372, 2003.
	36	*
c2ba9709 JS	37	* This file is a GNU parallel extension to the Standard C++ Library.
	38	*/
	39
	40	// Written by Johannes Singler.
	41
cbcd1e45 JS	42	#ifndef _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H
cbcd1e45 JS	43	#define _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H 1
c2ba9709 JS	44
	45	#include <parallel/basic_iterator.h>
	46	#include <bits/stl_algo.h>
53567bbd	47	#include <bits/stl_function.h>
c2ba9709 JS	48
	49	#include <parallel/settings.h>
	50	#include <parallel/partition.h>
	51	#include <parallel/random_number.h>
	52	#include <parallel/queue.h>
c2ba9709	53
e383deac	54	#if _GLIBCXX_PARALLEL_ASSERTIONS
c2ba9709	55	#include <parallel/checkers.h>
e383deac JW	56	#ifdef _GLIBCXX_HAVE_UNISTD_H
	57	#include <unistd.h>
	58	#endif
c2ba9709 JS	59	#endif
	60
	61	namespace __gnu_parallel
	62	{
77d16198 PC	63	/** @brief Information local to one thread in the parallel quicksort run. */
	64	template<typename _RAIter>
	65	struct _QSBThreadLocal
	66	{
	67	typedef std::iterator_traits<_RAIter> _TraitsType;
	68	typedef typename _TraitsType::difference_type _DifferenceType;
	69
	70	/** @brief Continuous part of the sequence, described by an
	71	iterator pair. */
	72	typedef std::pair<_RAIter, _RAIter> _Piece;
	73
	74	/** @brief Initial piece to work on. */
	75	_Piece _M_initial;
	76
	77	/** @brief Work-stealing queue. */
	78	_RestrictedBoundedConcurrentQueue<_Piece> _M_leftover_parts;
	79
	80	/** @brief Number of threads involved in this algorithm. */
	81	_ThreadIndex _M_num_threads;
	82
	83	/** @brief Pointer to a counter of elements left over to sort. */
	84	volatile _DifferenceType* _M_elements_leftover;
	85
	86	/** @brief The complete sequence to sort. */
	87	_Piece _M_global;
	88
	89	/** @brief Constructor.
	90	* @param __queue_size size of the work-stealing queue. */
	91	_QSBThreadLocal(int __queue_size) : _M_leftover_parts(__queue_size) { }
	92	};
	93
	94	/** @brief Balanced quicksort divide step.
	95	* @param __begin Begin iterator of subsequence.
	96	* @param __end End iterator of subsequence.
	97	* @param __comp Comparator.
	98	* @param __num_threads Number of threads that are allowed to work on
	99	* this part.
8e32aa11	100	* @pre @c (__end-__begin)>=1 */
77d16198 PC	101	template<typename _RAIter, typename _Compare>
	102	typename std::iterator_traits<_RAIter>::difference_type
	103	__qsb_divide(_RAIter __begin, _RAIter __end,
	104	_Compare __comp, _ThreadIndex __num_threads)
	105	{
	106	_GLIBCXX_PARALLEL_ASSERT(__num_threads > 0);
	107
	108	typedef std::iterator_traits<_RAIter> _TraitsType;
	109	typedef typename _TraitsType::value_type _ValueType;
	110	typedef typename _TraitsType::difference_type _DifferenceType;
	111
	112	_RAIter __pivot_pos =
	113	__median_of_three_iterators(__begin, __begin + (__end - __begin) / 2,
	114	__end - 1, __comp);
c2ba9709	115
e383deac	116	#if defined(_GLIBCXX_PARALLEL_ASSERTIONS)
77d16198 PC	117	// Must be in between somewhere.
	118	_DifferenceType __n = __end - __begin;
	119
	120	_GLIBCXX_PARALLEL_ASSERT((!__comp(__pivot_pos, __begin)
	121	&& !__comp(*(__begin + __n / 2),
	122	*__pivot_pos))
	123	\|\| (!__comp(__pivot_pos, __begin)
	124	&& !__comp((__end - 1), __pivot_pos))
	125	\|\| (!__comp(__pivot_pos, (__begin + __n / 2))
	126	&& !__comp(__begin, __pivot_pos))
	127	\|\| (!__comp(__pivot_pos, (__begin + __n / 2))
	128	&& !__comp((__end - 1), __pivot_pos))
	129	\|\| (!__comp(__pivot_pos, (__end - 1))
	130	&& !__comp(__begin, __pivot_pos))
	131	\|\| (!__comp(__pivot_pos, (__end - 1))
	132	&& !__comp(*(__begin + __n / 2),
	133	*__pivot_pos)));
c2ba9709 JS	134	#endif
c2ba9709 JS	135
77d16198 PC	136	// Swap pivot value to end.
77d16198 PC	137	if (__pivot_pos != (__end - 1))
fc722a0e	138	std::iter_swap(__pivot_pos, __end - 1);
77d16198	139	__pivot_pos = __end - 1;
c2ba9709	140
31380bc4	141	__gnu_parallel::__binder2nd<_Compare, _ValueType, _ValueType, bool>
77d16198	142	__pred(__comp, *__pivot_pos);
c2ba9709	143
77d16198 PC	144	// Divide, returning __end - __begin - 1 in the worst case.
	145	_DifferenceType __split_pos = __parallel_partition(__begin, __end - 1,
	146	__pred,
	147	__num_threads);
c2ba9709	148
77d16198	149	// Swap back pivot to middle.
fc722a0e	150	std::iter_swap(__begin + __split_pos, __pivot_pos);
77d16198	151	__pivot_pos = __begin + __split_pos;
c2ba9709	152
e383deac	153	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	154	_RAIter __r;
	155	for (__r = __begin; __r != __pivot_pos; ++__r)
	156	_GLIBCXX_PARALLEL_ASSERT(__comp(__r, __pivot_pos));
	157	for (; __r != __end; ++__r)
	158	_GLIBCXX_PARALLEL_ASSERT(!__comp(__r, __pivot_pos));
c2ba9709 JS	159	#endif
c2ba9709 JS	160
77d16198 PC	161	return __split_pos;
77d16198 PC	162	}
c2ba9709	163
77d16198 PC	164	/** @brief Quicksort conquer step.
	165	* @param __tls Array of thread-local storages.
	166	* @param __begin Begin iterator of subsequence.
	167	* @param __end End iterator of subsequence.
	168	* @param __comp Comparator.
	169	* @param __iam Number of the thread processing this function.
	170	* @param __num_threads
	171	* Number of threads that are allowed to work on this part. */
	172	template<typename _RAIter, typename _Compare>
	173	void
	174	__qsb_conquer(_QSBThreadLocal<_RAIter>** __tls,
	175	_RAIter __begin, _RAIter __end,
	176	_Compare __comp,
	177	_ThreadIndex __iam, _ThreadIndex __num_threads,
	178	bool __parent_wait)
	179	{
	180	typedef std::iterator_traits<_RAIter> _TraitsType;
	181	typedef typename _TraitsType::value_type _ValueType;
	182	typedef typename _TraitsType::difference_type _DifferenceType;
c2ba9709	183
77d16198 PC	184	_DifferenceType __n = __end - __begin;
	185
	186	if (__num_threads <= 1 \|\| __n <= 1)
	187	{
	188	__tls[__iam]->_M_initial.first = __begin;
	189	__tls[__iam]->_M_initial.second = __end;
	190
	191	__qsb_local_sort_with_helping(__tls, __comp, __iam, __parent_wait);
	192
	193	return;
	194	}
c2ba9709	195
77d16198 PC	196	// Divide step.
	197	_DifferenceType __split_pos =
	198	__qsb_divide(__begin, __end, __comp, __num_threads);
c2ba9709	199
e383deac	200	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	201	_GLIBCXX_PARALLEL_ASSERT(0 <= __split_pos &&
77d16198 PC	202	__split_pos < (__end - __begin));
c2ba9709 JS	203	#endif
c2ba9709 JS	204
77d16198 PC	205	_ThreadIndex
	206	__num_threads_leftside = std::max<_ThreadIndex>
	207	(1, std::min<_ThreadIndex>(__num_threads - 1, __split_pos
	208	* __num_threads / __n));
c2ba9709	209
77d16198 PC	210	# pragma omp atomic
77d16198 PC	211	*__tls[__iam]->_M_elements_leftover -= (_DifferenceType)1;
c2ba9709	212
77d16198 PC	213	// Conquer step.
	214	# pragma omp parallel num_threads(2)
	215	{
	216	bool __wait;
	217	if(omp_get_num_threads() < 2)
	218	__wait = false;
	219	else
	220	__wait = __parent_wait;
	221
	222	# pragma omp sections
	223	{
e683ee2a	224	# pragma omp section
77d16198 PC	225	{
	226	__qsb_conquer(__tls, __begin, __begin + __split_pos, __comp,
	227	__iam, __num_threads_leftside, __wait);
	228	__wait = __parent_wait;
	229	}
	230	// The pivot_pos is left in place, to ensure termination.
e683ee2a	231	# pragma omp section
77d16198 PC	232	{
	233	__qsb_conquer(__tls, __begin + __split_pos + 1, __end, __comp,
	234	__iam + __num_threads_leftside,
	235	__num_threads - __num_threads_leftside, __wait);
	236	__wait = __parent_wait;
	237	}
	238	}
	239	}
c2ba9709	240	}
77d16198 PC	241
	242	/**
	243	* @brief Quicksort step doing load-balanced local sort.
	244	* @param __tls Array of thread-local storages.
	245	* @param __comp Comparator.
	246	* @param __iam Number of the thread processing this function.
	247	*/
	248	template<typename _RAIter, typename _Compare>
	249	void
	250	__qsb_local_sort_with_helping(_QSBThreadLocal<_RAIter>** __tls,
8b0c13a8 JS	251	_Compare& __comp, _ThreadIndex __iam,
8b0c13a8 JS	252	bool __wait)
77d16198 PC	253	{
	254	typedef std::iterator_traits<_RAIter> _TraitsType;
	255	typedef typename _TraitsType::value_type _ValueType;
	256	typedef typename _TraitsType::difference_type _DifferenceType;
	257	typedef std::pair<_RAIter, _RAIter> _Piece;
	258
	259	_QSBThreadLocal<_RAIter>& __tl = *__tls[__iam];
	260
	261	_DifferenceType
	262	__base_case_n = _Settings::get().sort_qsb_base_case_maximal_n;
	263	if (__base_case_n < 2)
	264	__base_case_n = 2;
	265	_ThreadIndex __num_threads = __tl._M_num_threads;
	266
	267	// Every thread has its own random number generator.
	268	_RandomNumber __rng(__iam + 1);
	269
	270	_Piece __current = __tl._M_initial;
	271
	272	_DifferenceType __elements_done = 0;
e383deac	273	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198	274	_DifferenceType __total_elements_done = 0;
c2ba9709 JS	275	#endif
c2ba9709 JS	276
77d16198 PC	277	for (;;)
	278	{
	279	// Invariant: __current must be a valid (maybe empty) range.
	280	_RAIter __begin = __current.first, __end = __current.second;
	281	_DifferenceType __n = __end - __begin;
	282
	283	if (__n > __base_case_n)
	284	{
	285	// Divide.
	286	_RAIter __pivot_pos = __begin + __rng(__n);
	287
	288	// Swap __pivot_pos value to end.
	289	if (__pivot_pos != (__end - 1))
fc722a0e	290	std::iter_swap(__pivot_pos, __end - 1);
77d16198 PC	291	__pivot_pos = __end - 1;
77d16198 PC	292
31380bc4	293	__gnu_parallel::__binder2nd
77d16198 PC	294	<_Compare, _ValueType, _ValueType, bool>
	295	__pred(__comp, *__pivot_pos);
	296
	297	// Divide, leave pivot unchanged in last place.
	298	_RAIter __split_pos1, __split_pos2;
	299	__split_pos1 = __gnu_sequential::partition(__begin, __end - 1,
	300	__pred);
	301
	302	// Left side: < __pivot_pos; __right side: >= __pivot_pos.
e383deac	303	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	304	_GLIBCXX_PARALLEL_ASSERT(__begin <= __split_pos1
77d16198 PC	305	&& __split_pos1 < __end);
c2ba9709	306	#endif
77d16198 PC	307	// Swap pivot back to middle.
77d16198 PC	308	if (__split_pos1 != __pivot_pos)
fc722a0e	309	std::iter_swap(__split_pos1, __pivot_pos);
77d16198 PC	310	__pivot_pos = __split_pos1;
	311
	312	// In case all elements are equal, __split_pos1 == 0.
	313	if ((__split_pos1 + 1 - __begin) < (__n >> 7)
	314	\|\| (__end - __split_pos1) < (__n >> 7))
	315	{
	316	// Very unequal split, one part smaller than one 128th
	317	// elements not strictly larger than the pivot.
	318	__gnu_parallel::__unary_negate<__gnu_parallel::__binder1st
	319	<_Compare, _ValueType, _ValueType, bool>, _ValueType>
	320	__pred(__gnu_parallel::__binder1st
	321	<_Compare, _ValueType, _ValueType, bool>
	322	(__comp, *__pivot_pos));
	323
	324	// Find other end of pivot-equal range.
	325	__split_pos2 = __gnu_sequential::partition(__split_pos1 + 1,
	326	__end, __pred);
	327	}
	328	else
	329	// Only skip the pivot.
	330	__split_pos2 = __split_pos1 + 1;
	331
	332	// Elements equal to pivot are done.
	333	__elements_done += (__split_pos2 - __split_pos1);
e383deac	334	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198	335	__total_elements_done += (__split_pos2 - __split_pos1);
c2ba9709	336	#endif
77d16198 PC	337	// Always push larger part onto stack.
	338	if (((__split_pos1 + 1) - __begin) < (__end - (__split_pos2)))
	339	{
	340	// Right side larger.
	341	if ((__split_pos2) != __end)
	342	__tl._M_leftover_parts.push_front
	343	(std::make_pair(__split_pos2, __end));
	344
	345	//__current.first = __begin; //already set anyway
	346	__current.second = __split_pos1;
	347	continue;
	348	}
	349	else
	350	{
	351	// Left side larger.
	352	if (__begin != __split_pos1)
	353	__tl._M_leftover_parts.push_front(std::make_pair
	354	(__begin, __split_pos1));
	355
	356	__current.first = __split_pos2;
	357	//__current.second = __end; //already set anyway
	358	continue;
	359	}
	360	}
	361	else
	362	{
	363	__gnu_sequential::sort(__begin, __end, __comp);
	364	__elements_done += __n;
e383deac	365	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198	366	__total_elements_done += __n;
c2ba9709 JS	367	#endif
c2ba9709 JS	368
77d16198 PC	369	// Prefer own stack, small pieces.
	370	if (__tl._M_leftover_parts.pop_front(__current))
	371	continue;
c2ba9709	372
77d16198 PC	373	# pragma omp atomic
77d16198 PC	374	*__tl._M_elements_leftover -= __elements_done;
e683ee2a	375
77d16198	376	__elements_done = 0;
c2ba9709	377
e383deac	378	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198	379	double __search_start = omp_get_wtime();
c2ba9709 JS	380	#endif
c2ba9709 JS	381
77d16198 PC	382	// Look for new work.
	383	bool __successfully_stolen = false;
	384	while (__wait && *__tl._M_elements_leftover > 0
	385	&& !__successfully_stolen
e383deac	386	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	387	// Possible dead-lock.
77d16198 PC	388	&& (omp_get_wtime() < (__search_start + 1.0))
c2ba9709	389	#endif
77d16198 PC	390	)
	391	{
	392	_ThreadIndex __victim;
	393	__victim = __rng(__num_threads);
	394
	395	// Large pieces.
	396	__successfully_stolen = (__victim != __iam)
	397	&& __tls[__victim]->_M_leftover_parts.pop_back(__current);
	398	if (!__successfully_stolen)
	399	__yield();
c2ba9709	400	#if !defined(__ICC) && !defined(__ECC)
77d16198	401	# pragma omp flush
c2ba9709	402	#endif
77d16198	403	}
c2ba9709	404
e383deac	405	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	406	if (omp_get_wtime() >= (__search_start + 1.0))
	407	{
	408	sleep(1);
	409	_GLIBCXX_PARALLEL_ASSERT(omp_get_wtime()
	410	< (__search_start + 1.0));
	411	}
c2ba9709	412	#endif
77d16198 PC	413	if (!__successfully_stolen)
77d16198 PC	414	{
e383deac	415	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198	416	_GLIBCXX_PARALLEL_ASSERT(*__tl._M_elements_leftover == 0);
c2ba9709	417	#endif
77d16198 PC	418	return;
	419	}
	420	}
	421	}
	422	}
c2ba9709	423
77d16198 PC	424	/** @brief Top-level quicksort routine.
	425	* @param __begin Begin iterator of sequence.
	426	* @param __end End iterator of sequence.
	427	* @param __comp Comparator.
	428	* @param __num_threads Number of threads that are allowed to work on
	429	* this part.
	430	*/
	431	template<typename _RAIter, typename _Compare>
	432	void
	433	__parallel_sort_qsb(_RAIter __begin, _RAIter __end,
	434	_Compare __comp, _ThreadIndex __num_threads)
	435	{
	436	_GLIBCXX_CALL(__end - __begin)
	437
	438	typedef std::iterator_traits<_RAIter> _TraitsType;
	439	typedef typename _TraitsType::value_type _ValueType;
	440	typedef typename _TraitsType::difference_type _DifferenceType;
	441	typedef std::pair<_RAIter, _RAIter> _Piece;
	442
	443	typedef _QSBThreadLocal<_RAIter> _TLSType;
	444
	445	_DifferenceType __n = __end - __begin;
	446
	447	if (__n <= 1)
	448	return;
	449
	450	// At least one element per processor.
	451	if (__num_threads > __n)
	452	__num_threads = static_cast<_ThreadIndex>(__n);
	453
	454	// Initialize thread local storage
	455	_TLSType** __tls = new _TLSType*[__num_threads];
	456	_DifferenceType __queue_size = (__num_threads
	457	* (_ThreadIndex)(__rd_log2(__n) + 1));
	458	for (_ThreadIndex __t = 0; __t < __num_threads; ++__t)
	459	__tls[__t] = new _QSBThreadLocal<_RAIter>(__queue_size);
	460
	461	// There can never be more than ceil(__rd_log2(__n)) ranges on the
	462	// stack, because
	463	// 1. Only one processor pushes onto the stack
	464	// 2. The largest range has at most length __n
	465	// 3. Each range is larger than half of the range remaining
	466	volatile _DifferenceType __elements_leftover = __n;
8b0c13a8	467	for (_ThreadIndex __i = 0; __i < __num_threads; ++__i)
77d16198 PC	468	{
	469	__tls[__i]->_M_elements_leftover = &__elements_leftover;
	470	__tls[__i]->_M_num_threads = __num_threads;
	471	__tls[__i]->_M_global = std::make_pair(__begin, __end);
	472
	473	// Just in case nothing is left to assign.
	474	__tls[__i]->_M_initial = std::make_pair(__end, __end);
	475	}
	476
	477	// Main recursion call.
	478	__qsb_conquer(__tls, __begin, __begin + __n, __comp, 0,
	479	__num_threads, true);
c2ba9709	480
e383deac	481	#if _GLIBCXX_PARALLEL_ASSERTIONS
77d16198 PC	482	// All stack must be empty.
77d16198 PC	483	_Piece __dummy;
8b0c13a8	484	for (_ThreadIndex __i = 1; __i < __num_threads; ++__i)
77d16198 PC	485	_GLIBCXX_PARALLEL_ASSERT(
77d16198 PC	486	!__tls[__i]->_M_leftover_parts.pop_back(__dummy));
c2ba9709 JS	487	#endif
c2ba9709 JS	488
8b0c13a8	489	for (_ThreadIndex __i = 0; __i < __num_threads; ++__i)
77d16198 PC	490	delete __tls[__i];
	491	delete[] __tls;
	492	}
c2ba9709 JS	493	} // namespace __gnu_parallel
c2ba9709 JS	494
cbcd1e45	495	#endif /* _GLIBCXX_PARALLEL_BALANCED_QUICKSORT_H */