2b33408fa56db7c885c0623a0ff84d7d5bb66521
[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         /** Start job
37          *
38          * @v job               Job control interface
39          */
40         void ( * start ) ( struct job_interface *job );
41         /** Job completed
42          *
43          * @v job               Job control interface
44          * @v rc                Overall job status code
45          */
46         void ( * done ) ( struct job_interface *job, int rc );
47         /** Abort job
48          *
49          * @v job               Job control interface
50          */
51         void ( * kill ) ( struct job_interface *job );
52         /** Get job progress
53          *
54          * @v job               Job control interface
55          * @v progress          Progress data to fill in
56          */
57         void ( * progress ) ( struct job_interface *job,
58                               struct job_progress *progress );
59 };
60
61 /** A job control interface */
62 struct job_interface {
63         /** Generic object communication interface */
64         struct interface intf;
65         /** Operations for received messages */
66         struct job_interface_operations *op;
67 };
68
69 extern struct job_interface null_job;
70 extern struct job_interface_operations null_job_ops;
71
72 extern void job_done ( struct job_interface *job, int rc );
73
74 extern void ignore_job_start ( struct job_interface *job );
75 extern void ignore_job_done ( struct job_interface *job, int rc );
76 extern void ignore_job_kill ( struct job_interface *job );
77 extern void ignore_job_progress ( struct job_interface *job,
78                                   struct job_progress *progress );
79
80 /**
81  * Initialise a job control interface
82  *
83  * @v job               Job control interface
84  * @v op                Job control interface operations
85  * @v refcnt            Containing object reference counter, or NULL
86  */
87 static inline void job_init ( struct job_interface *job,
88                               struct job_interface_operations *op,
89                               struct refcnt *refcnt ) {
90         job->intf.dest = &null_job.intf;
91         job->intf.refcnt = refcnt;
92         job->op = op;
93 }
94
95 /**
96  * Get job control interface from generic object communication interface
97  *
98  * @v intf              Generic object communication interface
99  * @ret job             Job control interface
100  */
101 static inline __attribute__ (( always_inline )) struct job_interface *
102 intf_to_job ( struct interface *intf ) {
103         return container_of ( intf, struct job_interface, intf );
104 }
105
106 /**
107  * Get destination job control interface
108  *
109  * @v job               Job control interface
110  * @ret dest            Destination interface
111  */
112 static inline __attribute__ (( always_inline )) struct job_interface *
113 job_dest ( struct job_interface *job ) {
114         return intf_to_job ( job->intf.dest );
115 }
116
117 /**
118  * Plug a job control interface into a new destination interface
119  *
120  * @v job               Job control interface
121  * @v dest              New destination interface
122  */
123 static inline void job_plug ( struct job_interface *job,
124                                struct job_interface *dest ) {
125         plug ( &job->intf, &dest->intf );
126 }
127
128 /**
129  * Plug two job control interfaces together
130  *
131  * @v a                 Job control interface A
132  * @v b                 Job control interface B
133  */
134 static inline void job_plug_plug ( struct job_interface *a,
135                                     struct job_interface *b ) {
136         plug_plug ( &a->intf, &b->intf );
137 }
138
139 /**
140  * Unplug a job control interface
141  *
142  * @v job               Job control interface
143  */
144 static inline void job_unplug ( struct job_interface *job ) {
145         plug ( &job->intf, &null_job.intf );
146 }
147
148 /**
149  * Stop using a job control interface
150  *
151  * @v job               Job control interface
152  *
153  * After calling this method, no further messages will be received via
154  * the interface.
155  */
156 static inline void job_nullify ( struct job_interface *job ) {
157         job->op = &null_job_ops;
158 };
159
160 #endif /* _GPXE_JOB_H */