Category : Miscellaneous Language Source Code
Archive   : EXEC33A.ZIP
Filename : EXEC.H

/*
--- Version 3.3 91-11-21 16:12 ---

EXEC.H: EXEC function with memory swap - Main function header file.

Public domain software by

Thomas Wagner
Ferrari electronic GmbH
Beusselstrasse 27
D-1000 Berlin 21
Germany
*/


extern int do_exec (char *xfn, char *pars, int spawn, unsigned needed,
char **envp);

/*>e
The EXEC function.

Parameters:

xfn is a string containing the name of the file
to be executed. If the string is empty,
the COMSPEC environment variable is used to
load a copy of COMMAND.COM or its equivalent.
If the filename does not include a path, the
current PATH is searched after the default.
If the filename does not include an extension,
the path is scanned for a COM, EXE, or BAT file
in that order.

pars The program parameters.

spawn If 0, the function will terminate after the
EXECed program returns, the function will not return.

NOTE: If the program file is not found, the function
will always return with the appropriate error
code, even if 'spawn' is 0.

If non-0, the function will return after executing the
program. If necessary (see the "needed" parameter),
memory will be swapped out before executing the program.
For swapping, spawn must contain a combination of the
following flags:

USE_EMS (0x01) - allow EMS swap
USE_XMS (0x02) - allow XMS swap
USE_FILE (0x04) - allow File swap

The order of trying the different swap methods can be
controlled with one of the flags

EMS_FIRST (0x00) - EMS, XMS, File (default)
XMS_FIRST (0x10) - XMS, EMS, File

If swapping is to File, the attribute of the swap file
can be set to "hidden", so users are not irritated by
strange files appearing out of nowhere with the flag

HIDE_FILE (0x40) - create swap file as hidden

and the behaviour on Network drives can be changed with

NO_PREALLOC (0x100) - don't preallocate
CHECK_NET (0x200) - don't preallocate if file on net.

This checking for Network is mainly to compensate for
a strange slowdown on Novell networks when preallocating
a file. You can either set NO_PREALLOC to avoid allocation
in any case, or let the prep_swap routine decide whether
to do preallocation or not depending on the file being
on a network drive (this will only work with DOS 3.1 or
later).

needed The memory needed for the program in paragraphs (16 Bytes).
If not enough memory is free, the program will
be swapped out.
Use 0 to never swap, 0xffff to always swap.
If 'spawn' is 0, this parameter is irrelevant.

envp The environment to be passed to the spawned
program. If this parameter is NULL, a copy
of the parent's environment is used (i.e.
'putenv' calls have no effect). If non-NULL,
envp must point to an array of pointers to
strings, terminated by a NULL pointer (the
standard variable 'environ' may be used).

Return value:

0x0000..00FF: The EXECed Program's return code

0x0101: Error preparing for swap: no space for swapping
0x0102: Error preparing for swap: program too low in memory

0x0200: Program file not found
0x0201: Program file: Invalid drive
0x0202: Program file: Invalid path
0x0203: Program file: Invalid name
0x0204: Program file: Invalid drive letter
0x0205: Program file: Path too long
0x0206: Program file: Drive not ready
0x0207: Batchfile/COMMAND: COMMAND.COM not found
0x0208: Error allocating temporary buffer

0x03xx: DOS-error-code xx calling EXEC

0x0400: Error allocating environment buffer

0x0500: Swapping requested, but prep_swap has not
been called or returned an error.
0x0501: MCBs don't match expected setup
0x0502: Error while swapping out

0x0600: Redirection syntax error
0x06xx: DOS error xx on redirection
<*/

/*>d
Die EXEC Funktion.

Parameter:

xfn ist ein String mit dem Namen der auszufhrenden Datei.
Ist der String leer, wird die COMSPEC Umgebungsvariable
benutzt um COMMAND.COM oder das Equivalent zu laden.
Ist kein Pfad angegeben, wird nach dem aktuellen Pfad
der in der PATH Umgebungsvariablen angegebene Pfad
durchsucht.
Ist kein Dateityp angegeben, wird der Pfad nach
einer COM oder EXE Datei (in dieser Reihenfolge) abgesucht.

pars Die Kommandozeile

spawn Wenn 0, wird der Programmlauf beendet wenn das
aufgerufene Programm zurckkehrt, die Funktion kehrt
nicht zurck.

HINWEIS: Wenn die auszufhrende Datei nicht gefunden
wird, kehrt die Funktion mit einem Fehlercode
zurck, auch wenn der 'spawn' Parameter 0 ist.

Wenn nicht 0, kehrt die Funktion nach Ausfhrung des
Programms zurck. Falls notwendig (siehe den Parameter
"needed") wird der Programmspeicherbereich vor Aufruf
ausgelagert.
Zur Auslagerung muá der Parameter eine Kombination der
folgenden Flags enthalten:

USE_EMS (0x01) - Auslagerung auf EMS zulassen
USE_XMS (0x02) - Auslagerung auf XMS zulassen
USE_FILE (0x04) - Auslagerung auf Datei zulassen

Die Reihenfolge der Versuche, auf die verschiedenen
Medien auszulagern kann mit einem der folgenden
Flags beeinfluát werden:

EMS_FIRST (0x00) - EMS, XMS, Datei (Standard)
XMS_FIRST (0x10) - XMS, EMS, Datei

Wenn die Auslagerung auf Datei erfolgt, kann das
Attribut dieser Datei auf "hidden" gesetzt werden,
damit der Benutzer nicht durch unversehends auftauchende
Dateien verwirrt wird:

HIDE_FILE (0x40) - Auslagerungsdatei "hidden" erzeugen

Auáerdem kann das Verhalten auf Netzwerk-Laufwerken
beeinfluát werden mit

NO_PREALLOC (0x100) - nicht Pr„allozieren
CHECK_NET (0x200) - nicht Pr„allozieren wenn Netz.

Diese Prfung auf Netzwerk ist haupts„chlich sinnvoll
fr Novell Netze, bei denen eine Pr„allozierung eine
erhebliche Verz”gerung bewirkt. Sie k”nnen entweder mit
NO_PREALLOC eine Pr„allozierung in jedem Fall ausschlieáen,
oder die Entscheidung mit CHECK_NET prep_swap berlassen.
In diesem Fall wird nicht pr„alloziert wenn die Datei
auf einem Netzwerk-Laufwerk liegt (funktioniert nur
mit DOS Version 3.1 und sp„teren).

needed Der zur Ausfhrung des Programms ben”tigte Speicher
in Paragraphen (16 Bytes). Wenn nicht ausreichend
freier Speicher vorhanden ist, wird der Programm-
speicherbereich ausgelagert.
Bei Angabe von 0 wird nie ausgelagert, bei Angabe
von 0xffff wird immer ausgelagert.
Ist der Parameter 'spawn' 0, hat 'needed' keine Bedeutung.

envp Die dem gerufenen Programm zu bergebenden
Umgebungsvariablen. Ist der Parameter NULL,
wird eine Kopie der Vater-Umgebung benutzt,
d.h. daá Aufrufe von "putenv" keinen Effekt haben.
Wenn nicht NULL muá envp auf ein Array von Zeigern
auf Strings zeigen, das durch einen NULL Zeiger
abgeschlossen wird. Hierfr kann die Standardvariable
"environ" benutzt werden.

Liefert:

0x0000..00FF: Rckgabewert des aufgerufenen Programms

0x0101: Fehler bei Vorbereitung zum Auslagern
kein Speicherplatz in XMS/EMS/Datei
0x0102: Fehler bei Vorbereitung zum Auslagern
der Programmcode ist zu nah am Beginn des
Programms.

0x0200: Auszufhrende Programmdatei nicht gefunden
0x0201: Programmdatei: Ungltiges Laufwerk
0x0202: Programmdatei: Ungltiger Pfad
0x0203: Programmdatei: Ungltiger Dateiname
0x0204: Programmdatei: Ungltiger Laufwerksbuchstabe
0x0205: Programmdatei: Pfad zu lang
0x0206: Programmdatei: Laufwerk nicht bereit
0x0207: Batchfile/COMMAND: COMMAND.COM nicht gefunden
0x0208: Fehler beim allozieren eines tempor„ren Puffers

0x03xx: DOS-Fehler-Code xx bei Aufruf von EXEC

0x0400: Fehler beim allozieren der Umgebungsvariablenkopie

0x0500: Auslagerung angefordert, aber prep_swap wurde nicht
aufgerufen oder lieferte einen Fehler
0x0501: MCBs entsprechen nicht dem erwarteten Aufbau
0x0502: Fehler beim Auslagern

0x0600: Redirection Syntaxfehler
0x06xx: DOS-Fehler xx bei Redirection
<*/

/*e Return codes (only upper byte significant) */
/*d Fehlercodes (nur das obere Byte signifikant) */

#define RC_PREPERR 0x0100
#define RC_NOFILE 0x0200
#define RC_EXECERR 0x0300
#define RC_ENVERR 0x0400
#define RC_SWAPERR 0x0500
#define RC_REDIRERR 0x0600

/*e Swap method and option flags */
/*d Auslagerungsmethoden ond Optionen */

#define USE_EMS 0x01
#define USE_XMS 0x02
#define USE_FILE 0x04
#define EMS_FIRST 0x00
#define XMS_FIRST 0x10
#define HIDE_FILE 0x40
#define NO_PREALLOC 0x100
#define CHECK_NET 0x200

#define USE_ALL (USE_EMS | USE_XMS | USE_FILE)


