Added monojob controller in lieu of a full working shell.
[people/dverkamp/gpxe.git] / src / include / gpxe / job.h
1 #ifndef _GPXE_JOB_H
2 #define _GPXE_JOB_H
3
4 /** @file
5  *
6  * Job control interfaces
7  *
8  */
9
10 #include <stddef.h>
11 #include <gpxe/interface.h>
12
13 /** Job progress */
14 struct job_progress {
15         /** Amount of operation completed so far
16          *
17          * The units for this quantity are arbitrary.  @c completed
18          * divded by @total should give something which approximately
19          * represents the progress through the operation.  For a
20          * download operation, using byte counts would make sense.
21          */
22         unsigned long completed;
23         /** Total operation size
24          *
25          * See @c completed.  A zero value means "total size unknown"
26          * and is explcitly permitted; users should take this into
27          * account before calculating @c completed/total.
28          */
29         unsigned long total;
30 };
31
32 struct job_interface;
33
34 /** Job control interface operations */
35 struct job_interface_operations {
36         /** Job completed
37          *
38          * @v job               Job control interface
39          * @v rc                Overall job status code
40          */
41         void ( * done ) ( struct job_interface *job, int rc );
42         /** Abort job
43          *
44          * @v job               Job control interface
45          */
46         void ( * kill ) ( struct job_interface *job );
47         /** Get job progress
48          *
49          * @v job               Job control interface
50          * @v progress          Progress data to fill in
51          */
52         void ( * progress ) ( struct job_interface *job,
53                               struct job_progress *progress );
54 };
55
56 /** A job control interface */
57 struct job_interface {
58         /** Generic object communication interface */
59         struct interface intf;
60         /** Operations for received messages */
61         struct job_interface_operations *op;
62 };
63
64 extern struct job_interface null_job;
65 extern struct job_interface_operations null_job_ops;
66
67 extern void job_done ( struct job_interface *job, int rc );
68 extern void job_kill ( struct job_interface *job );
69
70 extern void ignore_job_done ( struct job_interface *job, int rc );
71 extern void ignore_job_kill ( struct job_interface *job );
72 extern void ignore_job_progress ( struct job_interface *job,
73                                   struct job_progress *progress );
74
75 /**
76  * Initialise a job control interface
77  *
78  * @v job               Job control interface
79  * @v op                Job control interface operations
80  * @v refcnt            Containing object reference counter, or NULL
81  */
82 static inline void job_init ( struct job_interface *job,
83                               struct job_interface_operations *op,
84                               struct refcnt *refcnt ) {
85         job->intf.dest = &null_job.intf;
86         job->intf.refcnt = refcnt;
87         job->op = op;
88 }
89
90 /**
91  * Get job control interface from generic object communication interface
92  *
93  * @v intf              Generic object communication interface
94  * @ret job             Job control interface
95  */
96 static inline __attribute__ (( always_inline )) struct job_interface *
97 intf_to_job ( struct interface *intf ) {
98         return container_of ( intf, struct job_interface, intf );
99 }
100
101 /**
102  * Get reference to destination job control interface
103  *
104  * @v job               Job control interface
105  * @ret dest            Destination interface
106  */
107 static inline __attribute__ (( always_inline )) struct job_interface *
108 job_get_dest ( struct job_interface *job ) {
109         return intf_to_job ( intf_get ( job->intf.dest ) );
110 }
111
112 /**
113  * Drop reference to job control interface
114  *
115  * @v job               Job control interface
116  */
117 static inline __attribute__ (( always_inline )) void
118 job_put ( struct job_interface *job ) {
119         intf_put ( &job->intf );
120 }
121
122 /**
123  * Plug a job control interface into a new destination interface
124  *
125  * @v job               Job control interface
126  * @v dest              New destination interface
127  */
128 static inline void job_plug ( struct job_interface *job,
129                                struct job_interface *dest ) {
130         plug ( &job->intf, &dest->intf );
131 }
132
133 /**
134  * Plug two job control interfaces together
135  *
136  * @v a                 Job control interface A
137  * @v b                 Job control interface B
138  */
139 static inline void job_plug_plug ( struct job_interface *a,
140                                     struct job_interface *b ) {
141         plug_plug ( &a->intf, &b->intf );
142 }
143
144 /**
145  * Unplug a job control interface
146  *
147  * @v job               Job control interface
148  */
149 static inline void job_unplug ( struct job_interface *job ) {
150         plug ( &job->intf, &null_job.intf );
151 }
152
153 /**
154  * Stop using a job control interface
155  *
156  * @v job               Job control interface
157  *
158  * After calling this method, no further messages will be received via
159  * the interface.
160  */
161 static inline void job_nullify ( struct job_interface *job ) {
162         job->op = &null_job_ops;
163 };
164
165 #endif /* _GPXE_JOB_H */