document what tests test

doc/doxygen/chapters/05check_list_performance.doxy

@@ -181,6 +181,9 @@ execution. For example, in the Cholesky factorization (dense linear algebra
 application), the GEMM task uses up to 3 buffers, so it is possible to set the
 maximum number of task buffers to 3 to run a Cholesky factorization on StarPU.
 
+The size of the various structures of StarPU can be printed by the
+tests/microbenchs/display_structures_size.
+
 It is also often useless to submit *all* the tasks at the same time. One can
 make the starpu_task_submit function block when a reasonable given number of
 tasks have been submitted, by setting the STARPU_LIMIT_MIN_SUBMITTED_TASKS and

tests/datawizard/acquire_cb.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011  Université de Bordeaux
+ * Copyright (C) 2011, 2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -17,6 +17,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that when using starpu_data_acquire_cb, the callback is properly called
+ */
+
 unsigned token = 0;
 starpu_data_handle_t token_handle;
 

tests/datawizard/acquire_cb_insert.c

@@ -18,6 +18,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that inserting a task from the callback of a starpu_data_acquire_cb
+ * call, with proper dependency with an already-submitted task
+ */
+
 #define N 16
 #define M 4
 #define X 2

tests/datawizard/acquire_release.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2014  Université de Bordeaux
+ * Copyright (C) 2010, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Call acquire/release in competition with inserting task working on the same data
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 10;
 #else

tests/datawizard/acquire_release2.c

@@ -19,6 +19,10 @@
 
 #include "../helper.h"
 
