Minimalist documentation of headers in src/datawizard/

src/datawizard/footprint.h

@@ -21,7 +21,11 @@
 #include <common/config.h>
 #include <core/jobs.h>
 
+/* Compute the footprint that characterizes the job and cache it into the job
+ * structure. */
 void _starpu_compute_buffers_footprint(struct starpu_job_s *j);
+
+/* Compute the footprint that characterizes the layout of the data handle. */
 uint32_t _starpu_compute_data_footprint(starpu_data_handle handle);
 
 #endif // __FOOTPRINT_H__

src/datawizard/sort_data_handles.h

@@ -25,6 +25,9 @@
 #include <datawizard/coherency.h>
 #include <datawizard/memalloc.h>
 
+/* To avoid deadlocks, we reorder the different buffers accessed to by the task
+ * so that we always grab the rw-lock associated to the handles in the same
+ * order. */
 void _starpu_sort_task_handles(starpu_buffer_descr descr[], unsigned nbuffers);
 
 #endif // SORT_DATA_HANDLES

src/datawizard/write_back.h

@@ -20,6 +20,9 @@
 #include <starpu.h>
 #include <datawizard/coherency.h>
 
+/* If a write-through mask is associated to that data handle, this propagates
+ * the the current value of the data onto the different memory nodes in the
+ * write_through_mask. */
 void _starpu_write_through_data(starpu_data_handle handle, uint32_t requesting_node, 
 					   uint32_t write_through_mask);