Imported Upstream version 5.0.1

1 files changed, 101 insertions, 6 deletions

diff --git a/src/libstrongswan/processing/jobs/job.h b/src/libstrongswan/processing/jobs/job.h
index d25cee03e..64454718a 100644
--- a/src/libstrongswan/processing/jobs/job.h
+++ b/src/libstrongswan/processing/jobs/job.h
@@ -1,4 +1,5 @@
 /*
+ * Copyright (C) 2012 Tobias Brunner
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
@@ -24,6 +25,9 @@
 
 typedef struct job_t job_t;
 typedef enum job_priority_t job_priority_t;
+typedef enum job_status_t job_status_t;
+typedef enum job_requeue_type_t job_requeue_type_t;
+typedef struct job_requeue_t job_requeue_t;
 
 #include <library.h>
 
@@ -48,18 +52,107 @@ enum job_priority_t {
 extern enum_name_t *job_priority_names;
 
 /**
+ * Job status
+ */
+enum job_status_t {
+	/** The job is queued and has not yet been executed */
+	JOB_STATUS_QUEUED = 0,
+	/** During execution */
+	JOB_STATUS_EXECUTING,
+	/** If the job got canceled */
+	JOB_STATUS_CANCELED,
+	/** The job was executed successfully */
+	JOB_STATUS_DONE,
+};
+
+/**
+ * How a job is handled after is has been executed.
+ */
+enum job_requeue_type_t {
+	/** Do not requeue job, destroy it */
+	JOB_REQUEUE_TYPE_NONE = 0,
+	/** Requeue the job fairly, i.e. it is inserted at the end of the queue */
+	JOB_REQUEUE_TYPE_FAIR,
+	/** Reexecute the job directly, without the need of requeueing it */
+	JOB_REQUEUE_TYPE_DIRECT,
+	/** Rescheduled the job via scheduler_t */
+	JOB_REQUEUE_TYPE_SCHEDULE,
+};
+
+/**
+ * Job requeueing policy.
+ *
+ * The job requeueing policy defines how a job is handled after it has been
+ * executed.
+ */
+struct job_requeue_t {
+	/** How to handle the job after executing it */
+	job_requeue_type_t type;
+	/** How to reschedule the job, if so */
+	enum {
+		JOB_SCHEDULE,
+		JOB_SCHEDULE_MS,
+		JOB_SCHEDULE_TV,
+	} schedule;
+	/** Time to reschedule the job */
+	union {
+		u_int32_t rel;
+		timeval_t abs;
+	} time;
+};
+
+/**
+ * Helper macros to easily define requeueing policies.
+ */
+#define __JOB_REQUEUE(t)			(job_requeue_t){ .type = t }
+#define JOB_REQUEUE_NONE			__JOB_REQUEUE(JOB_REQUEUE_TYPE_NONE)
+#define JOB_REQUEUE_FAIR			__JOB_REQUEUE(JOB_REQUEUE_TYPE_FAIR)
+#define JOB_REQUEUE_DIRECT			__JOB_REQUEUE(JOB_REQUEUE_TYPE_DIRECT)
+#define __JOB_RESCHEDULE(t, ...)	(job_requeue_t){ .type = JOB_REQUEUE_TYPE_SCHEDULE, .schedule = t, { __VA_ARGS__ } }
+#define JOB_RESCHEDULE(s)			__JOB_RESCHEDULE(JOB_SCHEDULE, .rel = s)
+#define JOB_RESCHEDULE_MS(ms)		__JOB_RESCHEDULE(JOB_SCHEDULE_MS, .rel = ms)
+#define JOB_RESCHEDULE_TV(tv)		__JOB_RESCHEDULE(JOB_SCHEDULE_TV, .abs = tv)
+
+/**
  * Job interface as it is stored in the job queue.
  */
 struct job_t {
 
 	/**
+	 * Status of this job, is modified exclusively by the processor/scheduler
+	 */
+	job_status_t status;
+
+	/**
 	 * Execute a job.
 	 *
 	 * The processing facility executes a job using this method. Jobs are
-	 * one-shot, they destroy themself after execution, so don't use a job
-	 * once it has been executed.
+	 * one-shot, they are destroyed after execution (depending on the return
+	 * value here), so don't use a job once it has been queued.
+	 *
+	 * @return			policy how to requeue the job
+	 */
+	job_requeue_t (*execute) (job_t *this);
+
+	/**
+	 * Cancel a job.
+	 *
+	 * Implementing this method is optional.  It allows potentially blocking
+	 * jobs to be canceled during shutdown.
+	 *
+	 * If no special action is to be taken simply return FALSE then the thread
+	 * executing the job will be canceled.  If TRUE is returned the job is
+	 * expected to return from execute() itself (i.e. the thread won't be
+	 * canceled explicitly and can still be joined later).
+	 * Jobs that return FALSE have to make sure they provide the appropriate
+	 * cancellation points.
+	 *
+	 * @note Regular jobs that do not block MUST NOT implement this method.
+	 * @note This method could be called even before execute() has been called.
+	 *
+	 * @return			FALSE to cancel the thread, TRUE if canceled otherwise
 	 */
-	void (*execute) (job_t *this);
+	bool (*cancel)(job_t *this);
 
 	/**
 	 * Get the priority of a job.
@@ -71,10 +164,12 @@ struct job_t {
 	/**
 	 * Destroy a job.
 	 *
-	 * Is only called whenever a job was not executed (e.g. due daemon shutdown).
-	 * After execution, jobs destroy themself.
+	 * Is called after a job is executed or got canceled.  It is also called
+	 * for queued jobs that were never executed.
+	 *
+	 * Use the status of a job to decide what to do during destruction.
 	 */
-	void (*destroy) (job_t *this);
+	void (*destroy)(job_t *this);
 };
 
 #endif /** JOB_H_ @}*/