浏览代码

document that the wt mask avoids eviction

Samuel Thibault 13 年之前
父节点
当前提交
99dd657704
共有 2 个文件被更改,包括 6 次插入1 次删除
  1. 2 1
      doc/chapters/basic-api.texi
  2. 4 0
      doc/chapters/perf-optimization.texi

+ 2 - 1
doc/chapters/basic-api.texi

@@ -355,7 +355,8 @@ invalidated data in read-mode results in undefined behaviour.
 
 @deftypefun void starpu_data_set_wt_mask (starpu_data_handle_t @var{handle}, uint32_t @var{wt_mask})
 This function sets the write-through mask of a given data, i.e. a bitmask of
-nodes where the data should be always replicated after modification.
+nodes where the data should be always replicated after modification. It also
+prevents the data from being evicted from these nodes when memory gets scarse.
 @end deftypefun
 
 @deftypefun int starpu_data_prefetch_on_node (starpu_data_handle_t @var{handle}, unsigned @var{node}, unsigned @var{async})

+ 4 - 0
doc/chapters/perf-optimization.texi

@@ -64,6 +64,10 @@ starpu_data_set_wt_mask(img_handle, ~0U);
 will request to always automatically broadcast the updated data to all memory
 nodes.
 
+Setting the write-through mask to @code{~0U} can also be useful to make sure all
+memory nodes always have a copy of the data, so that it is never evicted when
+memory gets scarse.
+
 @node Task granularity
 @section Task granularity