err.h@ 17371

Last change on this file since 17371 was 17091, checked in by vboxsync, 16 years ago
RTGetOpt interface changes.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.3 KB

Line
1	/** @file
2	* IPRT - Status Codes.
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*
25	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___iprt_err_h
31	#define ___iprt_err_h
32
33	#include <iprt/cdefs.h>
34	#include <iprt/types.h>
35
36	__BEGIN_DECLS
37
38	/** @defgroup grp_rt_err RTErr - Status Codes
39	* @ingroup grp_rt
40	* @{
41	*/
42
43	/** @defgroup grp_rt_err_hlp Status Code Helpers
44	* @ingroup grp_rt_err
45	* @{
46	*/
47
48	/** @def RT_SUCCESS
49	* Check for success. We expect success in normal cases, that is the code path depending on
50	* this check is normally taken. To prevent any prediction use RT_SUCCESS_NP instead.
51	*
52	* @returns true if rc indicates success.
53	* @returns false if rc indicates failure.
54	*
55	* @param rc The iprt status code to test.
56	*/
57	#define RT_SUCCESS(rc) ( RT_LIKELY((int)(rc) >= VINF_SUCCESS) )
58
59	/** @def RT_SUCCESS_NP
60	* Check for success. Don't predict the result.
61	*
62	* @returns true if rc indicates success.
63	* @returns false if rc indicates failure.
64	*
65	* @param rc The iprt status code to test.
66	*/
67	#define RT_SUCCESS_NP(rc) ( (int)(rc) >= VINF_SUCCESS )
68
69	/** @def RT_FAILURE
70	* Check for failure. We don't expect in normal cases, that is the code path depending on
71	* this check is normally NOT taken. To prevent any prediction use RT_FAILURE_NP instead.
72	*
73	* @returns true if rc indicates failure.
74	* @returns false if rc indicates success.
75	*
76	* @param rc The iprt status code to test.
77	*/
78	#define RT_FAILURE(rc) ( RT_UNLIKELY(!RT_SUCCESS_NP(rc)) )
79
80	/** @def RT_FAILURE_NP
81	* Check for failure. Don't predict the result.
82	*
83	* @returns true if rc indicates failure.
84	* @returns false if rc indicates success.
85	*
86	* @param rc The iprt status code to test.
87	*/
88	#define RT_FAILURE_NP(rc) ( !RT_SUCCESS_NP(rc) )
89
90	/**
91	* Converts a Darwin HRESULT error to an iprt status code.
92	*
93	* @returns iprt status code.
94	* @param iNativeCode HRESULT error code.
95	* @remark Darwin ring-3 only.
96	*/
97	RTDECL(int) RTErrConvertFromDarwinCOM(int32_t iNativeCode);
98
99	/**
100	* Converts a Darwin IOReturn error to an iprt status code.
101	*
102	* @returns iprt status code.
103	* @param iNativeCode IOReturn error code.
104	* @remark Darwin only.
105	*/
106	RTDECL(int) RTErrConvertFromDarwinIO(int iNativeCode);
107
108	/**
109	* Converts a Darwin kern_return_t error to an iprt status code.
110	*
111	* @returns iprt status code.
112	* @param iNativeCode kern_return_t error code.
113	* @remark Darwin only.
114	*/
115	RTDECL(int) RTErrConvertFromDarwinKern(int iNativeCode);
116
117	/**
118	* Converts a Darwin error to an iprt status code.
119	*
120	* This will consult RTErrConvertFromDarwinKern, RTErrConvertFromDarwinIO
121	* and RTErrConvertFromDarwinCOM in this order. The latter is ring-3 only as it
122	* doesn't apply elsewhere.
123	*
124	* @returns iprt status code.
125	* @param iNativeCode Darwin error code.
126	* @remarks Darwin only.
127	* @remarks This is recommended over RTErrConvertFromDarwinKern and RTErrConvertFromDarwinIO
128	* since these are really just subsets of the same error space.
129	*/
130	RTDECL(int) RTErrConvertFromDarwin(int iNativeCode);
131
132	/**
133	* Converts errno to iprt status code.
134	*
135	* @returns iprt status code.
136	* @param uNativeCode errno code.
137	*/
138	RTDECL(int) RTErrConvertFromErrno(unsigned uNativeCode);
139
140	/**
141	* Converts a L4 errno to a iprt status code.
142	*
143	* @returns iprt status code.
144	* @param uNativeCode l4 errno.
145	* @remark L4 only.
146	*/
147	RTDECL(int) RTErrConvertFromL4Errno(unsigned uNativeCode);
148
149	/**
150	* Converts NT status code to iprt status code.
151	*
152	* Needless to say, this is only available on NT and winXX targets.
153	*
154	* @returns iprt status code.
155	* @param lNativeCode NT status code.
156	* @remark Windows only.
157	*/
158	RTDECL(int) RTErrConvertFromNtStatus(long lNativeCode);
159
160	/**
161	* Converts OS/2 error code to iprt status code.
162	*
163	* @returns iprt status code.
164	* @param uNativeCode OS/2 error code.
165	* @remark OS/2 only.
166	*/
167	RTDECL(int) RTErrConvertFromOS2(unsigned uNativeCode);
168
169	/**
170	* Converts Win32 error code to iprt status code.
171	*
172	* @returns iprt status code.
173	* @param uNativeCode Win32 error code.
174	* @remark Windows only.
175	*/
176	RTDECL(int) RTErrConvertFromWin32(unsigned uNativeCode);
177
178	/**
179	* Converts an iprt status code to a errno status code.
180	*
181	* @returns errno status code.
182	* @param iErr iprt status code.
183	*/
184	RTDECL(int) RTErrConvertToErrno(int iErr);
185
186
187	#ifdef IN_RING3
188
189	/**
190	* iprt status code message.
191	*/
192	typedef struct RTSTATUSMSG
193	{
194	/** Pointer to the short message string. */
195	const char *pszMsgShort;
196	/** Pointer to the full message string. */
197	const char *pszMsgFull;
198	/** Pointer to the define string. */
199	const char *pszDefine;
200	/** Status code number. */
201	int iCode;
202	} RTSTATUSMSG;
203	/** Pointer to iprt status code message. */
204	typedef RTSTATUSMSG *PRTSTATUSMSG;
205	/** Pointer to const iprt status code message. */
206	typedef const RTSTATUSMSG *PCRTSTATUSMSG;
207
208	/**
209	* Get the message structure corresponding to a given iprt status code.
210	*
211	* @returns Pointer to read-only message description.
212	* @param rc The status code.
213	*/
214	RTDECL(PCRTSTATUSMSG) RTErrGet(int rc);
215
216	/**
217	* Get the define corresponding to a given iprt status code.
218	*
219	* @returns Pointer to read-only string with the \#define identifier.
220	* @param rc The status code.
221	*/
222	#define RTErrGetDefine(rc) (RTErrGet(rc)->pszDefine)
223
224	/**
225	* Get the short description corresponding to a given iprt status code.
226	*
227	* @returns Pointer to read-only string with the description.
228	* @param rc The status code.
229	*/
230	#define RTErrGetShort(rc) (RTErrGet(rc)->pszMsgShort)
231
232	/**
233	* Get the full description corresponding to a given iprt status code.
234	*
235	* @returns Pointer to read-only string with the description.
236	* @param rc The status code.
237	*/
238	#define RTErrGetFull(rc) (RTErrGet(rc)->pszMsgFull)
239
240	#ifdef RT_OS_WINDOWS
241	/**
242	* Windows error code message.
243	*/
244	typedef struct RTWINERRMSG
245	{
246	/** Pointer to the full message string. */
247	const char *pszMsgFull;
248	/** Pointer to the define string. */
249	const char *pszDefine;
250	/** Error code number. */
251	long iCode;
252	} RTWINERRMSG;
253	/** Pointer to Windows error code message. */
254	typedef RTWINERRMSG *PRTWINERRMSG;
255	/** Pointer to const Windows error code message. */
256	typedef const RTWINERRMSG *PCRTWINERRMSG;
257
258	/**
259	* Get the message structure corresponding to a given Windows error code.
260	*
261	* @returns Pointer to read-only message description.
262	* @param rc The status code.
263	*/
264	RTDECL(PCRTWINERRMSG) RTErrWinGet(long rc);
265
266	/** On windows COM errors are part of the Windows error database. */
267	typedef RTWINERRMSG RTCOMERRMSG;
268
269	#else /* !RT_OS_WINDOWS */
270
271	/**
272	* COM/XPCOM error code message.
273	*/
274	typedef struct RTCOMERRMSG
275	{
276	/** Pointer to the full message string. */
277	const char *pszMsgFull;
278	/** Pointer to the define string. */
279	const char *pszDefine;
280	/** Error code number. */
281	uint32_t iCode;
282	} RTCOMERRMSG;
283	#endif /* !RT_OS_WINDOWS */
284	/** Pointer to a XPCOM/COM error code message. */
285	typedef RTCOMERRMSG *PRTCOMERRMSG;
286	/** Pointer to const a XPCOM/COM error code message. */
287	typedef const RTCOMERRMSG *PCRTCOMERRMSG;
288
289	/**
290	* Get the message structure corresponding to a given COM/XPCOM error code.
291	*
292	* @returns Pointer to read-only message description.
293	* @param rc The status code.
294	*/
295	RTDECL(PCRTCOMERRMSG) RTErrCOMGet(uint32_t rc);
296
297	#endif /* IN_RING3 */
298
299	/** @} */
300
301
302	/* SED-START */
303
304	/** @name Misc. Status Codes
305	* @{
306	*/
307	/** Success. */
308	#define VINF_SUCCESS 0
309
310	/** General failure - DON'T USE THIS!!! */
311	#define VERR_GENERAL_FAILURE (-1)
312	/** Invalid parameter. */
313	#define VERR_INVALID_PARAMETER (-2)
314	/** Invalid parameter. */
315	#define VWRN_INVALID_PARAMETER 2
316	/** Invalid magic or cookie. */
317	#define VERR_INVALID_MAGIC (-3)
318	/** Invalid magic or cookie. */
319	#define VWRN_INVALID_MAGIC 3
320	/** Invalid loader handle. */
321	#define VERR_INVALID_HANDLE (-4)
322	/** Invalid loader handle. */
323	#define VWRN_INVALID_HANDLE 4
324	/** Failed to lock the address range. */
325	#define VERR_LOCK_FAILED (-5)
326	/** Invalid memory pointer. */
327	#define VERR_INVALID_POINTER (-6)
328	/** Failed to patch the IDT. */
329	#define VERR_IDT_FAILED (-7)
330	/** Memory allocation failed. */
331	#define VERR_NO_MEMORY (-8)
332	/** Already loaded. */
333	#define VERR_ALREADY_LOADED (-9)
334	/** Permission denied. */
335	#define VERR_PERMISSION_DENIED (-10)
336	/** Version mismatch. */
337	#define VERR_VERSION_MISMATCH (-11)
338	/** The request function is not implemented. */
339	#define VERR_NOT_IMPLEMENTED (-12)
340
341	/** Failed to allocate temporary memory. */
342	#define VERR_NO_TMP_MEMORY (-20)
343	/** Invalid file mode mask (RTFMODE). */
344	#define VERR_INVALID_FMODE (-21)
345	/** Incorrect call order. */
346	#define VERR_WRONG_ORDER (-22)
347	/** There is no TLS (thread local storage) available for storing the current thread. */
348	#define VERR_NO_TLS_FOR_SELF (-23)
349	/** Failed to set the TLS (thread local storage) entry which points to our thread structure. */
350	#define VERR_FAILED_TO_SET_SELF_TLS (-24)
351	/** Not able to allocate contiguous memory. */
352	#define VERR_NO_CONT_MEMORY (-26)
353	/** No memory available for page table or page directory. */
354	#define VERR_NO_PAGE_MEMORY (-27)
355	/** Already initialized. */
356	#define VINF_ALREADY_INITIALIZED 28
357	/** The specified thread is dead. */
358	#define VERR_THREAD_IS_DEAD (-29)
359	/** The specified thread is not waitable. */
360	#define VERR_THREAD_NOT_WAITABLE (-30)
361	/** Pagetable not present. */
362	#define VERR_PAGE_TABLE_NOT_PRESENT (-31)
363	/** Internal error - we're screwed if this happens. */
364	#define VERR_INTERNAL_ERROR (-32)
365	/** The per process timer is busy. */
366	#define VERR_TIMER_BUSY (-33)
367	/** Address conflict. */
368	#define VERR_ADDRESS_CONFLICT (-34)
369	/** Unresolved (unknown) host platform error. */
370	#define VERR_UNRESOLVED_ERROR (-35)
371	/** Invalid function. */
372	#define VERR_INVALID_FUNCTION (-36)
373	/** Not supported. */
374	#define VERR_NOT_SUPPORTED (-37)
375	/** Access denied. */
376	#define VERR_ACCESS_DENIED (-38)
377	/** Call interrupted. */
378	#define VERR_INTERRUPTED (-39)
379	/** Timeout. */
380	#define VERR_TIMEOUT (-40)
381	/** Buffer too small to save result. */
382	#define VERR_BUFFER_OVERFLOW (-41)
383	/** Buffer too small to save result. */
384	#define VINF_BUFFER_OVERFLOW 41
385	/** Data size overflow. */
386	#define VERR_TOO_MUCH_DATA (-42)
387	/** Max threads number reached. */
388	#define VERR_MAX_THRDS_REACHED (-43)
389	/** Max process number reached. */
390	#define VERR_MAX_PROCS_REACHED (-44)
391	/** The recipient process has refused the signal. */
392	#define VERR_SIGNAL_REFUSED (-45)
393	/** A signal is already pending. */
394	#define VERR_SIGNAL_PENDING (-46)
395	/** The signal being posted is not correct. */
396	#define VERR_SIGNAL_INVALID (-47)
397	/** The state changed.
398	* This is a generic error message and needs a context to make sense. */
399	#define VERR_STATE_CHANGED (-48)
400	/** Warning, the state changed.
401	* This is a generic error message and needs a context to make sense. */
402	#define VWRN_STATE_CHANGED 48
403	/** Error while parsing UUID string */
404	#define VERR_INVALID_UUID_FORMAT (-49)
405	/** The specified process was not found. */
406	#define VERR_PROCESS_NOT_FOUND (-50)
407	/** The process specified to a non-block wait had not exitted. */
408	#define VERR_PROCESS_RUNNING (-51)
409	/** Retry the operation. */
410	#define VERR_TRY_AGAIN (-52)
411	/** Retry the operation. */
412	#define VINF_TRY_AGAIN 52
413	/** Generic parse error. */
414	#define VERR_PARSE_ERROR (-53)
415	/** Value out of range. */
416	#define VERR_OUT_OF_RANGE (-54)
417	/** A numeric convertion encountered a value which was too big for the target. */
418	#define VERR_NUMBER_TOO_BIG (-55)
419	/** A numeric convertion encountered a value which was too big for the target. */
420	#define VWRN_NUMBER_TOO_BIG 55
421	/** The number begin converted (string) contained no digits. */
422	#define VERR_NO_DIGITS (-56)
423	/** The number begin converted (string) contained no digits. */
424	#define VWRN_NO_DIGITS 56
425	/** Encountered a '-' during convertion to an unsigned value. */
426	#define VERR_NEGATIVE_UNSIGNED (-57)
427	/** Encountered a '-' during convertion to an unsigned value. */
428	#define VWRN_NEGATIVE_UNSIGNED 57
429	/** Error while characters translation (unicode and so). */
430	#define VERR_NO_TRANSLATION (-58)
431	/** Encountered unicode code point which is reserved for use as endian indicator (0xffff or 0xfffe). */
432	#define VERR_CODE_POINT_ENDIAN_INDICATOR (-59)
433	/** Encountered unicode code point in the surrogate range (0xd800 to 0xdfff). */
434	#define VERR_CODE_POINT_SURROGATE (-60)
435	/** A string claiming to be UTF-8 is incorrectly encoded. */
436	#define VERR_INVALID_UTF8_ENCODING (-61)
437	/** Ad string claiming to be in UTF-16 is incorrectly encoded. */
438	#define VERR_INVALID_UTF16_ENCODING (-62)
439	/** Encountered a unicode code point which cannot be represented as UTF-16. */
440	#define VERR_CANT_RECODE_AS_UTF16 (-63)
441	/** Got an out of memory condition trying to allocate a string. */
442	#define VERR_NO_STR_MEMORY (-64)
443	/** Got an out of memory condition trying to allocate a UTF-16 (/UCS-2) string. */
444	#define VERR_NO_UTF16_MEMORY (-65)
445	/** Get an out of memory condition trying to allocate a code point array. */
446	#define VERR_NO_CODE_POINT_MEMORY (-66)
447	/** Can't free the memory because it's used in mapping. */
448	#define VERR_MEMORY_BUSY (-67)
449	/** The timer can't be started because it's already active. */
450	#define VERR_TIMER_ACTIVE (-68)
451	/** The timer can't be stopped because i's already suspended. */
452	#define VERR_TIMER_SUSPENDED (-69)
453	/** The operation was cancelled by the user (copy) or another thread (local ipc). */
454	#define VERR_CANCELLED (-70)
455	/** Failed to initialize a memory object.
456	* Exactly what this means is OS specific. */
457	#define VERR_MEMOBJ_INIT_FAILED (-71)
458	/** Out of memory condition when allocating memory with low physical backing. */
459	#define VERR_NO_LOW_MEMORY (-72)
460	/** Out of memory condition when allocating physical memory (without mapping). */
461	#define VERR_NO_PHYS_MEMORY (-73)
462	/** The address (virtual or physical) is too big. */
463	#define VERR_ADDRESS_TOO_BIG (-74)
464	/** Failed to map a memory object. */
465	#define VERR_MAP_FAILED (-75)
466	/** Trailing characters. */
467	#define VERR_TRAILING_CHARS (-76)
468	/** Trailing characters. */
469	#define VWRN_TRAILING_CHARS 76
470	/** Trailing spaces. */
471	#define VERR_TRAILING_SPACES (-77)
472	/** Trailing spaces. */
473	#define VWRN_TRAILING_SPACES 77
474	/** Generic not found error. */
475	#define VERR_NOT_FOUND (-78)
476	/** Generic not found warning. */
477	#define VWRN_NOT_FOUND 78
478	/** Generic invalid state error. */
479	#define VERR_INVALID_STATE (-79)
480	/** Generic invalid state warning. */
481	#define VWRN_INVALID_STATE 79
482	/** Generic out of resources error. */
483	#define VERR_OUT_OF_RESOURCES (-80)
484	/** Generic out of resources warning. */
485	#define VWRN_OUT_OF_RESOURCES 80
486	/** No more handles available, too many open handles. */
487	#define VERR_NO_MORE_HANDLES (-81)
488	/** Preemption is disabled.
489	* The requested operation can only be performed when preemption is enabled. */
490	#define VERR_PREEMPT_DISABLED (-82)
491	/** End of string. */
492	#define VERR_END_OF_STRING (-83)
493	/** End of string. */
494	#define VINF_END_OF_STRING 83
495	/** A page count is ouf of range. */
496	#define VERR_PAGE_COUNT_OUT_OF_RANGE (-84)
497	/** Generic object destroyed status. */
498	#define VERR_OBJECT_DESTROYED (-85)
499	/** Generic object was destroyed by the call status. */
500	#define VINF_OBJECT_DESTROYED 85
501	/** Generic dangling objects status. */
502	#define VERR_DANGLING_OBJECTS (-86)
503	/** Generic dangling objects status. */
504	#define VWRN_DANGLING_OBJECTS 86
505	/** Invalid Base64 encoding. */
506	#define VERR_INVALID_BASE64_ENCODING (-87)
507	/** @} */
508
509
510	/** @name Common File/Disk/Pipe/etc Status Codes
511	* @{
512	*/
513	/** Unresolved (unknown) file i/o error. */
514	#define VERR_FILE_IO_ERROR (-100)
515	/** File/Device open failed. */
516	#define VERR_OPEN_FAILED (-101)
517	/** File not found. */
518	#define VERR_FILE_NOT_FOUND (-102)
519	/** Path not found. */
520	#define VERR_PATH_NOT_FOUND (-103)
521	/** Invalid (malformed) file/path name. */
522	#define VERR_INVALID_NAME (-104)
523	/** File/Device already exists. */
524	#define VERR_ALREADY_EXISTS (-105)
525	/** Too many open files. */
526	#define VERR_TOO_MANY_OPEN_FILES (-106)
527	/** Seek error. */
528	#define VERR_SEEK (-107)
529	/** Seek below file start. */
530	#define VERR_NEGATIVE_SEEK (-108)
531	/** Trying to seek on device. */
532	#define VERR_SEEK_ON_DEVICE (-109)
533	/** Reached the end of the file. */
534	#define VERR_EOF (-110)
535	/** Reached the end of the file. */
536	#define VINF_EOF 110
537	/** Generic file read error. */
538	#define VERR_READ_ERROR (-111)
539	/** Generic file write error. */
540	#define VERR_WRITE_ERROR (-112)
541	/** Write protect error. */
542	#define VERR_WRITE_PROTECT (-113)
543	/** Sharing violation, file is being used by another process. */
544	#define VERR_SHARING_VIOLATION (-114)
545	/** Unable to lock a region of a file. */
546	#define VERR_FILE_LOCK_FAILED (-115)
547	/** File access error, another process has locked a portion of the file. */
548	#define VERR_FILE_LOCK_VIOLATION (-116)
549	/** File or directory can't be created. */
550	#define VERR_CANT_CREATE (-117)
551	/** Directory can't be deleted. */
552	#define VERR_CANT_DELETE_DIRECTORY (-118)
553	/** Can't move file to another disk. */
554	#define VERR_NOT_SAME_DEVICE (-119)
555	/** The filename or extension is too long. */
556	#define VERR_FILENAME_TOO_LONG (-120)
557	/** Media not present in drive. */
558	#define VERR_MEDIA_NOT_PRESENT (-121)
559	/** The type of media was not recognized. Not formatted? */
560	#define VERR_MEDIA_NOT_RECOGNIZED (-122)
561	/** Can't unlock - region was not locked. */
562	#define VERR_FILE_NOT_LOCKED (-123)
563	/** Unrecoverable error: lock was lost. */
564	#define VERR_FILE_LOCK_LOST (-124)
565	/** Can't delete directory with files. */
566	#define VERR_DIR_NOT_EMPTY (-125)
567	/** A directory operation was attempted on a non-directory object. */
568	#define VERR_NOT_A_DIRECTORY (-126)
569	/** A non-directory operation was attempted on a directory object. */
570	#define VERR_IS_A_DIRECTORY (-127)
571	/** Tried to grow a file beyond the limit imposed by the process or the filesystem. */
572	#define VERR_FILE_TOO_BIG (-128)
573	/** @} */
574
575
576	/** @name Generic Filesystem I/O Status Codes
577	* @{
578	*/
579	/** Unresolved (unknown) disk i/o error. */
580	#define VERR_DISK_IO_ERROR (-150)
581	/** Invalid drive number. */
582	#define VERR_INVALID_DRIVE (-151)
583	/** Disk is full. */
584	#define VERR_DISK_FULL (-152)
585	/** Disk was changed. */
586	#define VERR_DISK_CHANGE (-153)
587	/** Drive is locked. */
588	#define VERR_DRIVE_LOCKED (-154)
589	/** The specified disk or diskette cannot be accessed. */
590	#define VERR_DISK_INVALID_FORMAT (-155)
591	/** Too many symbolic links. */
592	#define VERR_TOO_MANY_SYMLINKS (-156)
593	/** @} */
594
595
596	/** @name Generic Directory Enumeration Status Codes
597	* @{
598	*/
599	/** Unresolved (unknown) search error. */
600	#define VERR_SEARCH_ERROR (-200)
601	/** No more files found. */
602	#define VERR_NO_MORE_FILES (-201)
603	/** No more search handles available. */
604	#define VERR_NO_MORE_SEARCH_HANDLES (-202)
605	/** RTDirReadEx() failed to retrieve the extra data which was requested. */
606	#define VWRN_NO_DIRENT_INFO 203
607	/** @} */
608
609
610	/** @name Generic Device I/O Status Codes
611	* @{
612	*/
613	/** Unresolved (unknown) device i/o error. */
614	#define VERR_DEV_IO_ERROR (-250)
615	/** Device i/o: Bad unit. */
616	#define VERR_IO_BAD_UNIT (-251)
617	/** Device i/o: Not ready. */
618	#define VERR_IO_NOT_READY (-252)
619	/** Device i/o: Bad command. */
620	#define VERR_IO_BAD_COMMAND (-253)
621	/** Device i/o: CRC error. */
622	#define VERR_IO_CRC (-254)
623	/** Device i/o: Bad length. */
624	#define VERR_IO_BAD_LENGTH (-255)
625	/** Device i/o: Sector not found. */
626	#define VERR_IO_SECTOR_NOT_FOUND (-256)
627	/** Device i/o: General failure. */
628	#define VERR_IO_GEN_FAILURE (-257)
629	/** @} */
630
631
632	/** @name Generic Pipe I/O Status Codes
633	* @{
634	*/
635	/** Unresolved (unknown) pipe i/o error. */
636	#define VERR_PIPE_IO_ERROR (-300)
637	/** Broken pipe. */
638	#define VERR_BROKEN_PIPE (-301)
639	/** Bad pipe. */
640	#define VERR_BAD_PIPE (-302)
641	/** Pipe is busy. */
642	#define VERR_PIPE_BUSY (-303)
643	/** No data in pipe. */
644	#define VERR_NO_DATA (-304)
645	/** Pipe is not connected. */
646	#define VERR_PIPE_NOT_CONNECTED (-305)
647	/** More data available in pipe. */
648	#define VERR_MORE_DATA (-306)
649	/** @} */
650
651
652	/** @name Generic Semaphores Status Codes
653	* @{
654	*/
655	/** Unresolved (unknown) semaphore error. */
656	#define VERR_SEM_ERROR (-350)
657	/** Too many semaphores. */
658	#define VERR_TOO_MANY_SEMAPHORES (-351)
659	/** Exclusive semaphore is owned by another process. */
660	#define VERR_EXCL_SEM_ALREADY_OWNED (-352)
661	/** The semaphore is set and cannot be closed. */
662	#define VERR_SEM_IS_SET (-353)
663	/** The semaphore cannot be set again. */
664	#define VERR_TOO_MANY_SEM_REQUESTS (-354)
665	/** Attempt to release mutex not owned by caller. */
666	#define VERR_NOT_OWNER (-355)
667	/** The semaphore has been opened too many times. */
668	#define VERR_TOO_MANY_OPENS (-356)
669	/** The maximum posts for the event semaphore has been reached. */
670	#define VERR_TOO_MANY_POSTS (-357)
671	/** The event semaphore has already been posted. */
672	#define VERR_ALREADY_POSTED (-358)
673	/** The event semaphore has already been reset. */
674	#define VERR_ALREADY_RESET (-359)
675	/** The semaphore is in use. */
676	#define VERR_SEM_BUSY (-360)
677	/** The previous ownership of this semaphore has ended. */
678	#define VERR_SEM_OWNER_DIED (-361)
679	/** Failed to open semaphore by name - not found. */
680	#define VERR_SEM_NOT_FOUND (-362)
681	/** Semaphore destroyed while waiting. */
682	#define VERR_SEM_DESTROYED (-363)
683	/** Nested ownership requests are not permitted for this semaphore type. */
684	#define VERR_SEM_NESTED (-364)
685	/** Deadlock detected. */
686	#define VERR_DEADLOCK (-365)
687	/** Ping-Pong listen or speak out of turn error. */
688	#define VERR_SEM_OUT_OF_TURN (-366)
689	/** @} */
690
691
692	/** @name Generic Network I/O Status Codes
693	* @{
694	*/
695	/** Unresolved (unknown) network error. */
696	#define VERR_NET_IO_ERROR (-400)
697	/** The network is busy or is out of resources. */
698	#define VERR_NET_OUT_OF_RESOURCES (-401)
699	/** Net host name not found. */
700	#define VERR_NET_HOST_NOT_FOUND (-402)
701	/** Network path not found. */
702	#define VERR_NET_PATH_NOT_FOUND (-403)
703	/** General network printing error. */
704	#define VERR_NET_PRINT_ERROR (-404)
705	/** The machine is not on the network. */
706	#define VERR_NET_NO_NETWORK (-405)
707	/** Name is not unique on the network. */
708	#define VERR_NET_NOT_UNIQUE_NAME (-406)
709
710	/* These are BSD networking error codes - numbers correspond, don't mess! */
711	/** Operation in progress. */
712	#define VERR_NET_IN_PROGRESS (-436)
713	/** Operation already in progress. */
714	#define VERR_NET_ALREADY_IN_PROGRESS (-437)
715	/** Attempted socket operation with a non-socket handle.
716	* (This includes closed handles.) */
717	#define VERR_NET_NOT_SOCKET (-438)
718	/** Destination address required. */
719	#define VERR_NET_DEST_ADDRESS_REQUIRED (-439)
720	/** Message too long. */
721	#define VERR_NET_MSG_SIZE (-440)
722	/** Protocol wrong type for socket. */
723	#define VERR_NET_PROTOCOL_TYPE (-441)
724	/** Protocol not available. */
725	#define VERR_NET_PROTOCOL_NOT_AVAILABLE (-442)
726	/** Protocol not supported. */
727	#define VERR_NET_PROTOCOL_NOT_SUPPORTED (-443)
728	/** Socket type not supported. */
729	#define VERR_NET_SOCKET_TYPE_NOT_SUPPORTED (-444)
730	/** Operation not supported. */
731	#define VERR_NET_OPERATION_NOT_SUPPORTED (-445)
732	/** Protocol family not supported. */
733	#define VERR_NET_PROTOCOL_FAMILY_NOT_SUPPORTED (-446)
734	/** Address family not supported by protocol family. */
735	#define VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED (-447)
736	/** Address already in use. */
737	#define VERR_NET_ADDRESS_IN_USE (-448)
738	/** Can't assign requested address. */
739	#define VERR_NET_ADDRESS_NOT_AVAILABLE (-449)
740	/** Network is down. */
741	#define VERR_NET_DOWN (-450)
742	/** Network is unreachable. */
743	#define VERR_NET_UNREACHABLE (-451)
744	/** Network dropped connection on reset. */
745	#define VERR_NET_CONNECTION_RESET (-452)
746	/** Software caused connection abort. */
747	#define VERR_NET_CONNECTION_ABORTED (-453)
748	/** Connection reset by peer. */
749	#define VERR_NET_CONNECTION_RESET_BY_PEER (-454)
750	/** No buffer space available. */
751	#define VERR_NET_NO_BUFFER_SPACE (-455)
752	/** Socket is already connected. */
753	#define VERR_NET_ALREADY_CONNECTED (-456)
754	/** Socket is not connected. */
755	#define VERR_NET_NOT_CONNECTED (-457)
756	/** Can't send after socket shutdown. */
757	#define VERR_NET_SHUTDOWN (-458)
758	/** Too many references: can't splice. */
759	#define VERR_NET_TOO_MANY_REFERENCES (-459)
760	/** Too many references: can't splice. */
761	#define VERR_NET_CONNECTION_TIMED_OUT (-460)
762	/** Connection refused. */
763	#define VERR_NET_CONNECTION_REFUSED (-461)
764	/* ELOOP is not net. */
765	/* ENAMETOOLONG is not net. */
766	/** Host is down. */
767	#define VERR_NET_HOST_DOWN (-464)
768	/** No route to host. */
769	#define VERR_NET_HOST_UNREACHABLE (-465)
770	/** Protocol error. */
771	#define VERR_NET_PROTOCOL_ERROR (-466)
772	/** @} */
773
774
775	/** @name TCP Status Codes
776	* @{
777	*/
778	/** Stop the TCP server. */
779	#define VERR_TCP_SERVER_STOP (-500)
780	/** The server was stopped. */
781	#define VINF_TCP_SERVER_STOP 500
782	/** @} */
783
784
785	/** @name L4 Specific Status Codes
786	* @{
787	*/
788	/** Invalid offset in an L4 dataspace */
789	#define VERR_L4_INVALID_DS_OFFSET (-550)
790	/** IPC error */
791	#define VERR_IPC (-551)
792	/** Item already used */
793	#define VERR_RESOURCE_IN_USE (-552)
794	/** Source/destination not found */
795	#define VERR_IPC_PROCESS_NOT_FOUND (-553)
796	/** Receive timeout */
797	#define VERR_IPC_RECEIVE_TIMEOUT (-554)
798	/** Send timeout */
799	#define VERR_IPC_SEND_TIMEOUT (-555)
800	/** Receive cancelled */
801	#define VERR_IPC_RECEIVE_CANCELLED (-556)
802	/** Send cancelled */
803	#define VERR_IPC_SEND_CANCELLED (-557)
804	/** Receive aborted */
805	#define VERR_IPC_RECEIVE_ABORTED (-558)
806	/** Send aborted */
807	#define VERR_IPC_SEND_ABORTED (-559)
808	/** Couldn't map pages during receive */
809	#define VERR_IPC_RECEIVE_MAP_FAILED (-560)
810	/** Couldn't map pages during send */
811	#define VERR_IPC_SEND_MAP_FAILED (-561)
812	/** Send pagefault timeout in receive */
813	#define VERR_IPC_RECEIVE_SEND_PF_TIMEOUT (-562)
814	/** Send pagefault timeout in send */
815	#define VERR_IPC_SEND_SEND_PF_TIMEOUT (-563)
816	/** (One) receive buffer was too small, or too few buffers */
817	#define VINF_IPC_RECEIVE_MSG_CUT 564
818	/** (One) send buffer was too small, or too few buffers */
819	#define VINF_IPC_SEND_MSG_CUT 565
820	/** Dataspace manager server not found */
821	#define VERR_L4_DS_MANAGER_NOT_FOUND (-566)
822	/** @} */
823
824
825	/** @name Loader Status Codes.
826	* @{
827	*/
828	/** Invalid executable signature. */
829	#define VERR_INVALID_EXE_SIGNATURE (-600)
830	/** The iprt loader recognized a ELF image, but doesn't support loading it. */
831	#define VERR_ELF_EXE_NOT_SUPPORTED (-601)
832	/** The iprt loader recognized a PE image, but doesn't support loading it. */
833	#define VERR_PE_EXE_NOT_SUPPORTED (-602)
834	/** The iprt loader recognized a LX image, but doesn't support loading it. */
835	#define VERR_LX_EXE_NOT_SUPPORTED (-603)
836	/** The iprt loader recognized a LE image, but doesn't support loading it. */
837	#define VERR_LE_EXE_NOT_SUPPORTED (-604)
838	/** The iprt loader recognized a NE image, but doesn't support loading it. */
839	#define VERR_NE_EXE_NOT_SUPPORTED (-605)
840	/** The iprt loader recognized a MZ image, but doesn't support loading it. */
841	#define VERR_MZ_EXE_NOT_SUPPORTED (-606)
842	/** The iprt loader recognized an a.out image, but doesn't support loading it. */
843	#define VERR_AOUT_EXE_NOT_SUPPORTED (-607)
844	/** Bad executable. */
845	#define VERR_BAD_EXE_FORMAT (-608)
846	/** Symbol (export) not found. */
847	#define VERR_SYMBOL_NOT_FOUND (-609)
848	/** Module not found. */
849	#define VERR_MODULE_NOT_FOUND (-610)
850	/** The loader resolved an external symbol to an address to big for the image format. */
851	#define VERR_SYMBOL_VALUE_TOO_BIG (-611)
852	/** The image is too big. */
853	#define VERR_IMAGE_TOO_BIG (-612)
854	/** The image base address is to high for this image type. */
855	#define VERR_IMAGE_BASE_TOO_HIGH (-614)
856	/** Mismatching architecture. */
857	#define VERR_LDR_ARCH_MISMATCH (-615)
858	/** The PE loader encountered delayed imports, a feature which hasn't been implemented yet. */
859	#define VERR_LDRPE_DELAY_IMPORT (-620)
860	/** The PE loader doesn't have a clue what the security data directory entry is all about. */
861	#define VERR_LDRPE_SECURITY (-621)
862	/** The PE loader doesn't know how to deal with the global pointer data directory entry yet. */
863	#define VERR_LDRPE_GLOBALPTR (-622)
864	/** The PE loader doesn't support the TLS data directory yet. */
865	#define VERR_LDRPE_TLS (-623)
866	/** The PE loader doesn't grok the COM descriptor data directory entry. */
867	#define VERR_LDRPE_COM_DESCRIPTOR (-624)
868	/** The PE loader encountered an unknown load config directory/header size. */
869	#define VERR_LDRPE_LOAD_CONFIG_SIZE (-625)
870	/** The PE loader encountered a lock prefix table, a feature which hasn't been implemented yet. */
871	#define VERR_LDRPE_LOCK_PREFIX_TABLE (-626)
872	/** The ELF loader doesn't handle foreign endianness. */
873	#define VERR_LDRELF_ODD_ENDIAN (-630)
874	/** The ELF image is 'dynamic', the ELF loader can only deal with 'relocatable' images at present. */
875	#define VERR_LDRELF_DYN (-631)
876	/** The ELF image is 'executable', the ELF loader can only deal with 'relocatable' images at present. */
877	#define VERR_LDRELF_EXEC (-632)
878	/** The ELF image was created for an unsupported target machine type. */
879	#define VERR_LDRELF_MACHINE (-633)
880	/** The ELF version is not supported. */
881	#define VERR_LDRELF_VERSION (-634)
882	/** The ELF loader cannot handle multiple SYMTAB sections. */
883	#define VERR_LDRELF_MULTIPLE_SYMTABS (-635)
884	/** The ELF loader encountered a relocation type which is not implemented. */
885	#define VERR_LDRELF_RELOCATION_NOT_SUPPORTED (-636)
886	/** The ELF loader encountered a bad symbol index. */
887	#define VERR_LDRELF_INVALID_SYMBOL_INDEX (-637)
888	/** The ELF loader encountered an invalid symbol name offset. */
889	#define VERR_LDRELF_INVALID_SYMBOL_NAME_OFFSET (-638)
890	/** The ELF loader encountered an invalid relocation offset. */
891	#define VERR_LDRELF_INVALID_RELOCATION_OFFSET (-639)
892	/** The ELF loader didn't find the symbol/string table for the image. */
893	#define VERR_LDRELF_NO_SYMBOL_OR_NO_STRING_TABS (-640)
894	/** @}*/
895
896	/** @name Debug Info Reader Status Codes.
897	* @{
898	*/
899	/** The specified segment:offset address was invalid. Typically an attempt at
900	* addressing outside the segment boundrary. */
901	#define VERR_DBGMOD_INVALID_ADDRESS (-650)
902	/** @} */
903
904	/** @name Request Packet Status Codes.
905	* @{
906	*/
907	/** Invalid RT request type.
908	* For the RTReqAlloc() case, the caller just specified an illegal enmType. For
909	* all the other occurences it means indicates corruption, broken logic, or stupid
910	* interface user. */
911	#define VERR_RT_REQUEST_INVALID_TYPE (-700)
912	/** Invalid RT request state.
913	* The state of the request packet was not the expected and accepted one(s). Either
914	* the interface user screwed up, or we've got corruption/broken logic. */
915	#define VERR_RT_REQUEST_STATE (-701)
916	/** Invalid RT request packet.
917	* One or more of the RT controlled packet members didn't contain the correct
918	* values. Some thing's broken. */
919	#define VERR_RT_REQUEST_INVALID_PACKAGE (-702)
920	/** The status field has not been updated yet as the request is still
921	* pending completion. Someone queried the iStatus field before the request
922	* has been fully processed. */
923	#define VERR_RT_REQUEST_STATUS_STILL_PENDING (-703)
924	/** The request has been freed, don't read the status now.
925	* Someone is reading the iStatus field of a freed request packet. */
926	#define VERR_RT_REQUEST_STATUS_FREED (-704)
927	/** @} */
928
929	/** @name Environment Status Code
930	* @{
931	*/
932	/** The specified environment variable was not found. (RTEnvGetEx) */
933	#define VERR_ENV_VAR_NOT_FOUND (-750)
934	/** The specified environment variable was not found. (RTEnvUnsetEx) */
935	#define VINF_ENV_VAR_NOT_FOUND (750)
936	/** @} */
937
938	/** @name Multiprocessor Status Codes.
939	* @{
940	*/
941	/** The specified cpu is offline. */
942	#define VERR_CPU_OFFLINE (-800)
943	/** The specified cpu was not found. */
944	#define VERR_CPU_NOT_FOUND (-801)
945	/** @} */
946
947	/** @name RTGetOpt status codes
948	* @{ */
949	/** RTGetOpt: command line option not recognized. */
950	#define VERR_GETOPT_UNKNOWN_OPTION (-825)
951	/** RTGetOpt: command line option needs argument. */
952	#define VERR_GETOPT_REQUIRED_ARGUMENT_MISSING (-826)
953	/** RTGetOpt: command line option has argument with bad format. */
954	#define VERR_GETOPT_INVALID_ARGUMENT_FORMAT (-827)
955	/** RTGetOpt: Not an option. */
956	#define VINF_GETOPT_NOT_OPTION 828
957	/** @} */
958
959	/** @name RTCache status codes
960	* @{ */
961	/** RTCache: cache is full. */
962	#define VERR_CACHE_FULL (-850)
963	/** RTCache: cache is empty. */
964	#define VERR_CACHE_EMPTY (-851)
965	/** @} */
966
967	/* SED-END */
968
969	/** @} */
970
971	__END_DECLS
972
973	#endif
974

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/err.h@ 17371

Download in other formats: