source: mainline/uspace/srv/sysman/job.h@ 5a88d87

Last change on this file since 5a88d87 was 25a9fec, checked in by Matthieu Riolo <matthieu.riolo@…>, 6 years ago

sysman: Refactor job.c into job_queue.c and job_closure.c

  • Property mode set to 100644
File size: 2.7 KB
Line 
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/** Run state of job */
40typedef enum {
41 JOB_EMBRYO, /**< Job after creation */
42 JOB_CLOSURED, /**< Intermmediate when closure is evaluated */
43 JOB_PENDING, /**< Job is queued */
44 JOB_RUNNING,
45 JOB_FINISHED
46} job_state_t;
47
48/** Return value of job */
49typedef enum {
50 JOB_OK,
51 JOB_FAILED,
52 JOB_UNDEFINED_ = -1
53} job_retval_t;
54
55struct job;
56typedef struct job job_t;
57
58struct job {
59 link_t job_queue;
60 atomic_t refcnt;
61
62 unit_state_t target_state;
63 unit_t *unit;
64
65 /** Jobs that this job is preventing from running */
66 dyn_array_t blocked_jobs;
67 /** No. of jobs that the job is actually blocking (may differ from size
68 * of blocked_jobs for not fully merged job */
69 size_t blocked_jobs_count;
70 /** No. of jobs that must finish before this job */
71 size_t blocking_jobs;
72 /** Any of blocking jobs failed */
73 bool blocking_job_failed;
74 /** Job that this job was merged to */
75 job_t *merged_into;
76
77 /** See job_state_t */
78 job_state_t state;
79 /** See job_retval_t */
80 job_retval_t retval;
81};
82
83extern job_t *job_create(unit_t *, unit_state_t);
84
85extern void job_add_ref(job_t *);
86extern void job_del_ref(job_t **);
87
88extern void job_run(job_t *);
89extern void job_finish(job_t *);
90#endif
Note: See TracBrowser for help on using the repository browser.