VirtualBox

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

Last change on this file since 204 was 10, checked in by vboxsync, 18 years ago

spelling

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 28.6 KB
Line 
1/** @file
2 * InnoTek Portable Runtime - Status Codes.
3 */
4
5/*
6 * Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * If you received this file as part of a commercial VirtualBox
17 * distribution, then only the terms of your commercial VirtualBox
18 * license agreement apply instead of the previous paragraph.
19 */
20
21
22#ifndef __iprt_err_h__
23#define __iprt_err_h__
24
25#include <iprt/cdefs.h>
26#include <iprt/types.h>
27
28__BEGIN_DECLS
29
30/** @defgroup grp_rt_err RTErr - Status Codes
31 * @ingroup grp_rt
32 * @{
33 */
34/* SED-START */
35
36/** @name Misc. Status Codes
37 * @{
38 */
39/** Success. */
40#define VINF_SUCCESS 0
41
42/** General failure - DON'T USE THIS!!!
43 * (aka SUPDRV_ERR_GENERAL_FAILURE) */
44#define VERR_GENERAL_FAILURE (-1)
45/** Invalid parameter.
46 * (aka SUPDRV_ERR_INVALID_PARAM) */
47#define VERR_INVALID_PARAMETER (-2)
48/** Invalid magic or cookie.
49 * (aka SUPDRV_ERR_INVALID_MAGIC) */
50#define VERR_INVALID_MAGIC (-3)
51/** Invalid loader handle.
52 * (aka SUPDRV_ERR_INVALID_HANDLE) */
53#define VERR_INVALID_HANDLE (-4)
54/** Failed to lock the address range.
55 * (aka SUPDRV_ERR_INVALID_HANDLE) */
56#define VERR_LOCK_FAILED (-5)
57/** Invalid memory pointer.
58 * (aka SUPDRV_ERR_INVALID_POINTER) */
59#define VERR_INVALID_POINTER (-6)
60/** Failed to patch the IDT.
61 * (aka SUPDRV_ERR_IDT_FAILED) */
62#define VERR_IDT_FAILED (-7)
63/** Memory allocation failed.
64 * (aka SUPDRV_ERR_NO_MEMORY) */
65#define VERR_NO_MEMORY (-8)
66/** Already loaded.
67 * (aka SUPDRV_ERR_ALREADY_LOADED) */
68#define VERR_ALREADY_LOADED (-9)
69/** Permission denied.
70 * (aka SUPDRV_ERR_PERMISSION_DENIED) */
71#define VERR_PERMISSION_DENIED (-10)
72/** Version mismatch.
73 * (aka SUPDRV_ERR_VERSION_MISMATCH) */
74#define VERR_VERSION_MISMATCH (-11)
75/** The request function is not implemented. */
76#define VERR_NOT_IMPLEMENTED (-12)
77
78/** Failed to allocate temporary memory. */
79#define VERR_NO_TMP_MEMORY (-20)
80/** Invalid file mode mask (RTFMODE). */
81#define VERR_INVALID_FMODE (-21)
82/** Incorrect call order. */
83#define VERR_WRONG_ORDER (-22)
84/** There is no TLS (thread local storage) available for storing the current thread. */
85#define VERR_NO_TLS_FOR_SELF (-23)
86/** Failed to set the TLS (thread local storage) entry which points to our thread structure. */
87#define VERR_FAILED_TO_SET_SELF_TLS (-24)
88/** Not able to allocate contiguous memory. */
89#define VERR_NO_CONT_MEMORY (-26)
90/** No memory available for page table or page directory. */
91#define VERR_NO_PAGE_MEMORY (-27)
92/** Already initialized. */
93#define VINF_ALREADY_INITIALIZED 28
94/** The specified thread is dead. */
95#define VERR_THREAD_IS_DEAD (-29)
96/** The specified thread is not waitable. */
97#define VERR_THREAD_NOT_WAITABLE (-30)
98/** Pagetable not present. */
99#define VERR_PAGE_TABLE_NOT_PRESENT (-31)
100/** Internal error - we're screwed if this happens. */
101#define VERR_INTERNAL_ERROR (-32)
102/** The per process timer is busy. */
103#define VERR_TIMER_BUSY (-33)
104/** Address conflict. */
105#define VERR_ADDRESS_CONFLICT (-34)
106/** Unresolved (unknown) host platform error. */
107#define VERR_UNRESOLVED_ERROR (-35)
108/** Invalid function. */
109#define VERR_INVALID_FUNCTION (-36)
110/** Not supported. */
111#define VERR_NOT_SUPPORTED (-37)
112/** Access denied. */
113#define VERR_ACCESS_DENIED (-38)
114/** Call interrupted. */
115#define VERR_INTERRUPTED (-39)
116/** Timeout. */
117#define VERR_TIMEOUT (-40)
118/** Buffer too small to save result. */
119#define VERR_BUFFER_OVERFLOW (-41)
120/** Buffer too small to save result. */
121#define VINF_BUFFER_OVERFLOW 41
122/** Data size overflow. */
123#define VERR_TOO_MUCH_DATA (-42)
124/** Max threads number reached. */
125#define VERR_MAX_THRDS_REACHED (-43)
126/** Max process number reached. */
127#define VERR_MAX_PROCS_REACHED (-44)
128/** The recipient process has refused the signal. */
129#define VERR_SIGNAL_REFUSED (-45)
130/** A signal is already pending. */
131#define VERR_SIGNAL_PENDING (-46)
132/** The signal being posted is not correct. */
133#define VERR_SIGNAL_INVALID (-47)
134/** The state changed.
135 * This is a generic error message and needs a context to make sense. */
136#define VERR_STATE_CHANGED (-48)
137/** Warning, the state changed.
138 * This is a generic error message and needs a context to make sense. */
139#define VWRN_STATE_CHANGED 48
140/** Error while parsing UUID string */
141#define VERR_INVALID_UUID_FORMAT (-49)
142/** The specified process was not found. */
143#define VERR_PROCESS_NOT_FOUND (-50)
144/** The process specified to a non-block wait had not exitted. */
145#define VERR_PROCESS_RUNNING (-51)
146/** Retry the operation. */
147#define VERR_TRY_AGAIN (-52)
148/** Generic parse error. */
149#define VERR_PARSE_ERROR (-53)
150/** Value out of range. */
151#define VERR_OUT_OF_RANGE (-54)
152/** A numeric convertion encountered a value which was too big for the target. */
153#define VERR_NUMBER_TOO_BIG (-55)
154/** A numeric convertion encountered a value which was too big for the target. */
155#define VWRN_NUMBER_TOO_BIG 55
156/** The number begin converted (string) contained no digits. */
157#define VERR_NO_DIGITS (-56)
158/** The number begin converted (string) contained no digits. */
159#define VWRN_NO_DIGITS 56
160/** Encountered a '-' during convertion to an unsigned value. */
161#define VERR_NEGATIVE_UNSIGNED (-57)
162/** Encountered a '-' during convertion to an unsigned value. */
163#define VWRN_NEGATIVE_UNSIGNED 57
164/** Error while characters translation (unicode and so). */
165#define VERR_NO_TRANSLATION (-58)
166/** Encountered unicode code point which is reserved for use as endian indicator (0xffff or 0xfffe). */
167#define VERR_CODE_POINT_ENDIAN_INDICATOR (-59)
168/** Encountered unicode code point in the surrogate range (0xd800 to 0xdfff). */
169#define VERR_CODE_POINT_SURROGATE (-60)
170/** A string claiming to be UTF-8 is incorrectly encoded. */
171#define VERR_INVALID_UTF8_ENCODING (-61)
172/** Ad string claiming to be in UTF-16 is incorrectly encoded. */
173#define VERR_INVALID_UTF16_ENCODING (-62)
174/** Encountered a unicode code point which cannot be represented as UTF-16. */
175#define VERR_CANT_RECODE_AS_UTF16 (-63)
176/** Got an out of memory condition trying to allocate a string. */
177#define VERR_NO_STR_MEMORY (-64)
178/** Got an out of memory condition trying to allocate a UTF-16 (/UCS-2) string. */
179#define VERR_NO_UTF16_MEMORY (-65)
180/** Get an out of memory condition trying to allocate a code point array. */
181#define VERR_NO_CODE_POINT_MEMORY (-66)
182/** Can't free the memory because it's used in mapping. */
183#define VERR_MEMORY_BUSY (-67)
184/** The timer can't be started because it's already active. */
185#define VERR_TIMER_ACTIVE (-68)
186/** The timer can't be stopped because i's already suspended. */
187#define VERR_TIMER_SUSPENDED (-69)
188/** The operation was cancelled by the user. */
189#define VERR_CANCELLED (-70)
190
191/** @} */
192
193
194/** @name Common File/Disk/Pipe/etc Status Codes
195 * @{
196 */
197/** Unresolved (unknown) file i/o error. */
198#define VERR_FILE_IO_ERROR (-100)
199/** File/Device open failed. */
200#define VERR_OPEN_FAILED (-101)
201/** File not found. */
202#define VERR_FILE_NOT_FOUND (-102)
203/** Path not found. */
204#define VERR_PATH_NOT_FOUND (-103)
205/** Invalid (malformed) file/path name. */
206#define VERR_INVALID_NAME (-104)
207/** File/Device already exists. */
208#define VERR_ALREADY_EXISTS (-105)
209/** Too many open files. */
210#define VERR_TOO_MANY_OPEN_FILES (-106)
211/** Seek error. */
212#define VERR_SEEK (-107)
213/** Seek below file start. */
214#define VERR_NEGATIVE_SEEK (-108)
215/** Trying to seek on device. */
216#define VERR_SEEK_ON_DEVICE (-109)
217/** Reached the end of the file. */
218#define VERR_EOF (-110)
219/** Reached the end of the file. */
220#define VINF_EOF 110
221/** Generic file read error. */
222#define VERR_READ_ERROR (-111)
223/** Generic file write error. */
224#define VERR_WRITE_ERROR (-112)
225/** Write protect error. */
226#define VERR_WRITE_PROTECT (-113)
227/** Sharing violetion, file is being used by another process. */
228#define VERR_SHARING_VIOLATION (-114)
229/** Unable to lock a region of a file. */
230#define VERR_FILE_LOCK_FAILED (-115)
231/** File access error, another process has locked a portion of the file. */
232#define VERR_FILE_LOCK_VIOLATION (-116)
233/** File or directory can't be created. */
234#define VERR_CANT_CREATE (-117)
235/** Directory can't be deleted. */
236#define VERR_CANT_DELETE_DIRECTORY (-118)
237/** Can't move file to another disk. */
238#define VERR_NOT_SAME_DEVICE (-119)
239/** The filename or extension is too long. */
240#define VERR_FILENAME_TOO_LONG (-120)
241/** Media not present in drive. */
242#define VERR_MEDIA_NOT_PRESENT (-121)
243/** The type of media was not recognized. Not formatted? */
244#define VERR_MEDIA_NOT_RECOGNIZED (-122)
245/** Can't unlock - region was not locked. */
246#define VERR_FILE_NOT_LOCKED (-123)
247/** Unrecoverable error: lock was lost. */
248#define VERR_FILE_LOCK_LOST (-124)
249/** Can't delete directory with files. */
250#define VERR_DIR_NOT_EMPTY (-125)
251/** A directory operation was attempted on a non-directory object. */
252#define VERR_NOT_A_DIRECTORY (-126)
253/** A non-directory operation was attempted on a directory object. */
254#define VERR_IS_A_DIRECTORY (-127)
255/** @} */
256
257
258/** @name Generic Filesystem I/O Status Codes
259 * @{
260 */
261/** Unresolved (unknown) disk i/o error. */
262#define VERR_DISK_IO_ERROR (-150)
263/** Invalid drive number. */
264#define VERR_INVALID_DRIVE (-151)
265/** Disk is full. */
266#define VERR_DISK_FULL (-152)
267/** Disk was changed. */
268#define VERR_DISK_CHANGE (-153)
269/** Drive is locked. */
270#define VERR_DRIVE_LOCKED (-154)
271/** The specified disk or diskette cannot be accessed. */
272#define VERR_DISK_INVALID_FORMAT (-155)
273/** Too many symbolic links. */
274#define VERR_TOO_MANY_SYMLINKS (-156)
275/** @} */
276
277
278/** @name Generic Directory Enumeration Status Codes
279 * @{
280 */
281/** Unresolved (unknown) search error. */
282#define VERR_SEARCH_ERROR (-200)
283/** No more files found. */
284#define VERR_NO_MORE_FILES (-201)
285/** No more search handles available. */
286#define VERR_NO_MORE_SEARCH_HANDLES (-202)
287/** RTDirReadEx() failed to retrieve the extra data which was requested. */
288#define VWRN_NO_DIRENT_INFO 203
289/** @} */
290
291
292/** @name Generic Device I/O Status Codes
293 * @{
294 */
295/** Unresolved (unknown) device i/o error. */
296#define VERR_DEV_IO_ERROR (-250)
297/** Device i/o: Bad unit. */
298#define VERR_IO_BAD_UNIT (-251)
299/** Device i/o: Not ready. */
300#define VERR_IO_NOT_READY (-252)
301/** Device i/o: Bad command. */
302#define VERR_IO_BAD_COMMAND (-253)
303/** Device i/o: CRC error. */
304#define VERR_IO_CRC (-254)
305/** Device i/o: Bad length. */
306#define VERR_IO_BAD_LENGTH (-255)
307/** Device i/o: Sector not found. */
308#define VERR_IO_SECTOR_NOT_FOUND (-256)
309/** Device i/o: General failure. */
310#define VERR_IO_GEN_FAILURE (-257)
311/** @} */
312
313
314/** @name Generic Pipe I/O Status Codes
315 * @{
316 */
317/** Unresolved (unknown) pipe i/o error. */
318#define VERR_PIPE_IO_ERROR (-300)
319/** Broken pipe. */
320#define VERR_BROKEN_PIPE (-301)
321/** Bad pipe. */
322#define VERR_BAD_PIPE (-302)
323/** Pipe is busy. */
324#define VERR_PIPE_BUSY (-303)
325/** No data in pipe. */
326#define VERR_NO_DATA (-304)
327/** Pipe is not connected. */
328#define VERR_PIPE_NOT_CONNECTED (-305)
329/** More data available in pipe. */
330#define VERR_MORE_DATA (-306)
331/** @} */
332
333
334/** @name Generic Semaphores Status Codes
335 * @{
336 */
337/** Unresolved (unknown) semaphore error. */
338#define VERR_SEM_ERROR (-350)
339/** Too many semaphores. */
340#define VERR_TOO_MANY_SEMAPHORES (-351)
341/** Exclusive semaphore is owned by another process. */
342#define VERR_EXCL_SEM_ALREADY_OWNED (-352)
343/** The semaphore is set and cannot be closed. */
344#define VERR_SEM_IS_SET (-353)
345/** The semaphore cannot be set again. */
346#define VERR_TOO_MANY_SEM_REQUESTS (-354)
347/** Attempt to release mutex not owned by caller. */
348#define VERR_NOT_OWNER (-355)
349/** The semaphore has been opened too many times. */
350#define VERR_TOO_MANY_OPENS (-356)
351/** The maximum posts for the event semaphore has been reached. */
352#define VERR_TOO_MANY_POSTS (-357)
353/** The event semaphore has already been posted. */
354#define VERR_ALREADY_POSTED (-358)
355/** The event semaphore has already been reset. */
356#define VERR_ALREADY_RESET (-359)
357/** The semaphore is in use. */
358#define VERR_SEM_BUSY (-360)
359/** The previous ownership of this semaphore has ended. */
360#define VERR_SEM_OWNER_DIED (-361)
361/** Failed to open semaphore by name - not found. */
362#define VERR_SEM_NOT_FOUND (-362)
363/** Semaphore destroyed while waiting. */
364#define VERR_SEM_DESTROYED (-363)
365/** Nested ownership requests are not permitted for this semaphore type. */
366#define VERR_SEM_NESTED (-364)
367/** Deadlock detected. */
368#define VERR_DEADLOCK (-365)
369/** Ping-Pong listen or speak out of turn error. */
370#define VERR_SEM_OUT_OF_TURN (-366)
371/** @} */
372
373
374/** @name Generic Network I/O Status Codes
375 * @{
376 */
377/** Unresolved (unknown) network error. */
378#define VERR_NET_IO_ERROR (-400)
379/** The network is busy or is out of resources. */
380#define VERR_NET_OUT_OF_RESOURCES (-401)
381/** Net host name not found. */
382#define VERR_NET_HOST_NOT_FOUND (-402)
383/** Network path not found. */
384#define VERR_NET_PATH_NOT_FOUND (-403)
385/** General network printing error. */
386#define VERR_NET_PRINT_ERROR (-404)
387/** The machine is not on the network. */
388#define VERR_NET_NO_NETWORK (-405)
389/** Name is not unique on the network. */
390#define VERR_NET_NOT_UNIQUE_NAME (-406)
391
392/* These are BSD networking error codes - numbers correspond, don't mess! */
393/** Operation in progress. */
394#define VERR_NET_IN_PROGRESS (-436)
395/** Operation already in progress. */
396#define VERR_NET_ALREADY_IN_PROGRESS (-437)
397/** Attempted socket operation with a non-socket handle.
398 * (This includes closed handles.) */
399#define VERR_NET_NOT_SOCKET (-438)
400/** Destination address required. */
401#define VERR_NET_DEST_ADDRESS_REQUIRED (-439)
402/** Message too long. */
403#define VERR_NET_MSG_SIZE (-440)
404/** Protocol wrong type for socket. */
405#define VERR_NET_PROTOCOL_TYPE (-441)
406/** Protocol not available. */
407#define VERR_NET_PROTOCOL_NOT_AVAILABLE (-442)
408/** Protocol not supported. */
409#define VERR_NET_PROTOCOL_NOT_SUPPORTED (-443)
410/** Socket type not supported. */
411#define VERR_NET_SOCKET_TYPE_NOT_SUPPORTED (-444)
412/** Operation not supported. */
413#define VERR_NET_OPERATION_NOT_SUPPORTED (-445)
414/** Protocol family not supported. */
415#define VERR_NET_PROTOCOL_FAMILY_NOT_SUPPORTED (-446)
416/** Address family not supported by protocol family. */
417#define VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED (-447)
418/** Address already in use. */
419#define VERR_NET_ADDRESS_IN_USE (-448)
420/** Can't assign requested address. */
421#define VERR_NET_ADDRESS_NOT_AVAILABLE (-449)
422/** Network is down. */
423#define VERR_NET_DOWN (-450)
424/** Network is unreachable. */
425#define VERR_NET_UNREACHABLE (-451)
426/** Network dropped connection on reset. */
427#define VERR_NET_CONNECTION_RESET (-452)
428/** Software caused connection abort. */
429#define VERR_NET_CONNECTION_ABORTED (-453)
430/** Connection reset by peer. */
431#define VERR_NET_CONNECTION_RESET_BY_PEER (-454)
432/** No buffer space available. */
433#define VERR_NET_NO_BUFFER_SPACE (-455)
434/** Socket is already connected. */
435#define VERR_NET_ALREADY_CONNECTED (-456)
436/** Socket is not connected. */
437#define VERR_NET_NOT_CONNECTED (-457)
438/** Can't send after socket shutdown. */
439#define VERR_NET_SHUTDOWN (-458)
440/** Too many references: can't splice. */
441#define VERR_NET_TOO_MANY_REFERENCES (-459)
442/* ETIMEDOUT is not net. */
443/** Connection refused. */
444#define VERR_NET_CONNECTION_REFUSED (-461)
445/* ELOOP is not net. */
446/* ENAMETOOLONG is not net. */
447/** Host is down. */
448#define VERR_NET_HOST_DOWN (-464)
449/** No route to host. */
450#define VERR_NET_HOST_UNREACHABLE (-465)
451/** @} */
452
453
454/** @name TCP Status Codes
455 * @{
456 */
457/** Stop the TCP server. */
458#define VERR_TCP_SERVER_STOP (-500)
459/** The server was stopped. */
460#define VINF_TCP_SERVER_STOP 500
461/** @} */
462
463
464/** @name L4 Specific Status Codes
465 * @{
466 */
467/** Invalid offset in an L4 dataspace */
468#define VERR_L4_INVALID_DS_OFFSET (-550)
469/** IPC error */
470#define VERR_IPC (-551)
471/** Item already used */
472#define VERR_RESOURCE_IN_USE (-552)
473/** Source/destination not found */
474#define VERR_IPC_PROCESS_NOT_FOUND (-553)
475/** Receive timeout */
476#define VERR_IPC_RECEIVE_TIMEOUT (-554)
477/** Send timeout */
478#define VERR_IPC_SEND_TIMEOUT (-555)
479/** Receive cancelled */
480#define VERR_IPC_RECEIVE_CANCELLED (-556)
481/** Send cancelled */
482#define VERR_IPC_SEND_CANCELLED (-557)
483/** Receive aborted */
484#define VERR_IPC_RECEIVE_ABORTED (-558)
485/** Send aborted */
486#define VERR_IPC_SEND_ABORTED (-559)
487/** Couldn't map pages during receive */
488#define VERR_IPC_RECEIVE_MAP_FAILED (-560)
489/** Couldn't map pages during send */
490#define VERR_IPC_SEND_MAP_FAILED (-561)
491/** Send pagefault timeout in receive */
492#define VERR_IPC_RECEIVE_SEND_PF_TIMEOUT (-562)
493/** Send pagefault timeout in send */
494#define VERR_IPC_SEND_SEND_PF_TIMEOUT (-563)
495/** (One) receive buffer was too small, or too few buffers */
496#define VINF_IPC_RECEIVE_MSG_CUT 564
497/** (One) send buffer was too small, or too few buffers */
498#define VINF_IPC_SEND_MSG_CUT 565
499/** Dataspace manager server not found */
500#define VERR_L4_DS_MANAGER_NOT_FOUND (-566)
501/** @} */
502
503
504/** @name Loader Status Codes.
505 * @{
506 */
507/** Invalid executable signature. */
508#define VERR_INVALID_EXE_SIGNATURE (-600)
509/** The iprt loader recognized a ELF image, but doesn't support loading it. */
510#define VERR_ELF_EXE_NOT_SUPPORTED (-601)
511/** The iprt loader recognized a PE image, but doesn't support loading it. */
512#define VERR_PE_EXE_NOT_SUPPORTED (-602)
513/** The iprt loader recognized a LX image, but doesn't support loading it. */
514#define VERR_LX_EXE_NOT_SUPPORTED (-603)
515/** The iprt loader recognized a LE image, but doesn't support loading it. */
516#define VERR_LE_EXE_NOT_SUPPORTED (-604)
517/** The iprt loader recognized a NE image, but doesn't support loading it. */
518#define VERR_NE_EXE_NOT_SUPPORTED (-605)
519/** The iprt loader recognized a MZ image, but doesn't support loading it. */
520#define VERR_MZ_EXE_NOT_SUPPORTED (-606)
521/** The iprt loader recognized an a.out image, but doesn't support loading it. */
522#define VERR_AOUT_EXE_NOT_SUPPORTED (-607)
523/** Bad executable. */
524#define VERR_BAD_EXE_FORMAT (-608)
525/** Symbol (export) not found. */
526#define VERR_SYMBOL_NOT_FOUND (-609)
527/** Module not found. */
528#define VERR_MODULE_NOT_FOUND (-610)
529/** The loader resolved an external symbol to an address to big for the image format. */
530#define VERR_SYMBOL_VALUE_TOO_BIG (-611)
531/** The image is too big. */
532#define VERR_IMAGE_TOO_BIG (-612)
533/** The image base address is to high for this image type. */
534#define VERR_IMAGE_BASE_TOO_HIGH (-614)
535/** The PE loader encountered delayed imports, a feature which hasn't been implemented yet. */
536#define VERR_LDRPE_DELAY_IMPORT (-620)
537/** The PE loader doesn't have a clue what the security data directory entry is all about. */
538#define VERR_LDRPE_SECURITY (-621)
539/** The PE loader doesn't know how to deal with the global pointer data directory entry yet. */
540#define VERR_LDRPE_GLOBALPTR (-622)
541/** The PE loader doesn't support the TLS data directory yet. */
542#define VERR_LDRPE_TLS (-623)
543/** The PE loader doesn't grok the COM descriptor data directory entry. */
544#define VERR_LDRPE_COM_DESCRIPTOR (-624)
545/** The PE loader encountered an unknown load config directory/header size. */
546#define VERR_LDRPE_LOAD_CONFIG_SIZE (-625)
547/** The PE loader encountered a lock prefix table, a feature which hasn't been implemented yet. */
548#define VERR_LDRPE_LOCK_PREFIX_TABLE (-626)
549/** The ELF loader doesn't handle foreign endianness. */
550#define VERR_LDRELF_ODD_ENDIAN (-630)
551/** The ELF image is 'dynamic', the ELF loader can only deal with 'relocatable' images at present. */
552#define VERR_LDRELF_DYN (-631)
553/** The ELF image is 'executable', the ELF loader can only deal with 'relocatable' images at present. */
554#define VERR_LDRELF_EXEC (-632)
555/** The ELF image was created for an unsupported target machine type. */
556#define VERR_LDRELF_MACHINE (-633)
557/** The ELF version is not supported. */
558#define VERR_LDRELF_VERSION (-634)
559/** The ELF loader cannot handle multiple SYMTAB sections. */
560#define VERR_LDRELF_MULTIPLE_SYMTABS (-635)
561/** The ELF loader encountered a relocation type which is not implemented. */
562#define VERR_LDRELF_RELOCATION_NOT_SUPPORTED (-636)
563/** The ELF loader encountered a bad symbol index. */
564#define VERR_LDRELF_INVALID_SYMBOL_INDEX (-637)
565/** The ELF loader encountered an invalid symbol name offset. */
566#define VERR_LDRELF_INVALID_SYMBOL_NAME_OFFSET (-638)
567/** The ELF loader encountered an invalid relocation offset. */
568#define VERR_ELFLDR_INVALID_RELOCATION_OFFSET (-639)
569/** @}*/
570
571/** @name Debug Info Reader Status Codes.
572 * @{
573 */
574/** The specified segment:offset address was invalid. Typically an attempt at
575 * addressing outside the segment boundrary. */
576#define VERR_DBGMOD_INVALID_ADDRESS (-650)
577/** @} */
578
579
580/* SED-END */
581
582
583/** @defgroup grp_rt_err_hlp Status Code Helpers
584 * @ingroup grp_rt_err
585 * @{
586 */
587
588/** @def RT_SUCCESS
589 * Check for success. We expect success in normal cases, that is the code path depending on
590 * this check is normally taken. To prevent any prediction use RT_SUCCESS_NP instead.
591 *
592 * @returns true if rc indicates success.
593 * @returns false if rc indicates failure.
594 *
595 * @param rc The iprt status code to test.
596 */
597#define RT_SUCCESS(rc) ( RT_LIKELY((int)(rc) >= VINF_SUCCESS) )
598
599/** @def RT_SUCCESS_NP
600 * Check for success. Don't predict the result.
601 *
602 * @returns true if rc indicates success.
603 * @returns false if rc indicates failure.
604 *
605 * @param rc The iprt status code to test.
606 */
607#define RT_SUCCESS_NP(rc) ( (int)(rc) >= VINF_SUCCESS )
608
609/** @def RT_FAILURE
610 * Check for failure. We don't expect in normal cases, that is the code path depending on
611 * this check is normally NOT taken. To prevent any prediction use RT_FAILURE_NP instead.
612 *
613 * @returns true if rc indicates failure.
614 * @returns false if rc indicates success.
615 *
616 * @param rc The iprt status code to test.
617 */
618#define RT_FAILURE(rc) ( RT_UNLIKELY(!RT_SUCCESS_NP(rc)) )
619
620/** @def RT_FAILURE_NP
621 * Check for failure. Don't predict the result.
622 *
623 * @returns true if rc indicates failure.
624 * @returns false if rc indicates success.
625 *
626 * @param rc The iprt status code to test.
627 */
628#define RT_FAILURE_NP(rc) ( !RT_SUCCESS_NP(rc) )
629
630/**
631 * Converts errno to iprt status code.
632 *
633 * @returns iprt status code.
634 * @param uNativeCode errno code.
635 */
636RTDECL(int) RTErrConvertFromErrno(unsigned uNativeCode);
637
638/**
639 * Converts Win32 error code to iprt status code.
640 *
641 * Needless to say, this is only available on Win32 targets.
642 *
643 * @returns iprt status code.
644 * @param uNativeCode Win32 error code.
645 */
646RTDECL(int) RTErrConvertFromWin32(unsigned uNativeCode);
647
648/**
649 * Converts NT status code to iprt status code.
650 *
651 * Needless to say, this is only available on NT and winXX targets.
652 *
653 * @returns iprt status code.
654 * @param lNativeCode NT status code.
655 */
656RTDECL(int) RTErrConvertFromNtStatus(long lNativeCode);
657
658/**
659 * Converts OS/2 error code to iprt status code.
660 *
661 * Needless to say, this is only available on OS/2 targets.
662 *
663 * @returns iprt status code.
664 * @param uNativeCode OS/2 error code.
665 */
666RTDECL(int) RTErrConvertFromOS2(unsigned uNativeCode);
667
668/**
669 * Converts a L4 errno to a iprt status code.
670 *
671 * @returns iprt status code.
672 * @param uNativeCode l4 errno.
673 */
674RTDECL(int) RTErrConvertFromL4Errno(unsigned uNativeCode);
675
676
677#ifdef IN_RING3
678
679/**
680 * iprt status code message.
681 */
682typedef struct RTSTATUSMSG
683{
684 /** Pointer to the short message string. */
685 const char *pszMsgShort;
686 /** Pointer to the full message string. */
687 const char *pszMsgFull;
688 /** Pointer to the define string. */
689 const char *pszDefine;
690 /** Status code number. */
691 int iCode;
692} RTSTATUSMSG;
693/** Pointer to iprt status code message. */
694typedef RTSTATUSMSG *PRTSTATUSMSG;
695/** Pointer to const iprt status code message. */
696typedef const RTSTATUSMSG *PCRTSTATUSMSG;
697
698/**
699 * Get the message structure corresponding to a given iprt status code.
700 *
701 * @returns Pointer to read-only message description.
702 * @param rc The status code.
703 */
704RTDECL(PCRTSTATUSMSG) RTErrGet(int rc);
705
706/**
707 * Get the define corresponding to a given iprt status code.
708 *
709 * @returns Pointer to read-only string with the \#define identifier.
710 * @param rc The status code.
711 */
712#define RTErrGetDefine(rc) (RTErrGet(rc)->pszDefine)
713
714/**
715 * Get the short description corresponding to a given iprt status code.
716 *
717 * @returns Pointer to read-only string with the description.
718 * @param rc The status code.
719 */
720#define RTErrGetShort(rc) (RTErrGet(rc)->pszMsgShort)
721
722/**
723 * Get the full description corresponding to a given iprt status code.
724 *
725 * @returns Pointer to read-only string with the description.
726 * @param rc The status code.
727 */
728#define RTErrGetFull(rc) (RTErrGet(rc)->pszMsgFull)
729
730#ifdef __WIN__
731/**
732 * Windows error code message.
733 */
734typedef struct RTWINERRMSG
735{
736 /** Pointer to the full message string. */
737 const char *pszMsgFull;
738 /** Pointer to the define string. */
739 const char *pszDefine;
740 /** Error code number. */
741 long iCode;
742} RTWINERRMSG;
743/** Pointer to Windows error code message. */
744typedef RTWINERRMSG *PRTWINERRMSG;
745/** Pointer to const Windows error code message. */
746typedef const RTWINERRMSG *PCRTWINERRMSG;
747
748/**
749 * Get the message structure corresponding to a given Windows error code.
750 *
751 * @returns Pointer to read-only message description.
752 * @param rc The status code.
753 */
754RTDECL(PCRTWINERRMSG) RTErrWinGet(long rc);
755#endif /* __WIN__ */
756
757#endif /* IN_RING3 */
758
759/** @} */
760
761/** @} */
762
763__END_DECLS
764
765#endif
766
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette