3 /* Copyright (c) 2007, 2009-2014. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "xbt/misc.h" /* SG_BEGIN_DECL */
13 #include "xbt/function_types.h"
14 #include "xbt/dynar.h"
18 /** \addtogroup XBT_parmap
20 * \brief Parallel map.
22 * A function is applied to all elements of a dynar in parallel with n worker threads.
23 * The worker threads are persistent until the destruction of the parmap.
25 * If there are more than n elements in the dynar, the worker threads are allowed to fetch themselves remaining work
26 * with xbt_parmap_next() and execute it.
31 /** \brief Parallel map data type (opaque type) */
32 typedef struct s_xbt_parmap *xbt_parmap_t;
34 /** \brief Synchronization mode of the worker threads of a parmap. */
36 XBT_PARMAP_POSIX, /**< use POSIX synchronization primitives */
37 XBT_PARMAP_FUTEX, /**< use Linux futex system call */
38 XBT_PARMAP_BUSY_WAIT, /**< busy waits (no system calls, maximum CPU usage) */
39 XBT_PARMAP_DEFAULT /**< futex if available, posix otherwise */
40 } e_xbt_parmap_mode_t;
42 XBT_PUBLIC(xbt_parmap_t) xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode);
43 XBT_PUBLIC(void) xbt_parmap_destroy(xbt_parmap_t parmap);
44 XBT_PUBLIC(void) xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data);
45 XBT_PUBLIC(void*) xbt_parmap_next(xbt_parmap_t parmap);