Browse Source

include: remove documentation as it is already defined elsewhere

Nathalie Furmento 12 years ago
parent
commit
4395669801
3 changed files with 2 additions and 41 deletions
  1. 1 8
      include/starpu_fxt.h
  2. 1 27
      include/starpu_scheduler.h
  3. 0 6
      sc_hypervisor/include/sc_hypervisor_policy.h

+ 1 - 8
include/starpu_fxt.h

@@ -29,7 +29,7 @@ extern "C"
 
 struct starpu_fxt_codelet_event
 {
-	char symbol[256]; /* name of the codelet */
+	char symbol[256];
 	int workerid;
 	enum starpu_perfmodel_archtype archtype;
 	uint32_t hash;
@@ -49,21 +49,14 @@ struct starpu_fxt_options
 	char *activity_path;
 	char *dag_path;
 
-	/* In case we are going to gather multiple traces (eg in the case of
-	 * MPI processes), we may need to prefix the name of the containers. */
 	char *file_prefix;
 	uint64_t file_offset;
 	int file_rank;
 
-	/*
-	 *	Output parameters
-	 */
-
 	char worker_names[STARPU_NMAXWORKERS][256];
 	enum starpu_perfmodel_archtype worker_archtypes[STARPU_NMAXWORKERS];
 	int nworkers;
 
-	/* In case we want to dump the list of codelets to an external tool */
 	struct starpu_fxt_codelet_event **dumped_codelets;
 	long dumped_codelets_count;
 };

+ 1 - 27
include/starpu_scheduler.h

@@ -57,49 +57,23 @@ int starpu_push_local_task(int workerid, struct starpu_task *task, int back);
 
 int starpu_push_task_end(struct starpu_task *task);
 
-/*
- *	Parallel tasks
- */
-
-/* Register a new combined worker and get its identifier */
 int starpu_combined_worker_assign_workerid(int nworkers, int workerid_array[]);
-/* Get the description of a combined worker */
 int starpu_combined_worker_get_description(int workerid, int *worker_size, int **combined_workerid);
-/* Variant of starpu_worker_can_execute_task compatible with combined workers */
 int starpu_combined_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl);
 
-/*
- *	Data prefetching
- */
-
-/* Whether STARPU_PREFETCH was set */
 int starpu_get_prefetch_flag(void);
-/* Prefetch data for a given task on a given node */
 int starpu_prefetch_task_input_on_node(struct starpu_task *task, unsigned node);
 
-/*
- *	Performance predictions
- */
-
-/* Returns the perfmodel footprint for the task */
 uint32_t starpu_task_footprint(struct starpu_perfmodel *model, struct starpu_task *task, enum starpu_perfmodel_archtype arch, unsigned nimpl);
-/* Returns expected task duration in us */
 double starpu_task_expected_length(struct starpu_task *task, enum starpu_perfmodel_archtype arch, unsigned nimpl);
-/* Returns an estimated speedup factor relative to CPU speed */
 double starpu_worker_get_relative_speedup(enum starpu_perfmodel_archtype perf_archtype);
-/* Returns expected data transfer time in us */
 double starpu_task_expected_data_transfer_time(unsigned memory_node, struct starpu_task *task);
-/* Predict the transfer time (in us) to move a handle to a memory node */
 double starpu_data_expected_transfer_time(starpu_data_handle_t handle, unsigned memory_node, enum starpu_data_access_mode mode);
-/* Returns expected power consumption in J */
 double starpu_task_expected_power(struct starpu_task *task, enum starpu_perfmodel_archtype arch, unsigned nimpl);
-/* Returns expected conversion time in ms (multiformat interface only) */
 double starpu_task_expected_conversion_time(struct starpu_task *task, enum starpu_perfmodel_archtype arch, unsigned nimpl);
-/* Return the expected duration of the entire task bundle in us. */
+
 double starpu_task_bundle_expected_length(starpu_task_bundle_t bundle, enum starpu_perfmodel_archtype arch, unsigned nimpl);
-/* Return the time (in us) expected to transfer all data used within the bundle */
 double starpu_task_bundle_expected_data_transfer_time(starpu_task_bundle_t bundle, unsigned memory_node);
-/* Return the expected power consumption of the entire task bundle in J. */
 double starpu_task_bundle_expected_power(starpu_task_bundle_t bundle, enum starpu_perfmodel_archtype arch, unsigned nimpl);
 
 #ifdef __cplusplus

+ 0 - 6
sc_hypervisor/include/sc_hypervisor_policy.h

@@ -28,18 +28,12 @@ extern "C"
 #define HYPERVISOR_REDIM_SAMPLE 0.02
 #define HYPERVISOR_START_REDIM_SAMPLE 0.1
 
-/* task wrapper linked list */
 struct sc_hypervisor_policy_task_pool
 {
-	/* Which codelet has been executed */
 	struct starpu_codelet *cl;
-	/* Task footprint key */
 	uint32_t footprint;
-	/* Context the task belongs to */
 	unsigned sched_ctx_id;
-	/* Number of tasks of this kind */
 	unsigned long n;
-	/* Other task kinds */
 	struct sc_hypervisor_policy_task_pool *next;
 };