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