err.h@ 8391

Last change on this file since 8391 was 8391, checked in by vboxsync, 17 years ago
Added some warnings. Drop the aka as SUP* stuff as it's obsolete/to-be-removed.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 33.5 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	#endif /* RT_OS_WINDOWS */
266
267	#endif /* IN_RING3 */
268
269	/** @} */
270
271
272	/* SED-START */
273
274	/** @name Misc. Status Codes
275	* @{
276	*/
277	/** Success. */
278	#define VINF_SUCCESS 0
279
280	/** General failure - DON'T USE THIS!!! */
281	#define VERR_GENERAL_FAILURE (-1)
282	/** Invalid parameter. */
283	#define VERR_INVALID_PARAMETER (-2)
284	/** Invalid parameter. */
285	#define VWRN_INVALID_PARAMETER 2
286	/** Invalid magic or cookie. */
287	#define VERR_INVALID_MAGIC (-3)
288	/** Invalid magic or cookie. */
289	#define VWRN_INVALID_MAGIC 3
290	/** Invalid loader handle. */
291	#define VERR_INVALID_HANDLE (-4)
292	/** Invalid loader handle. */
293	#define VWRN_INVALID_HANDLE 4
294	/** Failed to lock the address range. */
295	#define VERR_LOCK_FAILED (-5)
296	/** Invalid memory pointer. */
297	#define VERR_INVALID_POINTER (-6)
298	/** Failed to patch the IDT. */
299	#define VERR_IDT_FAILED (-7)
300	/** Memory allocation failed. */
301	#define VERR_NO_MEMORY (-8)
302	/** Already loaded. */
303	#define VERR_ALREADY_LOADED (-9)
304	/** Permission denied. */
305	#define VERR_PERMISSION_DENIED (-10)
306	/** Version mismatch. */
307	#define VERR_VERSION_MISMATCH (-11)
308	/** The request function is not implemented. */
309	#define VERR_NOT_IMPLEMENTED (-12)
310
311	/** Failed to allocate temporary memory. */
312	#define VERR_NO_TMP_MEMORY (-20)
313	/** Invalid file mode mask (RTFMODE). */
314	#define VERR_INVALID_FMODE (-21)
315	/** Incorrect call order. */
316	#define VERR_WRONG_ORDER (-22)
317	/** There is no TLS (thread local storage) available for storing the current thread. */
318	#define VERR_NO_TLS_FOR_SELF (-23)
319	/** Failed to set the TLS (thread local storage) entry which points to our thread structure. */
320	#define VERR_FAILED_TO_SET_SELF_TLS (-24)
321	/** Not able to allocate contiguous memory. */
322	#define VERR_NO_CONT_MEMORY (-26)
323	/** No memory available for page table or page directory. */
324	#define VERR_NO_PAGE_MEMORY (-27)
325	/** Already initialized. */
326	#define VINF_ALREADY_INITIALIZED 28
327	/** The specified thread is dead. */
328	#define VERR_THREAD_IS_DEAD (-29)
329	/** The specified thread is not waitable. */
330	#define VERR_THREAD_NOT_WAITABLE (-30)
331	/** Pagetable not present. */
332	#define VERR_PAGE_TABLE_NOT_PRESENT (-31)
333	/** Internal error - we're screwed if this happens. */
334	#define VERR_INTERNAL_ERROR (-32)
335	/** The per process timer is busy. */
336	#define VERR_TIMER_BUSY (-33)
337	/** Address conflict. */
338	#define VERR_ADDRESS_CONFLICT (-34)
339	/** Unresolved (unknown) host platform error. */
340	#define VERR_UNRESOLVED_ERROR (-35)
341	/** Invalid function. */
342	#define VERR_INVALID_FUNCTION (-36)
343	/** Not supported. */
344	#define VERR_NOT_SUPPORTED (-37)
345	/** Access denied. */
346	#define VERR_ACCESS_DENIED (-38)
347	/** Call interrupted. */
348	#define VERR_INTERRUPTED (-39)
349	/** Timeout. */
350	#define VERR_TIMEOUT (-40)
351	/** Buffer too small to save result. */
352	#define VERR_BUFFER_OVERFLOW (-41)
353	/** Buffer too small to save result. */
354	#define VINF_BUFFER_OVERFLOW 41
355	/** Data size overflow. */
356	#define VERR_TOO_MUCH_DATA (-42)
357	/** Max threads number reached. */
358	#define VERR_MAX_THRDS_REACHED (-43)
359	/** Max process number reached. */
360	#define VERR_MAX_PROCS_REACHED (-44)
361	/** The recipient process has refused the signal. */
362	#define VERR_SIGNAL_REFUSED (-45)
363	/** A signal is already pending. */
364	#define VERR_SIGNAL_PENDING (-46)
365	/** The signal being posted is not correct. */
366	#define VERR_SIGNAL_INVALID (-47)
367	/** The state changed.
368	* This is a generic error message and needs a context to make sense. */
369	#define VERR_STATE_CHANGED (-48)
370	/** Warning, the state changed.
371	* This is a generic error message and needs a context to make sense. */
372	#define VWRN_STATE_CHANGED 48
373	/** Error while parsing UUID string */
374	#define VERR_INVALID_UUID_FORMAT (-49)
375	/** The specified process was not found. */
376	#define VERR_PROCESS_NOT_FOUND (-50)
377	/** The process specified to a non-block wait had not exitted. */
378	#define VERR_PROCESS_RUNNING (-51)
379	/** Retry the operation. */
380	#define VERR_TRY_AGAIN (-52)
381	/** Generic parse error. */
382	#define VERR_PARSE_ERROR (-53)
383	/** Value out of range. */
384	#define VERR_OUT_OF_RANGE (-54)
385	/** A numeric convertion encountered a value which was too big for the target. */
386	#define VERR_NUMBER_TOO_BIG (-55)
387	/** A numeric convertion encountered a value which was too big for the target. */
388	#define VWRN_NUMBER_TOO_BIG 55
389	/** The number begin converted (string) contained no digits. */
390	#define VERR_NO_DIGITS (-56)
391	/** The number begin converted (string) contained no digits. */
392	#define VWRN_NO_DIGITS 56
393	/** Encountered a '-' during convertion to an unsigned value. */
394	#define VERR_NEGATIVE_UNSIGNED (-57)
395	/** Encountered a '-' during convertion to an unsigned value. */
396	#define VWRN_NEGATIVE_UNSIGNED 57
397	/** Error while characters translation (unicode and so). */
398	#define VERR_NO_TRANSLATION (-58)
399	/** Encountered unicode code point which is reserved for use as endian indicator (0xffff or 0xfffe). */
400	#define VERR_CODE_POINT_ENDIAN_INDICATOR (-59)
401	/** Encountered unicode code point in the surrogate range (0xd800 to 0xdfff). */
402	#define VERR_CODE_POINT_SURROGATE (-60)
403	/** A string claiming to be UTF-8 is incorrectly encoded. */
404	#define VERR_INVALID_UTF8_ENCODING (-61)
405	/** Ad string claiming to be in UTF-16 is incorrectly encoded. */
406	#define VERR_INVALID_UTF16_ENCODING (-62)
407	/** Encountered a unicode code point which cannot be represented as UTF-16. */
408	#define VERR_CANT_RECODE_AS_UTF16 (-63)
409	/** Got an out of memory condition trying to allocate a string. */
410	#define VERR_NO_STR_MEMORY (-64)
411	/** Got an out of memory condition trying to allocate a UTF-16 (/UCS-2) string. */
412	#define VERR_NO_UTF16_MEMORY (-65)
413	/** Get an out of memory condition trying to allocate a code point array. */
414	#define VERR_NO_CODE_POINT_MEMORY (-66)
415	/** Can't free the memory because it's used in mapping. */
416	#define VERR_MEMORY_BUSY (-67)
417	/** The timer can't be started because it's already active. */
418	#define VERR_TIMER_ACTIVE (-68)
419	/** The timer can't be stopped because i's already suspended. */
420	#define VERR_TIMER_SUSPENDED (-69)
421	/** The operation was cancelled by the user. */
422	#define VERR_CANCELLED (-70)
423	/** Failed to initialize a memory object.
424	* Exactly what this means is OS specific. */
425	#define VERR_MEMOBJ_INIT_FAILED (-71)
426	/** Out of memory condition when allocating memory with low physical backing. */
427	#define VERR_NO_LOW_MEMORY (-72)
428	/** Out of memory condition when allocating physical memory (without mapping). */
429	#define VERR_NO_PHYS_MEMORY (-73)
430	/** The address (virtual or physical) is too big. */
431	#define VERR_ADDRESS_TOO_BIG (-74)
432	/** Failed to map a memory object. */
433	#define VERR_MAP_FAILED (-75)
434	/** Trailing characters. */
435	#define VERR_TRAILING_CHARS (-76)
436	/** Trailing characters. */
437	#define VWRN_TRAILING_CHARS 76
438	/** Trailing spaces. */
439	#define VERR_TRAILING_SPACES (-77)
440	/** Trailing spaces. */
441	#define VWRN_TRAILING_SPACES 77
442	/** RTGetOpt: command line option not recognized. */
443	#define VERR_GETOPT_UNKNOWN_OPTION (-78)
444	/** RTGetOpt: command line option needs argument. */
445	#define VERR_GETOPT_REQUIRED_ARGUMENT_MISSING (-79)
446	/** RTGetOpt: command line option has argument with bad format. */
447	#define VERR_GETOPT_INVALID_ARGUMENT_FORMAT (-80)
448	/** Generic not found error. */
449	#define VERR_NOT_FOUND (-81)
450	/** @} */
451
452
453	/** @name Common File/Disk/Pipe/etc Status Codes
454	* @{
455	*/
456	/** Unresolved (unknown) file i/o error. */
457	#define VERR_FILE_IO_ERROR (-100)
458	/** File/Device open failed. */
459	#define VERR_OPEN_FAILED (-101)
460	/** File not found. */
461	#define VERR_FILE_NOT_FOUND (-102)
462	/** Path not found. */
463	#define VERR_PATH_NOT_FOUND (-103)
464	/** Invalid (malformed) file/path name. */
465	#define VERR_INVALID_NAME (-104)
466	/** File/Device already exists. */
467	#define VERR_ALREADY_EXISTS (-105)
468	/** Too many open files. */
469	#define VERR_TOO_MANY_OPEN_FILES (-106)
470	/** Seek error. */
471	#define VERR_SEEK (-107)
472	/** Seek below file start. */
473	#define VERR_NEGATIVE_SEEK (-108)
474	/** Trying to seek on device. */
475	#define VERR_SEEK_ON_DEVICE (-109)
476	/** Reached the end of the file. */
477	#define VERR_EOF (-110)
478	/** Reached the end of the file. */
479	#define VINF_EOF 110
480	/** Generic file read error. */
481	#define VERR_READ_ERROR (-111)
482	/** Generic file write error. */
483	#define VERR_WRITE_ERROR (-112)
484	/** Write protect error. */
485	#define VERR_WRITE_PROTECT (-113)
486	/** Sharing violation, file is being used by another process. */
487	#define VERR_SHARING_VIOLATION (-114)
488	/** Unable to lock a region of a file. */
489	#define VERR_FILE_LOCK_FAILED (-115)
490	/** File access error, another process has locked a portion of the file. */
491	#define VERR_FILE_LOCK_VIOLATION (-116)
492	/** File or directory can't be created. */
493	#define VERR_CANT_CREATE (-117)
494	/** Directory can't be deleted. */
495	#define VERR_CANT_DELETE_DIRECTORY (-118)
496	/** Can't move file to another disk. */
497	#define VERR_NOT_SAME_DEVICE (-119)
498	/** The filename or extension is too long. */
499	#define VERR_FILENAME_TOO_LONG (-120)
500	/** Media not present in drive. */
501	#define VERR_MEDIA_NOT_PRESENT (-121)
502	/** The type of media was not recognized. Not formatted? */
503	#define VERR_MEDIA_NOT_RECOGNIZED (-122)
504	/** Can't unlock - region was not locked. */
505	#define VERR_FILE_NOT_LOCKED (-123)
506	/** Unrecoverable error: lock was lost. */
507	#define VERR_FILE_LOCK_LOST (-124)
508	/** Can't delete directory with files. */
509	#define VERR_DIR_NOT_EMPTY (-125)
510	/** A directory operation was attempted on a non-directory object. */
511	#define VERR_NOT_A_DIRECTORY (-126)
512	/** A non-directory operation was attempted on a directory object. */
513	#define VERR_IS_A_DIRECTORY (-127)
514	/** Tried to grow a file beyond the limit imposed by the process or the filesystem. */
515	#define VERR_FILE_TOO_BIG (-128)
516	/** @} */
517
518
519	/** @name Generic Filesystem I/O Status Codes
520	* @{
521	*/
522	/** Unresolved (unknown) disk i/o error. */
523	#define VERR_DISK_IO_ERROR (-150)
524	/** Invalid drive number. */
525	#define VERR_INVALID_DRIVE (-151)
526	/** Disk is full. */
527	#define VERR_DISK_FULL (-152)
528	/** Disk was changed. */
529	#define VERR_DISK_CHANGE (-153)
530	/** Drive is locked. */
531	#define VERR_DRIVE_LOCKED (-154)
532	/** The specified disk or diskette cannot be accessed. */
533	#define VERR_DISK_INVALID_FORMAT (-155)
534	/** Too many symbolic links. */
535	#define VERR_TOO_MANY_SYMLINKS (-156)
536	/** @} */
537
538
539	/** @name Generic Directory Enumeration Status Codes
540	* @{
541	*/
542	/** Unresolved (unknown) search error. */
543	#define VERR_SEARCH_ERROR (-200)
544	/** No more files found. */
545	#define VERR_NO_MORE_FILES (-201)
546	/** No more search handles available. */
547	#define VERR_NO_MORE_SEARCH_HANDLES (-202)
548	/** RTDirReadEx() failed to retrieve the extra data which was requested. */
549	#define VWRN_NO_DIRENT_INFO 203
550	/** @} */
551
552
553	/** @name Generic Device I/O Status Codes
554	* @{
555	*/
556	/** Unresolved (unknown) device i/o error. */
557	#define VERR_DEV_IO_ERROR (-250)
558	/** Device i/o: Bad unit. */
559	#define VERR_IO_BAD_UNIT (-251)
560	/** Device i/o: Not ready. */
561	#define VERR_IO_NOT_READY (-252)
562	/** Device i/o: Bad command. */
563	#define VERR_IO_BAD_COMMAND (-253)
564	/** Device i/o: CRC error. */
565	#define VERR_IO_CRC (-254)
566	/** Device i/o: Bad length. */
567	#define VERR_IO_BAD_LENGTH (-255)
568	/** Device i/o: Sector not found. */
569	#define VERR_IO_SECTOR_NOT_FOUND (-256)
570	/** Device i/o: General failure. */
571	#define VERR_IO_GEN_FAILURE (-257)
572	/** @} */
573
574
575	/** @name Generic Pipe I/O Status Codes
576	* @{
577	*/
578	/** Unresolved (unknown) pipe i/o error. */
579	#define VERR_PIPE_IO_ERROR (-300)
580	/** Broken pipe. */
581	#define VERR_BROKEN_PIPE (-301)
582	/** Bad pipe. */
583	#define VERR_BAD_PIPE (-302)
584	/** Pipe is busy. */
585	#define VERR_PIPE_BUSY (-303)
586	/** No data in pipe. */
587	#define VERR_NO_DATA (-304)
588	/** Pipe is not connected. */
589	#define VERR_PIPE_NOT_CONNECTED (-305)
590	/** More data available in pipe. */
591	#define VERR_MORE_DATA (-306)
592	/** @} */
593
594
595	/** @name Generic Semaphores Status Codes
596	* @{
597	*/
598	/** Unresolved (unknown) semaphore error. */
599	#define VERR_SEM_ERROR (-350)
600	/** Too many semaphores. */
601	#define VERR_TOO_MANY_SEMAPHORES (-351)
602	/** Exclusive semaphore is owned by another process. */
603	#define VERR_EXCL_SEM_ALREADY_OWNED (-352)
604	/** The semaphore is set and cannot be closed. */
605	#define VERR_SEM_IS_SET (-353)
606	/** The semaphore cannot be set again. */
607	#define VERR_TOO_MANY_SEM_REQUESTS (-354)
608	/** Attempt to release mutex not owned by caller. */
609	#define VERR_NOT_OWNER (-355)
610	/** The semaphore has been opened too many times. */
611	#define VERR_TOO_MANY_OPENS (-356)
612	/** The maximum posts for the event semaphore has been reached. */
613	#define VERR_TOO_MANY_POSTS (-357)
614	/** The event semaphore has already been posted. */
615	#define VERR_ALREADY_POSTED (-358)
616	/** The event semaphore has already been reset. */
617	#define VERR_ALREADY_RESET (-359)
618	/** The semaphore is in use. */
619	#define VERR_SEM_BUSY (-360)
620	/** The previous ownership of this semaphore has ended. */
621	#define VERR_SEM_OWNER_DIED (-361)
622	/** Failed to open semaphore by name - not found. */
623	#define VERR_SEM_NOT_FOUND (-362)
624	/** Semaphore destroyed while waiting. */
625	#define VERR_SEM_DESTROYED (-363)
626	/** Nested ownership requests are not permitted for this semaphore type. */
627	#define VERR_SEM_NESTED (-364)
628	/** Deadlock detected. */
629	#define VERR_DEADLOCK (-365)
630	/** Ping-Pong listen or speak out of turn error. */
631	#define VERR_SEM_OUT_OF_TURN (-366)
632	/** @} */
633
634
635	/** @name Generic Network I/O Status Codes
636	* @{
637	*/
638	/** Unresolved (unknown) network error. */
639	#define VERR_NET_IO_ERROR (-400)
640	/** The network is busy or is out of resources. */
641	#define VERR_NET_OUT_OF_RESOURCES (-401)
642	/** Net host name not found. */
643	#define VERR_NET_HOST_NOT_FOUND (-402)
644	/** Network path not found. */
645	#define VERR_NET_PATH_NOT_FOUND (-403)
646	/** General network printing error. */
647	#define VERR_NET_PRINT_ERROR (-404)
648	/** The machine is not on the network. */
649	#define VERR_NET_NO_NETWORK (-405)
650	/** Name is not unique on the network. */
651	#define VERR_NET_NOT_UNIQUE_NAME (-406)
652
653	/* These are BSD networking error codes - numbers correspond, don't mess! */
654	/** Operation in progress. */
655	#define VERR_NET_IN_PROGRESS (-436)
656	/** Operation already in progress. */
657	#define VERR_NET_ALREADY_IN_PROGRESS (-437)
658	/** Attempted socket operation with a non-socket handle.
659	* (This includes closed handles.) */
660	#define VERR_NET_NOT_SOCKET (-438)
661	/** Destination address required. */
662	#define VERR_NET_DEST_ADDRESS_REQUIRED (-439)
663	/** Message too long. */
664	#define VERR_NET_MSG_SIZE (-440)
665	/** Protocol wrong type for socket. */
666	#define VERR_NET_PROTOCOL_TYPE (-441)
667	/** Protocol not available. */
668	#define VERR_NET_PROTOCOL_NOT_AVAILABLE (-442)
669	/** Protocol not supported. */
670	#define VERR_NET_PROTOCOL_NOT_SUPPORTED (-443)
671	/** Socket type not supported. */
672	#define VERR_NET_SOCKET_TYPE_NOT_SUPPORTED (-444)
673	/** Operation not supported. */
674	#define VERR_NET_OPERATION_NOT_SUPPORTED (-445)
675	/** Protocol family not supported. */
676	#define VERR_NET_PROTOCOL_FAMILY_NOT_SUPPORTED (-446)
677	/** Address family not supported by protocol family. */
678	#define VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED (-447)
679	/** Address already in use. */
680	#define VERR_NET_ADDRESS_IN_USE (-448)
681	/** Can't assign requested address. */
682	#define VERR_NET_ADDRESS_NOT_AVAILABLE (-449)
683	/** Network is down. */
684	#define VERR_NET_DOWN (-450)
685	/** Network is unreachable. */
686	#define VERR_NET_UNREACHABLE (-451)
687	/** Network dropped connection on reset. */
688	#define VERR_NET_CONNECTION_RESET (-452)
689	/** Software caused connection abort. */
690	#define VERR_NET_CONNECTION_ABORTED (-453)
691	/** Connection reset by peer. */
692	#define VERR_NET_CONNECTION_RESET_BY_PEER (-454)
693	/** No buffer space available. */
694	#define VERR_NET_NO_BUFFER_SPACE (-455)
695	/** Socket is already connected. */
696	#define VERR_NET_ALREADY_CONNECTED (-456)
697	/** Socket is not connected. */
698	#define VERR_NET_NOT_CONNECTED (-457)
699	/** Can't send after socket shutdown. */
700	#define VERR_NET_SHUTDOWN (-458)
701	/** Too many references: can't splice. */
702	#define VERR_NET_TOO_MANY_REFERENCES (-459)
703	/** Too many references: can't splice. */
704	#define VERR_NET_CONNECTION_TIMED_OUT (-460)
705	/** Connection refused. */
706	#define VERR_NET_CONNECTION_REFUSED (-461)
707	/* ELOOP is not net. */
708	/* ENAMETOOLONG is not net. */
709	/** Host is down. */
710	#define VERR_NET_HOST_DOWN (-464)
711	/** No route to host. */
712	#define VERR_NET_HOST_UNREACHABLE (-465)
713	/** @} */
714
715
716	/** @name TCP Status Codes
717	* @{
718	*/
719	/** Stop the TCP server. */
720	#define VERR_TCP_SERVER_STOP (-500)
721	/** The server was stopped. */
722	#define VINF_TCP_SERVER_STOP 500
723	/** @} */
724
725
726	/** @name L4 Specific Status Codes
727	* @{
728	*/
729	/** Invalid offset in an L4 dataspace */
730	#define VERR_L4_INVALID_DS_OFFSET (-550)
731	/** IPC error */
732	#define VERR_IPC (-551)
733	/** Item already used */
734	#define VERR_RESOURCE_IN_USE (-552)
735	/** Source/destination not found */
736	#define VERR_IPC_PROCESS_NOT_FOUND (-553)
737	/** Receive timeout */
738	#define VERR_IPC_RECEIVE_TIMEOUT (-554)
739	/** Send timeout */
740	#define VERR_IPC_SEND_TIMEOUT (-555)
741	/** Receive cancelled */
742	#define VERR_IPC_RECEIVE_CANCELLED (-556)
743	/** Send cancelled */
744	#define VERR_IPC_SEND_CANCELLED (-557)
745	/** Receive aborted */
746	#define VERR_IPC_RECEIVE_ABORTED (-558)
747	/** Send aborted */
748	#define VERR_IPC_SEND_ABORTED (-559)
749	/** Couldn't map pages during receive */
750	#define VERR_IPC_RECEIVE_MAP_FAILED (-560)
751	/** Couldn't map pages during send */
752	#define VERR_IPC_SEND_MAP_FAILED (-561)
753	/** Send pagefault timeout in receive */
754	#define VERR_IPC_RECEIVE_SEND_PF_TIMEOUT (-562)
755	/** Send pagefault timeout in send */
756	#define VERR_IPC_SEND_SEND_PF_TIMEOUT (-563)
757	/** (One) receive buffer was too small, or too few buffers */
758	#define VINF_IPC_RECEIVE_MSG_CUT 564
759	/** (One) send buffer was too small, or too few buffers */
760	#define VINF_IPC_SEND_MSG_CUT 565
761	/** Dataspace manager server not found */
762	#define VERR_L4_DS_MANAGER_NOT_FOUND (-566)
763	/** @} */
764
765
766	/** @name Loader Status Codes.
767	* @{
768	*/
769	/** Invalid executable signature. */
770	#define VERR_INVALID_EXE_SIGNATURE (-600)
771	/** The iprt loader recognized a ELF image, but doesn't support loading it. */
772	#define VERR_ELF_EXE_NOT_SUPPORTED (-601)
773	/** The iprt loader recognized a PE image, but doesn't support loading it. */
774	#define VERR_PE_EXE_NOT_SUPPORTED (-602)
775	/** The iprt loader recognized a LX image, but doesn't support loading it. */
776	#define VERR_LX_EXE_NOT_SUPPORTED (-603)
777	/** The iprt loader recognized a LE image, but doesn't support loading it. */
778	#define VERR_LE_EXE_NOT_SUPPORTED (-604)
779	/** The iprt loader recognized a NE image, but doesn't support loading it. */
780	#define VERR_NE_EXE_NOT_SUPPORTED (-605)
781	/** The iprt loader recognized a MZ image, but doesn't support loading it. */
782	#define VERR_MZ_EXE_NOT_SUPPORTED (-606)
783	/** The iprt loader recognized an a.out image, but doesn't support loading it. */
784	#define VERR_AOUT_EXE_NOT_SUPPORTED (-607)
785	/** Bad executable. */
786	#define VERR_BAD_EXE_FORMAT (-608)
787	/** Symbol (export) not found. */
788	#define VERR_SYMBOL_NOT_FOUND (-609)
789	/** Module not found. */
790	#define VERR_MODULE_NOT_FOUND (-610)
791	/** The loader resolved an external symbol to an address to big for the image format. */
792	#define VERR_SYMBOL_VALUE_TOO_BIG (-611)
793	/** The image is too big. */
794	#define VERR_IMAGE_TOO_BIG (-612)
795	/** The image base address is to high for this image type. */
796	#define VERR_IMAGE_BASE_TOO_HIGH (-614)
797	/** The PE loader encountered delayed imports, a feature which hasn't been implemented yet. */
798	#define VERR_LDRPE_DELAY_IMPORT (-620)
799	/** The PE loader doesn't have a clue what the security data directory entry is all about. */
800	#define VERR_LDRPE_SECURITY (-621)
801	/** The PE loader doesn't know how to deal with the global pointer data directory entry yet. */
802	#define VERR_LDRPE_GLOBALPTR (-622)
803	/** The PE loader doesn't support the TLS data directory yet. */
804	#define VERR_LDRPE_TLS (-623)
805	/** The PE loader doesn't grok the COM descriptor data directory entry. */
806	#define VERR_LDRPE_COM_DESCRIPTOR (-624)
807	/** The PE loader encountered an unknown load config directory/header size. */
808	#define VERR_LDRPE_LOAD_CONFIG_SIZE (-625)
809	/** The PE loader encountered a lock prefix table, a feature which hasn't been implemented yet. */
810	#define VERR_LDRPE_LOCK_PREFIX_TABLE (-626)
811	/** The ELF loader doesn't handle foreign endianness. */
812	#define VERR_LDRELF_ODD_ENDIAN (-630)
813	/** The ELF image is 'dynamic', the ELF loader can only deal with 'relocatable' images at present. */
814	#define VERR_LDRELF_DYN (-631)
815	/** The ELF image is 'executable', the ELF loader can only deal with 'relocatable' images at present. */
816	#define VERR_LDRELF_EXEC (-632)
817	/** The ELF image was created for an unsupported target machine type. */
818	#define VERR_LDRELF_MACHINE (-633)
819	/** The ELF version is not supported. */
820	#define VERR_LDRELF_VERSION (-634)
821	/** The ELF loader cannot handle multiple SYMTAB sections. */
822	#define VERR_LDRELF_MULTIPLE_SYMTABS (-635)
823	/** The ELF loader encountered a relocation type which is not implemented. */
824	#define VERR_LDRELF_RELOCATION_NOT_SUPPORTED (-636)
825	/** The ELF loader encountered a bad symbol index. */
826	#define VERR_LDRELF_INVALID_SYMBOL_INDEX (-637)
827	/** The ELF loader encountered an invalid symbol name offset. */
828	#define VERR_LDRELF_INVALID_SYMBOL_NAME_OFFSET (-638)
829	/** The ELF loader encountered an invalid relocation offset. */
830	#define VERR_LDRELF_INVALID_RELOCATION_OFFSET (-639)
831	/** The ELF loader didn't find the symbol/string table for the image. */
832	#define VERR_LDRELF_NO_SYMBOL_OR_NO_STRING_TABS (-640)
833	/** @}*/
834
835	/** @name Debug Info Reader Status Codes.
836	* @{
837	*/
838	/** The specified segment:offset address was invalid. Typically an attempt at
839	* addressing outside the segment boundrary. */
840	#define VERR_DBGMOD_INVALID_ADDRESS (-650)
841	/** @} */
842
843	/** @name Request Packet Status Codes.
844	* @{
845	*/
846	/** Invalid RT request type.
847	* For the RTReqAlloc() case, the caller just specified an illegal enmType. For
848	* all the other occurences it means indicates corruption, broken logic, or stupid
849	* interface user. */
850	#define VERR_RT_REQUEST_INVALID_TYPE (-700)
851	/** Invalid RT request state.
852	* The state of the request packet was not the expected and accepted one(s). Either
853	* the interface user screwed up, or we've got corruption/broken logic. */
854	#define VERR_RT_REQUEST_STATE (-701)
855	/** Invalid RT request packet.
856	* One or more of the RT controlled packet members didn't contain the correct
857	* values. Some thing's broken. */
858	#define VERR_RT_REQUEST_INVALID_PACKAGE (-702)
859	/** The status field has not been updated yet as the request is still
860	* pending completion. Someone queried the iStatus field before the request
861	* has been fully processed. */
862	#define VERR_RT_REQUEST_STATUS_STILL_PENDING (-703)
863	/** The request has been freed, don't read the status now.
864	* Someone is reading the iStatus field of a freed request packet. */
865	#define VERR_RT_REQUEST_STATUS_FREED (-704)
866	/** @} */
867
868	/** @name Environment Status Code
869	* @{
870	*/
871	/** The specified environment variable was not found. (RTEnvGetEx) */
872	#define VERR_ENV_VAR_NOT_FOUND (-750)
873	/** The specified environment variable was not found. (RTEnvUnsetEx) */
874	#define VINF_ENV_VAR_NOT_FOUND (750)
875	/** @} */
876
877	/** @name Multiprocessor Status Code
878	* @{
879	*/
880	/** The specified cpu is offline. */
881	#define VERR_CPU_OFFLINE (-800)
882	/** The specified cpu was not found. */
883	#define VERR_CPU_NOT_FOUND (-801)
884	/** @} */
885
886	/* SED-END */
887
888	/** @} */
889
890	__END_DECLS
891
892	#endif
893

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

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

Download in other formats: