Copyright (c) 2012-2016 Hyperion Entertainment and contributors.
Difference between revisions of "AmigaDOS Vector-Port"
|Line 5:||Line 5:|
== Introduction ==
== Introduction ==
In the past, DOS library used to communicate with file systems and handlers
In the past, DOS library used to communicate with file systems and handlers using DOS packets . A DOS packet is merely an Exec Message with parameters and results . The aim to remain as generic as possible with abstracted parameters. work the developer to handle the packet.
Starting with version 53.77, DOS Library offers the new "Vector-Port" API
Starting with version 53.77, DOS Library offers the new "Vector-Port" APIexclusively for file systems. It is basically a [[Exec_Messages_and_Ports#Message_Ports|Message port]] with an associated function list (also called table of vectorsthus the API name). In this way, we are freed from many legacy (notably BSTRs) and the the .
== Legacy Support ==
== Legacy Support ==
Revision as of 20:09, 1 October 2015
During development of file systems, the developer often needs to write a lot of code just to interface with DOS library. The new Vector-port interface simplifies this by delegating most of this interface work to the DOS Library. This means that the developer writing the file system can concentrate on implementing the functions required.
In the past, DOS library used to communicate with file systems and handlers using DOS packets exclusively. A DOS packet is merely an Exec Message with parameters and results appended. The aim of this format is to remain as generic as possible with abstracted parameters. Unfortunately, this approach requires more overhead work for the developer to handle the packet, extract arguments from it and return results to it.
Starting with version 53.77, DOS Library offers the new "Vector-Port" API, exclusively for file systems. It is basically a Message port with an associated function list (also called 'table of vectors' thus the API name). In this way, we are freed from many legacy constructs (notably BPTRs and BSTRs) and the arguments are clearly defined. The semantics of each function are now defined, so different file systems should behave identically when written to follow the API rules.
Since version 53.95, DOS Library provides DOS packet emulation for legacy applications that still send DOS packets directly to the file system's Message Port. This effectively keeps these old applications from breaking on a complete Vector-Port based file system. This special DOS packet emulation functionality allows these 'application-sent' DOS packets to be automatically converted to equivalent Vector-Port calls.
Existing file system conversion
DOS allows for a step by step conversion of existing file systems to the Vector-Port API by falling back to sending a DOS packet when any Vector-Port function is NULL or the Vector-Port itself does not validate. This means that one can convert single functions one at a time by simply adding or removing the function vector from the Vector-Port initialisation table.
Formerly a file system was required to allocate a Message Port. Now it only needs to replace this creation by a call to DOS method AllocDosObject() requesting creation of a Vector-Port and providing it the list of implemented functions. Everything else is automatically handled. Any unimplemented functions DOS library will fallback to sending a DOS packet. One of the advantage of this solution is because it uses direct function calls, it is substantially faster than sending a message and waiting for its handling by the file system. It is also processed on the caller's context thus we benefit from the OS multitasking feature to parallelize calls and there is no expensive context switching.
Example for ACTION_LOCATE_OBJECT DOS packet and the corresponding "Vector-Port" function FSLock():
INPUTS (DosPacket method) dp_Type - (int32) ACTION_LOCATE_OBJECT dp_Arg1 - (BPTR) lock. dp_Arg2 - (BSTR) object_name. (may also include path) dp_Arg3 - (int32) Mode. SHARED_LOCK or EXCLUSIVE_LOCK. dp_Arg4 - <unused> 0 dp_Arg5 - (BSTR) nameformat - name format indicator value. only if(dp_Arg2==dp_Arg5) then BSTR's are guaranteed to be a nul-terminated string. (53.23) RESULT1 - (BPTR) Lock - (ZERO on failure.) RESULT2 - (int32) Failure code if RESULT1 == ZERO INPUTS (FileSystemVectorPort method) struct Lock * RESULT1 = FSLock(struct FileSystemVectorPort *fsvp, int32 *result2, struct Lock *rel, CONST_STRPTR name, int32 mode); fsvp - (struct FileSystemVectorPort *) Pointer to the vector port. result2 - (int32 *) Pointer to the storage area for RESULT2. rel_dir - (struct Lock *) Pointer to the 'name' reference dir lock. name - (CONST_STRPTR) Pointer to the object name.(no path component) mode - (int32) SHARED_LOCK, EXCLUSIVE_LOCK. RESULT1 - (struct Lock *) Pointer to the lock, NULL on failure. RESULT2 - (int32) Failure code if RESULT1 == NULL
FSVPtool creates a ready to use skeleton to help with creation of new file systems. This tool should be available in the latest SDK.
For further details and example code, refer to the autodoc: dos.dospackets.doc