+/*
+ * Call acquire/release in competition with inserting task working on the same data 
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 40;
 #else

tests/datawizard/acquire_release_opencl.c

@@ -16,6 +16,10 @@
 
 #include <starpu.h>
 
+/*
+ * Queue an OpenCL kernel that just increments a variable
+ */
+
 extern struct starpu_opencl_program opencl_program;
 void increment_opencl(void *buffers[], void *args)
 {

tests/datawizard/allocate.c

@@ -19,6 +19,8 @@
 #include <stdlib.h>
 #include <datawizard/memory_manager.h>
 
+/* Stress data allocation on a GPU, triggering eviction */
+
 #define SIZE_LIMIT 128
 #define STR_LIMIT "128"
 #define SIZE_ALLOC 128

tests/datawizard/cache.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2014  Université de Bordeaux
+ * Copyright (C) 2010, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Trigger re-using a buffer allocation on GPUs
+ */
+
 #if defined(STARPU_USE_CUDA) || defined(STARPU_USE_OPENCL)
 static void codelet(void *descr[], STARPU_ATTRIBUTE_UNUSED void *_args)
 {

tests/datawizard/commute.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2013-2014 Université de Bordeaux
+ * Copyright (C) 2013-2014, 2016 Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Trigger various STARPU_R / STARPU_RW / STARPU_RW|COMMUTE patterns
+ */
+
 void begin(void *descr[], void *_args STARPU_ATTRIBUTE_UNUSED)
 {
 	int *x = (int *)STARPU_VARIABLE_GET_PTR(descr[0]);

tests/datawizard/commute2.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2014-2015 Université Bordeaux
+ * Copyright (C) 2014-2016 Université Bordeaux
  * Copyright (C) 2014 INRIA
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include "../helper.h"
 #include "../helper.h"
 
+/*
+ * Test that STARPU_RW vs STARPU_RW|STARPU_COMMUTE get proper dependency
+ */
+
 static unsigned cnt;
 
 static void cpu_memcpy(void *descr[], void *cl_arg)

tests/datawizard/copy.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2011  Université de Bordeaux
+ * Copyright (C) 2010-2011, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Trigger a lot of transfers of a single variable between CPUs and GPUs
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned nloops = 10;
 #else

tests/datawizard/critical_section_with_void_interface.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Use a void interface to protect the access to a variable that is not declared to StarPU
+ */
+
 starpu_data_handle_t void_handle;
 
 int critical_var;

tests/datawizard/data_implicit_deps.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2013, 2015  Université de Bordeaux
+ * Copyright (C) 2010, 2013, 2015-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test that implicit dependencies get properly computed
+ */
+
 #define VECTORSIZE	1024
 
 static unsigned *A, *B, *C, *D;

tests/datawizard/data_invalidation.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012, 2014  Université de Bordeaux
+ * Copyright (C) 2010, 2012, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2012, 2013, 2015  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,11 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Try to mix starpu_data_invalidate and starpu_data_invalidate_submit
+ * calls with task insertions
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define NLOOPS		100
 #else

tests/datawizard/data_lookup.c

@@ -22,6 +22,11 @@
 #include <sys/types.h>
 #include "../helper.h"
 
+/*
+ * Check that starpu_data_lookup returns the proper data handle, given
+ * the registered buffer address
+ */
+
 void task(void **buffers, void *args)
 {
 	float *numbers;

tests/datawizard/dining_philosophers.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,12 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test Dijkstra's Dining Philosophers problem
+ */
+
+/* TODO: try to use an arbiter and check improved concurrency */
+
 /* number of philosophers */
 #define N	16
 
@@ -70,6 +76,7 @@ int main(int argc, char **argv)
 		forks[f] = 0;
 
 		starpu_vector_data_register(&fork_handles[f], STARPU_MAIN_RAM, (uintptr_t)&forks[f], 1, sizeof(unsigned));
+		starpu_data_set_sequential_consistency_flag(fork_handles[f], 0);
 	}
 
 	unsigned ntasks = 1024;

tests/datawizard/double_parameter.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011  Université de Bordeaux
+ * Copyright (C) 2011, 2016  Université de Bordeaux
  * Copyright (C) 2012, 2013, 2015  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try passing the same parameter twice, with various access modes
+ */
+
 void dummy_func(void *descr[] STARPU_ATTRIBUTE_UNUSED, void *arg STARPU_ATTRIBUTE_UNUSED)
 {
 }

tests/datawizard/dsm_stress.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012, 2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012, 2015-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Trigger various combinations of access modes
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define N	100
 #else

tests/datawizard/gpu_ptr_register.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011-2012, 2014  Université de Bordeaux
+ * Copyright (C) 2011-2012, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2012 INRIA
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,11 @@
 #include "../helper.h"
 #include "scal.h"
 
+/*
+ * Register the GPU buffer to be used for an existing data, and perform
+ * a partitioned operation
+ */
+
 #if ! (defined(STARPU_USE_OPENCL) || defined(STARPU_USE_CUDA))
 int main(int argc, char **argv)
 {

tests/datawizard/gpu_register.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011-2012, 2014-2015  Université de Bordeaux
+ * Copyright (C) 2011-2012, 2014-2016  Université de Bordeaux
  * Copyright (C) 2012 INRIA
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include "../helper.h"
 #include "scal.h"
 
+/*
+ * Register a handle from a GPU buffer, and performs a partitioned operation
+ */
+
 #if ! (defined(STARPU_USE_OPENCL) || defined(STARPU_USE_CUDA))
 int main(int argc, char **argv)
 {

tests/datawizard/handle_to_pointer.c

@@ -21,6 +21,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test the value returned by starpu_handle_to_pointer
+ */
+
 void cpu_task(void **buffers, void *args)
 {
 	int *numbers;

tests/datawizard/in_place_partition.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011, 2015  Université de Bordeaux
+ * Copyright (C) 2011, 2015-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,11 @@
 #include "../helper.h"
 #include "scal.h"
 
+/*
+ * Trigger in-place partitioning by prefetching the whole data before
+ * partitioning
+ */
+
 int main(int argc, char **argv)
 {
 	unsigned *foo;

tests/datawizard/increment_init.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2014  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,12 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that the initializer passed to starpu_data_set_reduction_methods
+ * is used to initialize a handle when it is registered from NULL, and when
+ * starpu_data_invalidate is called
+ */
+
 static starpu_data_handle_t handle;
 
 /*

tests/datawizard/increment_redux.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that STARPU_REDUX works with a mere incrementation
+ */
+
 static unsigned var = 0;
 static starpu_data_handle_t handle;
 

tests/datawizard/increment_redux_lazy.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that STARPU_REDUX works with a mere incrementation, but without
+ * initializing the variable
+ */
+
 static starpu_data_handle_t handle;
 
 /*

tests/datawizard/increment_redux_v2.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011-2015  Université de Bordeaux
+ * Copyright (C) 2011-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that STARPU_REDUX works with a mere incrementation, but
+ * intermixing with non-REDUX accesses
+ */
+
 static unsigned var = 0;
 static starpu_data_handle_t handle;
 

tests/datawizard/lazy_allocation.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2012, 2014  Université de Bordeaux
+ * Copyright (C) 2010-2012, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2012       INRIA
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,11 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Trigger lazy allocation by registering NULL, then setting a value, and
+ * then checking it
+ */
+
 #define VECTORSIZE	1024
 
 static starpu_data_handle_t v_handle;

tests/datawizard/lazy_unregister.c

@@ -21,6 +21,10 @@
 
 #include "../helper.h"
 
+/*
+ * Test that starpu_data_unregister_submit waits for both tasks to finish
+ */
+
 void dummy_func(void ** buffers, void * args)
 {
 	(void) buffers;

tests/datawizard/locality.c

@@ -104,6 +104,7 @@ int main(int argc, char *argv[])
 	}
 	starpu_arbiter_destroy(arbiter);
 
+	printf("worker where each domain piece was computed, over time\n");
 	for (loop = 0; loop < ITER; loop++)
 	{
 		for (i = 1; i < N-1; i++)
@@ -112,7 +113,9 @@ int main(int argc, char *argv[])
 		}
 		printf("\n");
 	}
+	printf("\n");
 
+	printf("domain piece that each worker has computed, over time\n");
 	loop = 0;
 	do {
 		finished = 1;

tests/datawizard/manual_reduction.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Allocate one buffer per worker, doing computations with it, and
+ * eventually reducing it into a single buffer
+ */
+
 #define INIT_VALUE	42
 #define NTASKS		10000
 

tests/datawizard/mpi_like.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2012, 2014  Université de Bordeaux
+ * Copyright (C) 2010-2012, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,13 @@
 #include "../helper.h"
 #include "./mpi_like.h"
 
+/*
+ * Mimic the behavior of libstarpumpi, tested by a ring of threads which
+ * increment the same variable one after the other.
+ * This is the synchronous version: the threads wait for completion of each
+ * step before continuing.
+ */
+
 #define NTHREADS	4
 #define NITER		2
 

tests/datawizard/mpi_like_async.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2014  Université de Bordeaux
+ * Copyright (C) 2010-2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -20,6 +20,13 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Mimic the behavior of libstarpumpi, tested by a ring of threads which
+ * increment the same variable one after the other.
+ * This is the asynchronous version: the threads submit the series of
+ * synchronizations and tasks.
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define NTHREADS_DEFAULT	4
 #  define NITER_DEFAULT		8

tests/datawizard/no_unregister.c

@@ -14,8 +14,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/* Check that not unregistering a data is not too crashy */
-
 #include <config.h>
 #include <starpu.h>
 #include <stdlib.h>
@@ -23,6 +21,10 @@
 
 #include "../helper.h"
 
+/*
+ * Check that not unregistering a data is not too crashy
+ */
+
 void dummy_func(void ** buffers, void * args)
 {
 	(void) buffers;

tests/datawizard/noreclaim.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2014-2015  Université de Bordeaux
+ * Copyright (C) 2014-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -14,15 +14,15 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/*
- * This test stress the memory allocation system and should force StarPU to
- * reclaim memory from time to time.
- */
-
 #include <assert.h>
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Stress the memory allocation system and force StarPU to reclaim memory from
+ * time to time.
+ */
+
 #if !defined(STARPU_HAVE_SETENV)
 #warning setenv is not defined. Skipping test
 int main(int argc, char **argv)

tests/datawizard/nowhere.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2015  Université de Bordeaux
+ * Copyright (C) 2015-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -21,6 +21,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Try the NOWHERE flag
+ */
+
 static int x, y;
 
 static void prod(void *descr[], void *_args STARPU_ATTRIBUTE_UNUSED)

tests/datawizard/opencl_codelet_unsigned_inc.c

@@ -16,6 +16,10 @@
 
 #include <starpu.h>
 
+/*
+ * Queue an OpenCL kernel which just increments a variable
+ */
+
 extern struct starpu_opencl_program opencl_program;
 
 void opencl_codelet_unsigned_inc(void *buffers[], void *args)

tests/datawizard/partition_dep.c

@@ -18,6 +18,10 @@
 #include "../helper.h"
 #include "scal.h"
 
+/*
+ * Test scaling a partitioned vector
+ */
+
 int main(int argc, char **argv)
 {
 	unsigned *foo;

tests/datawizard/partition_lazy.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011, 2014  Université de Bordeaux
+ * Copyright (C) 2011, 2014, 2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,10 @@
 #include "../helper.h"
 #include "scal.h"
 
+/*
+ * Test partitioning an uninitialized vector
+ */
+
 struct starpu_codelet mycodelet =
 {
 	.cpu_funcs = { scal_func_cpu },

tests/datawizard/readers_and_writers.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try mixing readers and writers on the same variable
+ */
+
 static unsigned book = 0;
 static starpu_data_handle_t book_handle;
 

tests/datawizard/readonly.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try accessing a variable in read-only mode
+ */
+
 #ifdef STARPU_USE_OPENCL
 static void codelet(void *descr[], STARPU_ATTRIBUTE_UNUSED void *_args)
 {

tests/datawizard/reclaim.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2012, 2015  Université de Bordeaux
+ * Copyright (C) 2010-2012, 2015-2016  Université de Bordeaux
  * Copyright (C) 2012  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -15,11 +15,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/*
- * This test stress the memory allocation system and should force StarPU to
- * reclaim memory from time to time.
- */
-
 #include <assert.h>
 #include <starpu.h>
 #include <common/config.h>
@@ -28,6 +23,11 @@
 #endif
 #include "../helper.h"
 
+/*
+ * Stress the memory allocation system and force StarPU to reclaim memory from
+ * time to time.
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define BLOCK_SIZE (64*1024)
 static unsigned ntasks = 250;

tests/datawizard/scal.c

@@ -19,6 +19,10 @@
 #include "scal.h"
 #include "helper.h"
 
+/*
+ * Implement a kernel that just multiplies a vector by 2
+ */
+
 void scal_func_cpu(void *buffers[], void *cl_arg)
 {
 	unsigned i;

tests/datawizard/scratch.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2014  Université de Bordeaux
+ * Copyright (C) 2010, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test using a scratch data, using it just for temporary storage
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define NLOOPS		8
 #  define VECTORSIZE		128

tests/datawizard/scratch_opencl.c

@@ -16,6 +16,10 @@
 
 #include <starpu.h>
 
+/*
+ * Queue an OpenCL kernel for the scratch test.
+ */
+
 extern struct starpu_opencl_program opencl_program;
 
 void opencl_f(void *buffers[], void *args)

tests/datawizard/specific_node.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2014  Université de Bordeaux
+ * Copyright (C) 2010, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2012, 2013, 2015  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,13 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test using the specific_nodes field by forcing the data to main memory
+ * even if the task is run on a GPU (and actually doing the computation from
+ * the CPU driving the GPU). It mixes such accesses and normal accesses from
+ * the GPU
+ */
+
 starpu_data_handle_t data_handle;
 
 unsigned data;

tests/datawizard/sync_and_notify_data.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2014  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  * Copyright (C) 2012 INRIA
  *
@@ -24,6 +24,10 @@
 
 #include "../helper.h"
 
+/*
+ * Mix synchronous tasks and data acquisitions
+ */
+
 #define N_DEF	100
 #define K_DEF	256
 

tests/datawizard/sync_and_notify_data_implicit.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2013-2014  Université de Bordeaux
+ * Copyright (C) 2010, 2013-2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 
 #include "../helper.h"
 
+/*
+ * Mix tasks with implicit dependencies and data acquisitions
+ */
+
 #define N_DEF	100
 #define K_DEF	256
 

tests/datawizard/sync_and_notify_data_opencl.c

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2010, 2012  CNRS
- * Copyright (C) 2011, 2014  Université de Bordeaux
+ * Copyright (C) 2011, 2014, 2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Queue kernels which just increment the vector
+ */
+
 extern struct starpu_opencl_program opencl_code;
 
 void opencl_codelet_incA(void *descr[], STARPU_ATTRIBUTE_UNUSED void *_args)

tests/datawizard/sync_with_data_with_mem.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012  Université de Bordeaux
+ * Copyright (C) 2010, 2012, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Mix submitting tasks and synchronously acquiring the corresponding data.
+ */
+
 #define NBUFFERS_DEF	64
 #define NITER_DEF	128
 #define VECTORSIZE_DEF	1024

tests/datawizard/sync_with_data_with_mem_non_blocking.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012  Université de Bordeaux
+ * Copyright (C) 2010, 2012, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Mix submitting tasks and asynchronously acquiring the corresponding data.
+ */
+
 #define NBUFFERS_DEF	64
 #define NITER_DEF	128
 #define VECTORSIZE_DEF	1024

tests/datawizard/sync_with_data_with_mem_non_blocking_implicit.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012  Université de Bordeaux
+ * Copyright (C) 2010, 2012, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,11 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Mix submitting tasks and asynchronously acquiring the corresponding
+ * data, but without implicit dependencies.
+ */
+
 #define NBUFFERS_DEF	64
 #define NITER_DEF	128
 #define VECTORSIZE_DEF	1024

tests/datawizard/task_with_multiple_time_the_same_handle.c

@@ -17,6 +17,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test passing the same handle several times to the same task
+ */
+
 void sum_cpu(void * descr[], void *cl_arg)
 {
 	double * v_dst = (double *) STARPU_VARIABLE_GET_PTR(descr[0]);

tests/datawizard/unpartition.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2012  Université de Bordeaux
+ * Copyright (C) 2010-2012, 2016  Université de Bordeaux
  * Copyright (C) 2010  Mehdi Juhoor <mjuhoor@gmail.com>
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
@@ -23,6 +23,11 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test running a task on a partitioned data, then on the unpartitioned
+ * data, etc. in a loop
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #define NITER		100
 #else

tests/datawizard/user_interaction_implicit.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test modifying the data in the callback of starpu_data_acquire_cb
+ */
+
 #ifdef STARPU_QUICK_CHECK
 #  define NBUFFERS	4
 #  define NITER		16

tests/datawizard/variable_parameters.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2014  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test the variable interface
+ */
+
 static starpu_data_handle_t handle1, handle2, handle3, handle4;
 
 /*

tests/datawizard/write_only_tmp_buffer.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010-2012, 2014  Université de Bordeaux
+ * Copyright (C) 2009, 2010-2012, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test initializing a buffer with a task, then printing it with another task
+ */
+
 #define VECTORSIZE	1024
 
 starpu_data_handle_t v_handle;

tests/datawizard/wt_broadcast.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011-2012, 2014-2015  Université de Bordeaux
+ * Copyright (C) 2011-2012, 2014-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test using starpu_data_set_wt_mask(handle, ~0);, i.e. broadcasting the
+ * result on all devices as soon as it is available.
+ */
+
 static unsigned var = 0;
 static starpu_data_handle_t handle;
 /*

tests/datawizard/wt_host.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2011-2012, 2014-2015  Université de Bordeaux
+ * Copyright (C) 2011-2012, 2014-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test writing back the result into main memory as soon as it is available
+ */
+
 static unsigned var = 0;
 static starpu_data_handle_t handle;
 /*
@@ -96,7 +100,7 @@ int main(int argc, char **argv)
 	starpu_variable_data_register(&handle, STARPU_MAIN_RAM, (uintptr_t)&var, sizeof(unsigned));
 
 	/* Copy the handle in main memory every time it is modified */
-	uint32_t wt_mask = (1<<0);
+	uint32_t wt_mask = (1<<STARPU_MAIN_RAM);
 	starpu_data_set_wt_mask(handle, wt_mask);
 
 #ifdef STARPU_QUICK_CHECK

tests/disk/disk_compute.c

@@ -15,10 +15,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/* Try to write into disk memory
- * Use mechanism to push datas from main ram to disk ram
- */
-
 #include <fcntl.h>
 #include <starpu.h>
 #include <stdlib.h>
@@ -31,6 +27,13 @@
 #include <common/config.h>
 #include "../helper.h"
 
+/*
+ * Try to write into disk memory
+ * Use mechanism to push datas from main ram to disk ram
+ * Here we just simulate performing a dumb computation C=A+0, i.e. a mere copy
+ * actually
+ */
+
 #ifdef STARPU_HAVE_WINDOWS
 #  include <io.h>
 #  if defined(_WIN32) && !defined(__CYGWIN__)

tests/disk/disk_copy.c

@@ -15,10 +15,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/* Try to write into disk memory
- * Use mechanism to push datas from main ram to disk ram
- */
-
 #include <starpu.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -27,6 +23,13 @@
 #include <common/config.h>
 #include "../helper.h"
 
+/*
+ * Try to write into disk memory
+ * Use mechanism to push datas from main ram to disk ram
+ * Here we make copies between buffers, that StarPU has to evict while
+ * progressing because there is not enough room for all of them.
+ */
+
 #ifdef STARPU_HAVE_WINDOWS
 #  include <io.h>
 #  if defined(_WIN32) && !defined(__CYGWIN__)
@@ -165,8 +168,15 @@ int main(void)
 {
 	int ret = 0;
 	char s[128];
+
 	snprintf(s, sizeof(s), "/tmp/%s-disk-%d", getenv("USER"), getpid());
-	mkdir(s, 0777);
+	ret = mkdir(s, 0777);
+	if (ret)
+	{
+		FPRINTF(stderr, "Cannot make directory <%s>\n", s);
+		return STARPU_TEST_SKIPPED;
+	}
+
 	ret = merge_result(ret, dotest(&starpu_disk_stdio_ops, s));
 	ret = merge_result(ret, dotest(&starpu_disk_unistd_ops, s));
 #ifdef STARPU_LINUX_SYS

tests/disk/disk_pack.c

@@ -15,10 +15,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/* Try to write into disk memory
- * Use mechanism to push datas from main ram to disk ram
- */
-
 #include <fcntl.h>
 #include <starpu.h>
 #include <stdlib.h>
@@ -31,6 +27,12 @@
 #include <common/config.h>
 #include "../helper.h"
 
+/*
+ * Try to write into disk memory
+ * Use mechanism to push datas from main ram to disk ram
+ * Here we force using the pack/unpack mechanism
+ */
+
 #ifdef STARPU_HAVE_WINDOWS
 #  include <io.h>
 #  if defined(_WIN32) && !defined(__CYGWIN__)

tests/disk/mem_reclaim.c

@@ -15,10 +15,6 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/* Try to write into disk memory
- * Use mechanism to push datas from main ram to disk ram
- */
-
 #include <fcntl.h>
 #include <starpu.h>
 #include <stdlib.h>
@@ -31,6 +27,12 @@
 #include <common/config.h>
 #include "../helper.h"
 
+/*
+ * Try to write into disk memory
+ * Use mechanism to push datas from main ram to disk ram
+ * Here we stress the memory with more tasks than what the RAM can fit.
+ */
+
 #ifdef STARPU_HAVE_MEMCHECK_H
 #include <valgrind/memcheck.h>
 #else

tests/errorcheck/invalid_blocking_calls.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010, 2013, 2015  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2013, 2015-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,11 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that we catch calling tag_wait, i.e. a blocking call, from the
+ * codelet function, which is invalid. This test is thus expected to fail.
+ */
+
 #ifdef STARPU_NO_ASSERT
 int main(int argc, char **argv)
 {

tests/errorcheck/invalid_tasks.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2012  Université de Bordeaux
+ * Copyright (C) 2010-2012, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include "../helper.h"
 #include <common/config.h>
 
+/*
+ * Check that we detect that with only a CPU we can't submit a GPU-only task
+ */
+
 #if !defined(STARPU_HAVE_UNSETENV) || !defined(STARPU_USE_CPU)
 #warning unsetenv is not defined or no cpu are available. Skipping test
 int main(int argc, char **argv)

tests/errorcheck/starpu_init_noworker.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010, 2012-2015  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2012-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test that starpu_initialize returns ENODEV when no worker is available
+ */
+
 #if !defined(STARPU_HAVE_UNSETENV)
 #warning unsetenv is not defined. Skipping test
 int main(int argc, char **argv)

tests/errorcheck/workers_cpuid.c

@@ -19,6 +19,10 @@
 #include "../helper.h"
 #include <common/config.h>
 
+/*
+ * Try various values for STARPU_WORKERS_CPUID, checking that the
+ * expected binding does happen
+ */
 
 #if !defined(STARPU_HAVE_UNSETENV) || !defined(STARPU_USE_CPU) || !defined(STARPU_HAVE_HWLOC)
 #warning unsetenv is not defined or no cpu are available. Skipping test

tests/helper/cublas_init.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010, 2014  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test initializing cublas, and how much time that takes
+ */
+
 static double start;
 static double end;
 

tests/helper/execute_on_all.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <stdlib.h>
 #include "../helper.h"
 
+/*
+ * Test executing a function on all workers
+ */
+
 void func(void *arg)
 {
 	int *ptr = (int *) arg;

tests/helper/pinned_memory.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test calling starpu_malloc, i.e. allocating pinned memory
+ */
+
 #define NITER	10
 #define SIZE	(4*1024*1024*sizeof(float))
 

tests/helper/starpu_create_sync_task.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -19,6 +19,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test starpu_create_sync_task
+ */
+
 #define NITER	10
 
 void dummy_func(void *descr[] STARPU_ATTRIBUTE_UNUSED, void *arg STARPU_ATTRIBUTE_UNUSED)

tests/helper/starpu_data_cpy.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2012-2013  Université de Bordeaux
+ * Copyright (C) 2010, 2012-2013, 2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -17,6 +17,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test starpu_data_cpy
+ */
+
 int main(int argc, char **argv)
 {
 	int ret;

tests/main/codelet_null_callback.c

@@ -17,6 +17,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test passing a NULL codelet, but callbacks
+ */
+
 static
 void callback(void *ptr)
 {

tests/main/declare_deps_after_submission.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2011  Université de Bordeaux
+ * Copyright (C) 2010-2011, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that we can declare a dependency after submitting a non-auto-destroy task
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define NLOOPS	4
 #else

tests/main/declare_deps_after_submission_synchronous.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that we can declare a dependency after submitting a non-auto-destroy synchronous task
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define NLOOPS	4
 #else

tests/main/declare_deps_in_callback.c

@@ -1,7 +1,7 @@
 
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -22,6 +22,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that we can declare deps from the callback of the task
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define NLOOPS	4
 #else

tests/main/deploop.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2011, 2013, 2015  Université de Bordeaux
+ * Copyright (C) 2010-2011, 2013, 2015-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -15,18 +15,19 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-/*
- * Create task A and B such that
- * - B depends on A by tag dependency.
- * - A would depend on B by data dependency, but we disable that.
- */
-
 #include <stdio.h>
 #include <unistd.h>
 
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Create task A and B such that
+ * - B depends on A by tag dependency.
+ * - A would depend on B by data dependency, but we disable that by disabling
+ *   sequential consistency.
+ */
+
 void dummy_func(void *descr[] STARPU_ATTRIBUTE_UNUSED, void *arg STARPU_ATTRIBUTE_UNUSED)
 {
 	FPRINTF(stderr,"executing task %p\n", starpu_task_get_current());

tests/main/deprecated_func.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test that we support the cpu_func and where deprecated field
+ */
+
 void cpu_codelet(void *descr[], STARPU_ATTRIBUTE_UNUSED void *_args)
 {
 	int *valin = (int *)STARPU_VARIABLE_GET_PTR(descr[0]);

tests/main/empty_task.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010-2011, 2014  Université de Bordeaux
+ * Copyright (C) 2009, 2010-2011, 2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Measure the cost of a task with a NULL codelet
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 64;
 #else

tests/main/empty_task_chain.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Create a chain of tasks with NULL codelet, using manual dependencies
+ */
+
 #define N	4
 
 int main(int argc, char **argv)

tests/main/empty_task_sync_point.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test using a task with NULL codelet as a synchronization task through tag dependencies
+ */
+
 static starpu_tag_t tagA = 0x0042;
 static starpu_tag_t tagB = 0x1042;
 static starpu_tag_t tagC = 0x2042;

tests/main/empty_task_sync_point_tasks.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test using a task with NULL codelet as a synchronization task through task dependencies
+ */
+
 void dummy_func(void *descr[] STARPU_ATTRIBUTE_UNUSED, void *arg STARPU_ATTRIBUTE_UNUSED)
 {
 }

tests/main/execute_on_a_specific_worker.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010, 2012, 2015  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2012, 2015-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Test binding tasks on specific workers
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define N 100
 #else

tests/main/execute_schedule.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2014-2015  Université de Bordeaux
+ * Copyright (C) 2014-2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -22,6 +22,10 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Test binding tasks on specific workers and in a specific order
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define K 2
 #else
@@ -98,6 +102,7 @@ int main(int argc, char **argv)
 
 			task->execute_on_a_specific_worker = 1;
 			task->workerid = 0;
+			/* We request for running the tasks in the opposite order of the submission order */
 			task->workerorder = k*N + (N-n);
 			task->cl_arg = (void*) (uintptr_t) (k*N + (N-n));
 			task->handles[0] = h[n];

tests/main/get_children_tasks.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2015  Université Bordeaux
+ * Copyright (C) 2015-2016  Université Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that starpu_task_get_task_succs returns the set of children tasks
+ */
+
 void func_cpu(void *descr[], void *_args)
 {
 }

tests/main/get_current_task.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010  Université de Bordeaux
+ * Copyright (C) 2010, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Check that starpu_task_get_current provides the proper task pointer
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 64;
 #else
@@ -29,6 +33,9 @@ static unsigned ntasks = 65536;
 
 void check_task_func(void *descr[], void *arg)
 {
+	/* We check that the returned task is valid from the callback */
+	struct starpu_task *task = (struct starpu_task *) arg;
+	STARPU_ASSERT(task == starpu_task_get_current());
 }
 
 static void check_task_callback(void *arg)
@@ -43,7 +50,8 @@ static struct starpu_codelet dummy_cl =
 	.cuda_funcs = {check_task_func},
 	.cpu_funcs = {check_task_func},
 	.opencl_funcs = {check_task_func},
-	.cpu_funcs_name = {"check_task_func"},
+	/* starpu_task_get_current()) is not working on MIC */
+	/*.cpu_funcs_name = {"check_task_func"},*/
 	.model = NULL,
 	.nbuffers = 0
 };

tests/main/insert_task.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try the starpu_task_insert interface in various ways
+ */
+
 static int _ifactor = 12;
 static float _ffactor = 10.0;
 

tests/main/insert_task_array.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test STARPU_DATA_ARRAY
+ */
+
 void func_cpu(void *descr[], void *_args)
 {
 	int *x0 = (int *)STARPU_VARIABLE_GET_PTR(descr[0]);

tests/main/insert_task_dyn_handles.c

@@ -19,6 +19,11 @@
 #include <starpu_config.h>
 #include "../helper.h"
 
+/*
+ * Try the starpu_task_insert interface in various ways, and notably
+ * triggering the use of dyn_handles
+ */
+
 void func_cpu(void *descr[], void *_args)
 {
 	int num = STARPU_TASK_GET_NBUFFERS(starpu_task_get_current());

tests/main/insert_task_many.c

@@ -19,6 +19,11 @@
 #include <starpu_config.h>
 #include "../helper.h"
 
+/*
+ * Try to pass many parameters to a task, testing the various codelet
+ * declarations
+ */
+
 #define NPARAMS 15
 
 void func_cpu(void *descr[], void *_args STARPU_ATTRIBUTE_UNUSED)

tests/main/insert_task_nullcodelet.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try starpu_task_insert with a NULL codelet
+ */
+
 int main(int argc, char **argv)
 {
         int  ret;

tests/main/insert_task_value.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test passing values to tasks in different ways
+ */
+
 #define IFACTOR 42
 #define FFACTOR 12.0
 

tests/main/multithreaded.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010-2011, 2013-2014  Université de Bordeaux
+ * Copyright (C) 2009, 2010-2011, 2013-2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013  CNRS
  * Copyright (C) 2011  CNRS
  *
@@ -22,6 +22,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try submitting tasks from different threads
+ */
+
 starpu_pthread_t threads[16];
 
 #ifdef STARPU_QUICK_CHECK

tests/main/multithreaded_init.c

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2010  INRIA
- * Copyright (C) 2010-2011, 2014  Université de Bordeaux
+ * Copyright (C) 2010-2011, 2014, 2016  Université de Bordeaux
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -14,10 +14,15 @@
  *
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
+
 #include <stdio.h>
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try calling starpu_initialize from different threads in parallel
+ */
+
 #define NUM_THREADS 5
 
 int *glob_argc;

tests/main/pack.c

@@ -18,6 +18,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Test starpu_codelet_pack_args and starpu_codelet_unpack_args
+ */
+
 void func_cpu(void *descr[], void *_args)
 {
 	int factor;

tests/main/pause_resume.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010-2011, 2013-2015  Université de Bordeaux
+ * Copyright (C) 2010-2011, 2013-2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012, 2013, 2015  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -21,6 +21,10 @@
 #include <starpu.h>
 #include "../helper.h"
 
+/*
+ * Try starpu_pause/resume
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 64;
 #else

tests/main/regenerate.c

@@ -21,6 +21,11 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Run one task with regenerate=1, and thus completes several times
+ * before we reset regenerate to 0 in the callback
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 64;
 #else

tests/main/regenerate_pipeline.c

@@ -21,6 +21,10 @@
 #include "../helper.h"
 #include <common/thread.h>
 
+/*
+ * Create a pipeline of regenerated tasks, i.e. a sort of data flow graph
+ */
+
 #ifdef STARPU_QUICK_CHECK
 static unsigned ntasks = 64;
 #else

tests/main/restart.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009, 2010, 2013-2014  Université de Bordeaux
+ * Copyright (C) 2009, 2010, 2013-2014, 2016  Université de Bordeaux
  * Copyright (C) 2010, 2011, 2012  CNRS
  *
  * StarPU is free software; you can redistribute it and/or modify
@@ -23,6 +23,10 @@
 
 #include "../helper.h"
 
+/*
+ * Try initializing/shutting down starpu several times
+ */
+
 #ifdef STARPU_QUICK_CHECK
   #define N	2
 #else

tests/main/starpu_init.c

@@ -18,6 +18,10 @@
 #include "../helper.h"
 #include <stdlib.h>
 
+/*
+ * Try initializing starpu with various CPU parameters
+ */
+
 #if !defined(STARPU_HAVE_UNSETENV) || !defined(STARPU_HAVE_SETENV) || !defined(STARPU_USE_CPU)
 #warning unsetenv or setenv are not defined. Or CPU are not enabled. Skipping test
 int main(int argc, char **argv)