| 1 | /*
|
|---|
| 2 | * Copyright (c) 2015 Michal Koutny
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | #ifndef SYSMAN_JOB_H
|
|---|
| 30 | #define SYSMAN_JOB_H
|
|---|
| 31 |
|
|---|
| 32 | #include <adt/dyn_array.h>
|
|---|
| 33 | #include <adt/list.h>
|
|---|
| 34 | #include <atomic.h>
|
|---|
| 35 | #include <stdbool.h>
|
|---|
| 36 |
|
|---|
| 37 | #include "unit.h"
|
|---|
| 38 |
|
|---|
| 39 | // TODO simplify queue states
|
|---|
| 40 | /** Run state of job */
|
|---|
| 41 | typedef enum {
|
|---|
| 42 | JOB_UNQUEUED, /**< Job not in queue yet */
|
|---|
| 43 | JOB_QUEUED,
|
|---|
| 44 | JOB_DEQUEUED, /**< Job not in queue already */
|
|---|
| 45 | JOB_RUNNING,
|
|---|
| 46 | JOB_FINISHED
|
|---|
| 47 | } job_state_t;
|
|---|
| 48 |
|
|---|
| 49 | /** Return value of job */
|
|---|
| 50 | typedef enum {
|
|---|
| 51 | JOB_OK,
|
|---|
| 52 | JOB_FAILED,
|
|---|
| 53 | JOB_UNDEFINED_ = -1
|
|---|
| 54 | } job_retval_t;
|
|---|
| 55 |
|
|---|
| 56 | struct job {
|
|---|
| 57 | link_t job_queue;
|
|---|
| 58 | atomic_t refcnt;
|
|---|
| 59 |
|
|---|
| 60 | unit_state_t target_state;
|
|---|
| 61 | unit_t *unit;
|
|---|
| 62 |
|
|---|
| 63 | /** Jobs that this job is preventing from running */
|
|---|
| 64 | dyn_array_t blocked_jobs;
|
|---|
| 65 | /** No. of jobs that must finish before this job */
|
|---|
| 66 | size_t blocking_jobs;
|
|---|
| 67 | /** Any of blocking jobs failed */
|
|---|
| 68 | bool blocking_job_failed;
|
|---|
| 69 |
|
|---|
| 70 | /** See job_state_t */
|
|---|
| 71 | job_state_t state;
|
|---|
| 72 | /** See job_retval_t */
|
|---|
| 73 | job_retval_t retval;
|
|---|
| 74 | };
|
|---|
| 75 |
|
|---|
| 76 | typedef struct job job_t;
|
|---|
| 77 | typedef job_t *job_ptr_t;
|
|---|
| 78 |
|
|---|
| 79 | extern void job_queue_init(void);
|
|---|
| 80 | extern int job_queue_add_jobs(dyn_array_t *);
|
|---|
| 81 | extern void job_queue_process(void);
|
|---|
| 82 |
|
|---|
| 83 | extern int job_create_closure(job_t *, dyn_array_t *);
|
|---|
| 84 | extern job_t *job_create(unit_t *, unit_state_t);
|
|---|
| 85 |
|
|---|
| 86 | extern void job_add_ref(job_t *);
|
|---|
| 87 | extern void job_del_ref(job_t **);
|
|---|
| 88 |
|
|---|
| 89 | extern void job_run(job_t *);
|
|---|
| 90 | extern void job_finish(job_t *);
|
|---|
| 91 | #endif
|
|---|