/*>e
The function pointed to by "spawn_check" will be called immediately
before doing the actual swap/exec, provided that

- the preparation code did not detect an error, and
- "spawn_check" is not NULL.

The function definition is
int name (int cmdbat, int swapping, char *execfn, char *progpars)

The parameters passed to this function are

cmdbat 1: Normal EXE/COM file
2: Executing BAT file via COMMAND.COM
3: Executing COMMAND.COM (or equivalent)

swapping < 0: Exec, don't swap
0: Spawn, don't swap
> 0: Spawn, swap

execfn the file name to execute (complete with path)

progpars the program parameter string

If the routine returns anything other than 0, the swap/exec will
not be executed, and do_exec will return with this code.

You can use this function to output messages (for example, the
usual "enter EXIT to return" message when loading COMMAND.COM)
and to do clean-up and additional checking.

CAUTION: If swapping is > 0, the routine may not modify the
memory layout, i.e. it may not call any memory allocation or
deallocation routines.

"spawn_check" is initialized to NULL.
<*/
/*>d
Die Funktion auf die "spawn_check" zeigt wird unmittelbar vor
Ausfhrung des Programmaufrufs aufgerufen, vorausgesetzt daá

- bei der Vorbereitung kein Fehler auftrat, und
- "spawn_check" nicht NULL ist.

Die Funktionsdefinition ist
int name (int cmdbat, int swapping, char *execfn, char *progpars)

Die der Funktion bergebenen Parameter sind

cmdbat 1: Normale EXE/COM Datei
2: Ausfhrung BAT Datei ber COMMAND.COM
3: Ausfhrung COMMAND.COM (oder Equivalent)

swapping < 0: Exec, keine Auslagerung
0: Spawn, keine Auslagerung
> 0: Spawn, Auslagern

execfn Name und Pfad der auszufhrenden Datei

progpars Programmparameter

Wenn die Routine einen Wert verschieden von 0 liefert, wird der
Programmaufruf nicht durchgefhrt, und do_exec kehrt mit diesem
Wert zurck.

Sie k”nnen diese Funktion benutzen um Meldungen auszugeben
(zum Beispiel die bliche Meldung "Geben Sie EXIT ein um
zurckzukehren" bei Laden von COMMAND.COM), und fr sonstige
Prfungen oder Aufr„umarbeiten.

ACHTUNG: Wenn swapping > 0 ist, darf die Funktion keinesfalls
den Speicheraufbau ver„ndern, d.h. es drfen keine Speicher-
Allozierungs oder -Deallozierungsroutinen benutzt werden.

"spawn_check" ist auf NULL initialisiert.
<*/

typedef int (spawn_check_proc)(int cmdbat, int swapping, char *execfn, char *progpars);
extern spawn_check_proc *spawn_check;

/*>e
The 'swap_prep' variable can be accessed from the spawn_check
call-back routine for additional information on the nature and
parameters of the swap. This variable will ONLY hold useful
information if the 'swapping' parameter to spawn_check is > 0.
The contents of this variable may not be changed.

The 'swapmethod' field will contain one of the flags USE_FILE,
USE_XMS, or USE_EMS.

Caution: The module using this data structure must be compiled
with structure packing on byte boundaries on, i.e. with /Zp1 for
MSC, or -a- for Turbo/Borland.
<*/
/*>d
Die Variable 'swap_prep' kann von der spawn_check Routine
benutzt werden um zus„tzliche Informationen ber Art und Parameter
der Auslagerung zu erfahren. Diese Variable enth„lt NUR DANN
sinnvolle Werte wenn der 'swapping' Parameter von spawn_check > 0 ist.
Der Inhalt dieser Variablen darf keinesfalls ver„ndert werden.

Das Feld 'swapmethod' enth„lt einen der Werte USE_FILE,
USE_XMS, oder USE_EMS.

Achtung: Ein Modul das diese Datenstruktur benutzen will muá
mit Struktur-Adjustierung auf Byte-Grenze kompiliert werden, d.h.
mit /Zp1 fr MSC, oder -a- fr Turbo/Borland.
<*/

typedef struct {
long xmm; /*e XMM entry address */
/*d Einsprungadresse XMM */
int first_mcb; /*e Segment of first MCB */
/*d Segment des ersten MCB */
int psp_mcb; /*e Segment of MCB of our PSP */
/*d Segment des MCB unseres PSP */
int env_mcb; /*e MCB of Environment segment */
/*d MCB des Umgebungsvariablenblocks */
int noswap_mcb; /*e MCB that may not be swapped */
/*d MCB der nicht Ausgelagert wird */
int ems_pageframe; /*e EMS page frame address */
/*d EMS-Seiten-Adresse */
int handle; /*e EMS/XMS/File handle */
/*d Handle fr EMS/XMS/Datei */
int total_mcbs; /*e Total number of MCBs */
/*d Gesamtzahl MCBs */
char swapmethod; /*e Method for swapping */
/*d Auslagerungsmethode */
char swapfilename[81]; /*e Swap file name if swapping to file */
/*d Auslagerungsdateiname */
} prep_block;

extern prep_block swap_prep;