iPXE
sync.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <stddef.h>
27 #include <ipxe/job.h>
28 #include <ipxe/monojob.h>
29 #include <ipxe/pending.h>
30 #include <usr/sync.h>
31 
32 /** @file
33  *
34  * Wait for pending operations to complete
35  *
36  */
37 
38 /**
39  * Report progress
40  *
41  * @v intf Interface
42  * @v progress Progress report to fill in
43  * @ret ongoing_rc Ongoing job status code (if known)
44  */
45 static int sync_progress ( struct interface *intf,
46  struct job_progress *progress __unused ) {
47 
48  /* Terminate successfully if no pending operations remain */
49  if ( ! have_pending() )
50  intf_close ( intf, 0 );
51 
52  return 0;
53 }
54 
55 /** Synchroniser interface operations */
56 static struct interface_operation sync_intf_op[] = {
58 };
59 
60 /** Synchroniser interface descriptor */
63 
64 /** Synchroniser */
66 
67 /**
68  * Wait for pending operations to complete
69  *
70  * @v timeout Timeout period, in ticks (0=indefinite)
71  * @ret rc Return status code
72  */
73 int sync ( unsigned long timeout ) {
74 
75  /* Attach synchroniser and wait for completion */
77  return monojob_wait ( NULL, timeout );
78 }
An object interface operation.
Definition: interface.h:17
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition: interface.c:244
static int sync_progress(struct interface *intf, struct job_progress *progress __unused)
Report progress.
Definition: sync.c:45
int monojob_wait(const char *string, unsigned long timeout)
Wait for single foreground job to complete.
Definition: monojob.c:81
#define INTF_INIT(descriptor)
Initialise a static object interface.
Definition: interface.h:187
void intf_plug_plug(struct interface *a, struct interface *b)
Plug two object interfaces together.
Definition: interface.c:102
#define INTF_DESC_PURE(operations)
Define an object interface descriptor for a pure-interface object.
Definition: interface.h:100
static struct interface_operation sync_intf_op[]
Synchroniser interface operations.
Definition: sync.c:56
static struct interface_descriptor sync_intf_desc
Synchroniser interface descriptor.
Definition: sync.c:61
Single foreground job.
int sync(unsigned long timeout)
Wait for pending operations to complete.
Definition: sync.c:73
An object interface.
Definition: interface.h:109
struct interface monojob
Definition: monojob.c:56
static int have_pending(void)
Check if any operations are pending.
Definition: pending.h:35
An object interface descriptor.
Definition: interface.h:40
Job progress.
Definition: job.h:15
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:32
Job control interfaces.
#define __unused
Declare a variable or data structure as unused.
Definition: compiler.h:573
Pending operations.
static struct interface sync_intf
Synchroniser.
Definition: sync.c:65
Wait for pending operations to complete.
void timeout(int)
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)