2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
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 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Types used to describe the API. *)
23 type style = ret * args * optargs
24 (* The [style] is a tuple which describes the return value and
25 * arguments of a function.
27 * [ret] is the return value, one of the [R*] values below.
29 * The second element is the list of required arguments, a list of
30 * [argt]s from the list below, eg. [Bool], [String] etc. Each has
31 * a name so that for example [Int "foo"] corresponds in the C
32 * bindings to an [int foo] parameter.
34 * The third element is the list of optional arguments. These are
35 * mapped to optional arguments in the language binding, eg. in
37 * $g->fn (required1, required2, opt1 => val, opt2 => val);
38 * As the name suggests these are optional, and the function can
39 * tell which optional parameters were supplied by the caller.
41 * Only [Bool], [Int], [Int64], [String] may currently appear in
42 * the optional argument list (we may permit more types in future).
44 * ABI and API considerations
45 * --------------------------
47 * The return type and required arguments may not be changed after
48 * these have been published in a stable version of libguestfs,
49 * because doing so would break the ABI.
51 * If a published function has one or more optional arguments,
52 * then the call can be extended without breaking the ABI or API.
53 * This is in fact the only way to change an existing function.
54 * There are limitations on this:
56 * (1) you may _only_ add extra elements at the end of the list
57 * (2) you may _not_ rearrange or rename or remove existing elements
58 * (3) you may _not_ add optional arguments to a function which did
59 * not have any before (since this breaks the C ABI).
63 (* "RErr" as a return value means an int used as a simple error
64 * indication, ie. 0 or -1.
68 (* "RInt" as a return value means an int which is -1 for error
69 * or any value >= 0 on success. Only use this for smallish
70 * positive ints (0 <= i < 2^30).
74 (* "RInt64" is the same as RInt, but is guaranteed to be able
75 * to return a full 64 bit value, _except_ that -1 means error
76 * (so -1 cannot be a valid, non-error return value).
80 (* "RBool" is a bool return value which can be true/false or
85 (* "RConstString" is a string that refers to a constant value.
86 * The return value must NOT be NULL (since NULL indicates
89 * Try to avoid using this. In particular you cannot use this
90 * for values returned from the daemon, because there is no
91 * thread-safe way to return them in the C API.
93 | RConstString of string
95 (* "RConstOptString" is an even more broken version of
96 * "RConstString". The returned string may be NULL and there
97 * is no way to return an error indication. Avoid using this!
99 | RConstOptString of string
101 (* "RString" is a returned string. It must NOT be NULL, since
102 * a NULL return indicates an error. The caller frees this.
106 (* "RStringList" is a list of strings. No string in the list
107 * can be NULL. The caller frees the strings and the array.
109 | RStringList of string
111 (* "RStruct" is a function which returns a single named structure
112 * or an error indication (in C, a struct, and in other languages
113 * with varying representations, but usually very efficient). See
114 * after the function list below for the structures.
116 | RStruct of string * string (* name of retval, name of struct *)
118 (* "RStructList" is a function which returns either a list/array
119 * of structures (could be zero-length), or an error indication.
121 | RStructList of string * string (* name of retval, name of struct *)
123 (* Key-value pairs of untyped strings. Turns into a hashtable or
124 * dictionary in languages which support it. DON'T use this as a
125 * general "bucket" for results. Prefer a stronger typed return
126 * value if one is available, or write a custom struct. Don't use
127 * this if the list could potentially be very long, since it is
128 * inefficient. Keys should be unique. NULLs are not permitted.
130 | RHashtable of string
132 (* "RBufferOut" is handled almost exactly like RString, but
133 * it allows the string to contain arbitrary 8 bit data including
134 * ASCII NUL. In the C API this causes an implicit extra parameter
135 * to be added of type <size_t *size_r>. The extra parameter
136 * returns the actual size of the return buffer in bytes.
138 * Other programming languages support strings with arbitrary 8 bit
141 * At the RPC layer we have to use the opaque<> type instead of
142 * string<>. Returned data is still limited to the max message
145 | RBufferOut of string
147 and args = argt list (* Function parameters, guestfs handle is implicit. *)
150 | Bool of string (* boolean *)
151 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
152 | Int64 of string (* any 64 bit int *)
153 | String of string (* const char *name, cannot be NULL *)
154 | Device of string (* /dev device name, cannot be NULL *)
155 | Pathname of string (* file name, cannot be NULL *)
156 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
157 | OptString of string (* const char *name, may be NULL *)
158 | StringList of string(* list of strings (each string cannot be NULL) *)
159 | DeviceList of string(* list of Device names (each cannot be NULL) *)
160 (* Opaque buffer which can contain arbitrary 8 bit data.
161 * In the C API, this is expressed as <const char *, size_t> pair.
162 * Most other languages have a string type which can contain
163 * ASCII NUL. We use whatever type is appropriate for each
165 * Buffers are limited by the total message size. To transfer
166 * large blocks of data, use FileIn/FileOut parameters instead.
167 * To return an arbitrary buffer, use RBufferOut.
170 (* Key material / passphrase. Eventually we should treat this
171 * as sensitive and mlock it into physical RAM. However this
172 * is highly complex because of all the places that XDR-encoded
173 * strings can end up. So currently the only difference from
174 * 'String' is the way that guestfish requests these parameters
178 (* These are treated as filenames (simple string parameters) in
179 * the C API and bindings. But in the RPC protocol, we transfer
180 * the actual file content up to or down from the daemon.
181 * FileIn: local machine -> daemon (in request)
182 * FileOut: daemon -> local machine (in reply)
183 * In guestfish (only), the special name "-" means read from
184 * stdin or write to stdout.
188 (* This specifies an opaque pointer that is passed through
189 * untouched. Only non-daemon functions are supported.
191 * Pointer ("foo *", "bar") translates to "foo *bar" in the
192 * C API. The pointer ("bar") cannot be NULL.
194 * This is less well supported in other language bindings:
195 * if the pointer type is known then we may be able to produce
196 * a suitable binding, otherwise this is translated into a 64
199 * Functions with this parameter type are not supported at all
200 * in guestfish (the function must be declared "NotInFish" else
201 * you will get an error). Also the function cannot contain
202 * tests, although we should fix this in future.
204 | Pointer of (string * string)
206 and optargs = optargt list
209 | OBool of string (* boolean *)
210 | OInt of string (* int (smallish ints, signed, <= 31 bits) *)
211 | OInt64 of string (* any 64 bit int *)
212 | OString of string (* const char *name, cannot be NULL *)
214 type errcode = [ `CannotReturnError | `ErrorIsMinusOne | `ErrorIsNULL ]
217 | ProtocolLimitWarning (* display warning about protocol size limits *)
218 | FishAlias of string (* provide an alias for this cmd in guestfish *)
219 | FishOutput of fish_output_t (* how to display output in guestfish *)
220 | NotInFish (* do not export via guestfish *)
221 | NotInDocs (* do not add this function to documentation *)
222 | DeprecatedBy of string (* function is deprecated, use .. instead *)
223 | Optional of string (* function is part of an optional group *)
224 | Progress (* function can generate progress messages *)
227 | FishOutputOctal (* for int return, print in octal *)
228 | FishOutputHexadecimal (* for int return, print in hex *)
230 (* See guestfs(3)/EXTENDING LIBGUESTFS. *)
231 type tests = (test_init * test_prereq * test) list
233 (* Run the command sequence and just expect nothing to fail. *)
236 (* Run the command sequence and expect the output of the final
237 * command to be the string.
239 | TestOutput of seq * string
241 (* Run the command sequence and expect the output of the final
242 * command to be the list of strings.
244 | TestOutputList of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the list of block devices (could be either
248 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
249 * character of each string).
251 | TestOutputListOfDevices of seq * string list
253 (* Run the command sequence and expect the output of the final
254 * command to be the integer.
256 | TestOutputInt of seq * int
258 (* Run the command sequence and expect the output of the final
259 * command to be <op> <int>, eg. ">=", "1".
261 | TestOutputIntOp of seq * string * int
263 (* Run the command sequence and expect the output of the final
264 * command to be a true value (!= 0 or != NULL).
266 | TestOutputTrue of seq
268 (* Run the command sequence and expect the output of the final
269 * command to be a false value (== 0 or == NULL, but not an error).
271 | TestOutputFalse of seq
273 (* Run the command sequence and expect the output of the final
274 * command to be a list of the given length (but don't care about
277 | TestOutputLength of seq * int
279 (* Run the command sequence and expect the output of the final
280 * command to be a buffer (RBufferOut), ie. string + size.
282 | TestOutputBuffer of seq * string
284 (* Run the command sequence and expect the output of the final
285 * command to be a structure.
287 | TestOutputStruct of seq * test_field_compare list
289 (* Run the command sequence and expect the output of the final
290 * command to be a string which is the hex MD5 of the content of
293 | TestOutputFileMD5 of seq * string
295 (* Run the command sequence and expect the output of the final
296 * command to be a string which is a block device name (we don't
297 * check the 5th character of the string, so "/dev/sda" == "/dev/vda").
299 | TestOutputDevice of seq * string
301 (* Run the command sequence and expect a hashtable. Check
302 * one of more fields in the hashtable against known good
305 | TestOutputHashtable of seq * (string * string) list
307 (* Run the command sequence and expect the final command (only)
310 | TestLastFail of seq
312 and test_field_compare =
313 | CompareWithInt of string * int
314 | CompareWithIntOp of string * string * int
315 | CompareWithString of string * string
316 | CompareFieldsIntEq of string * string
317 | CompareFieldsStrEq of string * string
319 (* Test prerequisites. *)
321 (* Test always runs. *)
324 (* Test is currently disabled - eg. it fails, or it tests some
325 * unimplemented feature.
329 (* 'string' is some C code (a function body) that should return
330 * true or false. The test will run if the code returns true.
334 (* As for 'If' but the test runs _unless_ the code returns true. *)
337 (* Run the test only if 'string' is available in the daemon. *)
338 | IfAvailable of string
340 (* Some initial scenarios for testing. *)
342 (* Do nothing, block devices could contain random stuff including
343 * LVM PVs, and some filesystems might be mounted. This is usually
348 (* Block devices are empty and no filesystems are mounted. *)
351 (* /dev/sda contains a single partition /dev/sda1, with random
356 (* /dev/sda contains a single partition /dev/sda1, which is formatted
357 * as ext2, empty [except for lost+found] and mounted on /.
360 * Note: for testing filesystem operations, it is quicker to use
366 * /dev/sda1 (is a PV):
367 * /dev/VG/LV (size 8MB):
368 * formatted as ext2, empty [except for lost+found], mounted on /
370 * Note: only use this if you really need a freshly created filesystem
371 * on LVM. Normally you should use InitScratchFS instead.
375 (* /dev/sdd (the ISO, see images/ directory in source)
380 (* /dev/sdb1 (write scratch disk) is mounted on /. The filesystem
383 * Note that this filesystem is not recreated between tests, and
384 * could contain random files and directories from previous tests.
385 * Therefore it is recommended that you create uniquely named files
386 * and directories for your tests.
390 (* Sequence of commands for testing. *)
392 and cmd = string list
394 (* Type of an action as declared in Generator_actions module. *)
395 type action = string * style * int * flags list * tests * string * string
397 (* Field types for structures. *)
399 | FChar (* C 'char' (really, a 7 bit byte). *)
400 | FString (* nul-terminated ASCII string, NOT NULL. *)
401 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
406 | FBytes (* Any int measure that counts bytes. *)
407 | FUUID (* 32 bytes long, NOT nul-terminated. *)
408 | FOptPercent (* [0..100], or -1 meaning "not present". *)
410 (* Used for testing language bindings. *)
412 | CallString of string
413 | CallOptString of string option
414 | CallStringList of string list
418 | CallBuffer of string