Browse Source

Added a few environment variables in chapters/configuration.texi.

Nicolas Collin 13 years ago
parent
commit
7f9f8d56fe
2 changed files with 34 additions and 12 deletions
  1. 4 4
      doc/chapters/advanced-examples.texi
  2. 30 8
      doc/chapters/configuration.texi

+ 4 - 4
doc/chapters/advanced-examples.texi

@@ -788,12 +788,12 @@ some nodes of the hierarchy have a big arity (e.g. many cores in a socket
 without a hierarchy of shared caches), StarPU will create combined workers of
 without a hierarchy of shared caches), StarPU will create combined workers of
 intermediate sizes.
 intermediate sizes.
 The user can give some hints to StarPU about combined workers sizes to favor.
 The user can give some hints to StarPU about combined workers sizes to favor.
-This can be done by using the environment variables STARPU_MIN_WORKERSIZE and
+This can be done by using the environment variables @code{STARPU_MIN_WORKERSIZE}
-STARPU_MAX_WORKERSIZE. When set, they will force StarPU to create the biggest
+and @code{STARPU_MAX_WORKERSIZE}. When set, they will force StarPU to create the
-combined workers possible without overstepping the defined boundaries.
+biggest combined workers possible without overstepping the defined boundaries.
 However, StarPU will create the remaining combined workers without abiding by
 However, StarPU will create the remaining combined workers without abiding by
 the rules if not possible.
 the rules if not possible.
-For example : if the user specify a minimum and maximum combined workers size
+For example : if the user specifies a minimum and maximum combined workers size
 of 3 on a machine containing 8 CPUs, StarPU will create a combined worker of
 of 3 on a machine containing 8 CPUs, StarPU will create a combined worker of
 size 2 beside the combined workers of size 3.
 size 2 beside the combined workers of size 3.
 
 

+ 30 - 8
doc/chapters/configuration.texi

@@ -214,14 +214,17 @@ is enabled when the required dependencies are found.
 @subsection Configuring workers
 @subsection Configuring workers
 
 
 @menu
 @menu
-* STARPU_NCPUS::                Number of CPU workers
+* STARPU_NCPUS::                	Number of CPU workers
-* STARPU_NCUDA::                Number of CUDA workers
+* STARPU_NCUDA::                	Number of CUDA workers
-* STARPU_NOPENCL::              Number of OpenCL workers
+* STARPU_NOPENCL::              	Number of OpenCL workers
-* STARPU_NGORDON::              Number of SPU workers (Cell)
+* STARPU_NGORDON::              	Number of SPU workers (Cell)
-* STARPU_WORKERS_NOBIND::       Do not bind workers
+* STARPU_WORKERS_NOBIND::       	Do not bind workers
-* STARPU_WORKERS_CPUID::        Bind workers to specific CPUs
+* STARPU_WORKERS_CPUID::        	Bind workers to specific CPUs
-* STARPU_WORKERS_CUDAID::       Select specific CUDA devices
+* STARPU_WORKERS_CUDAID::       	Select specific CUDA devices
-* STARPU_WORKERS_OPENCLID::     Select specific OpenCL devices
+* STARPU_WORKERS_OPENCLID::     	Select specific OpenCL devices
+* STARPU_SINGLE_COMBINED_WORKER:: 	Do not use concurrent workers
+* STARPU_MIN_WORKERSIZE::	 	Minimum size of the combined workers
+* STARPU_MAX_WORKERSIZE:: 		Maximum size of the combined workers
 @end menu
 @end menu
 
 
 @node STARPU_NCPUS
 @node STARPU_NCPUS
@@ -303,6 +306,25 @@ OpenCL equivalent of the @code{STARPU_WORKERS_CUDAID} environment variable.
 This variable is ignored if the @code{use_explicit_workers_opencl_gpuid} flag of
 This variable is ignored if the @code{use_explicit_workers_opencl_gpuid} flag of
 the @code{starpu_conf} structure passed to @code{starpu_init} is set.
 the @code{starpu_conf} structure passed to @code{starpu_init} is set.
 
 
+@node STARPU_SINGLE_COMBINED_WORKER
+@subsubsection @code{STARPU_SINGLE_COMBINED_WORKER} -- Do not use concurrent workers
+
+If set, StarPU will create a multiple workers which won't be able to work
+concurrently. It will create combined workers which size goes from 1 to the
+number total of CPU workers in the system.
+
+@node STARPU_MIN_WORKERSIZE
+@subsubsection @code{STARPU_MIN_WORKERSIZE} -- Minimum size of the combined workers
+
+Let the user give a hint to StarPU about which minimum size the combined workers
+should have.
+
+@node STARPU_MAX_WORKERSIZE
+@subsubsection @code{STARPU_MAX_WORKERSIZE} -- Maximum size of the combined workers
+
+Let the user give a hint to StarPU about which maximum size the combined workers
+should have.
+
 @node Scheduling
 @node Scheduling
 @subsection Configuring the Scheduling engine
 @subsection Configuring the Scheduling engine