rom/dos/dos_intern.h

   1 /*
   2     Copyright © 1995-2017, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Internal types and stuff for dos
   6     Lang: English
   7 */
   8 #ifndef DOS_INTERN_H
   9 #define DOS_INTERN_H
  10
  11 #include <aros/system.h>
  12 #include <exec/io.h>
  13 #include <dos/dos.h>
  14 #include <dos/exall.h>
  15 #include <dos/dosextens.h>
  16 #include <dos/dosasl.h>
  17 #include <dos/filehandler.h>
  18 #include <utility/tagitem.h>
  19 #include <proto/exec.h>
  20 #include <proto/utility.h>
  21
  22 #include "fs_driver.h"
  23
  24 /*
  25  * These bases are historically placed in public portion of DOSBase.
  26  * We won't change this.
  27  */
  28 #undef TimerBase
  29 #define TimerBase (DOSBase->dl_TimeReq->tr_node.io_Device)
  30 #undef UtilityBase
  31 #define UtilityBase (DOSBase->dl_UtilityBase)
  32
  33 /* Needed for close() */
  34 #define expunge() \
  35 AROS_LC0(BPTR, expunge, struct DosLibrary *, DOSBase, 3, Dos)
  36
  37 #define RDAF_ALLOCATED_BY_READARGS (1L << 31)
  38
  39 /* BCPL compatibility: At least LONG alignment required */
  40
  41 struct IntDosBase
  42 {
  43     struct DosLibrary pub;
  44     struct Library *debugBase;
  45     struct RootNode rootNode  __attribute__((aligned(4)));
  46     struct ErrorString errors  __attribute__((aligned(4)));
  47 #ifdef __arm__
  48     ULONG arm_Arch; /* ARM-specific info for ELF loader */
  49     BOOL  arm_VFP;
  50     BOOL  arm_VFP_v3;
  51 #endif
  52 };
  53
  54 #define IDosBase(base) ((struct IntDosBase *)base)
  55 #define DebugBase IDosBase(DOSBase)->debugBase
  56
  57 struct DAList
  58 {
  59     STRPTR *ArgBuf;
  60     UBYTE  *StrBuf;
  61     STRPTR *MultVec;
  62     BOOL    FreeRDA;
  63 };
  64
  65 #ifndef EOF
  66 #define EOF -1
  67 #endif
  68 #ifndef IOBUFSIZE
  69 #define IOBUFSIZE 4096
  70 #endif
  71
  72 struct vfp
  73 {
  74     BPTR               file;
  75     LONG               count;
  76     struct DosLibrary *DOSBase;
  77 };
  78
  79 /* fh_Flags. The flags are AROS specific and therefore PRIVATE.. */
  80 #define FHF_WRITE    0x80000000
  81 #define FHF_BUF      0x00000001
  82 #define FHF_APPEND   0x00000002
  83 #define FHF_LINEBUF  0x00000004
  84 #define FHF_NOBUF    0x00000008
  85 #define FHF_OWNBUF   0x00000010
  86 #define FHF_FLUSHING 0x00000020
  87
  88 #define FPUTC(f,c) \
  89 (((struct FileHandle *)BADDR(f))->fh_Flags&FHF_WRITE&& \
  90  ((struct FileHandle *)BADDR(f))->fh_Pos<((struct FileHandle *)BADDR(f))->fh_End? \
  91 *((struct FileHandle *)BADDR(f))->fh_Pos++=c,0:FPutC(f,c))
  92
  93 #define DOS_FH_MAGIC    AROS_MAKE_ID('F','h','n','d')
  94 #define ISFILEHANDLE(f) \
  95     ((((struct FileHandle *)BADDR(f))->fh_Func2) == DOS_FH_MAGIC)
  96
  97 /* Softlink handling */
  98 STRPTR ResolveSoftlink(BPTR cur, struct DevProc *dvp, CONST_STRPTR name, struct DosLibrary *DOSBase);
  99 LONG RootDir(struct DevProc *dvp, struct DosLibrary *DOSBase);
 100
 101 /* Packet I/O */
 102 struct DosPacket *allocdospacket(void);
 103 void freedospacket(struct DosPacket *dp);
 104 SIPTR dopacket(SIPTR *res2, struct MsgPort *port, LONG action, SIPTR arg1, SIPTR arg2, SIPTR arg3, SIPTR arg4, SIPTR arg5, SIPTR arg6, SIPTR arg7);
 105 void internal_SendPkt(struct DosPacket *dp, struct MsgPort *port, struct MsgPort *replyport);
 106 struct DosPacket *internal_WaitPkt(struct MsgPort *msgPort);
 107 void internal_ReplyPkt(struct DosPacket *dp, struct MsgPort *replyPort, SIPTR res1, LONG res2);
 108 SIPTR handleNIL(LONG action, SIPTR arg1, SIPTR arg2, SIPTR arg3);
 109
 110 #define dopacket5(base, res2, port, action, arg1, arg2, arg3, arg4, arg5) dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), (SIPTR)(arg3), (SIPTR)(arg4), (SIPTR)(arg5), 0, 0)
 111 #define dopacket4(base, res2, port, action, arg1, arg2, arg3, arg4)       dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), (SIPTR)(arg3), (SIPTR)(arg4), 0, 0, 0)
 112 #define dopacket3(base, res2, port, action, arg1, arg2, arg3)             dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), (SIPTR)(arg3), 0, 0, 0, 0)
 113 #define dopacket2(base, res2, port, action, arg1, arg2)                   dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), 0, 0, 0, 0, 0)
 114 #define dopacket1(base, res2, port, action, arg1)                         dopacket(res2, port, action, (SIPTR)(arg1), 0, 0, 0, 0, 0, 0)
 115 #define dopacket0(base, res2, port, action)                               dopacket(res2, port, action, 0, 0, 0, 0, 0, 0, 0)
 116
 117 #ifdef __mc68000
 118 extern void BCPL_Fixup(struct Process *me);
 119 #else
 120 #define BCPL_Fixup(p) do { } while (0)
 121 #endif
 122
 123 ULONG CallEntry(STRPTR argptr, ULONG argsize, LONG_FUNC entry, struct Process *me);
 124
 125 struct MsgPort *RunHandler(struct DeviceNode *deviceNode, const char *path, struct DosLibrary *DOSBase);
 126 BOOL namefrom_internal(struct DosLibrary *DOSBase, BPTR lock, STRPTR buffer, LONG length);
 127
 128 /* Platform-overridable boot sequence */
 129 void __dos_Boot(struct DosLibrary *DOSBase, ULONG BootFlags, UBYTE Flags);
 130 BOOL __dos_IsBootable(struct DosLibrary *DOSBase, BPTR Lock);
 131
 132 /* Cli dependent SetProgramName() for use in CreateNewProc() */
 133 BOOL internal_SetProgramName(struct CommandLineInterface *cli,
 134     CONST_STRPTR name, struct DosLibrary *DOSBase);
 135 /* Duplicate a cli_CommandDir BPTR list */
 136 BPTR internal_CopyPath(BPTR boldpath, struct DosLibrary * DOSBase);
 137
 138
 139 /* Pattern matching function used by MatchPattern() and MatchPatternNoCase() */
 140 BOOL patternMatch(CONST_STRPTR pat, CONST_STRPTR str, BOOL useCase,
 141                   struct DosLibrary *DOSBase);
 142
 143 /* Pattern parsing function used by ParsePattern() and ParsePatternNoCase() */
 144 LONG patternParse(CONST_STRPTR Source, STRPTR Dest, LONG DestLength,
 145     BOOL useCase, struct DosLibrary *DOSBase);
 146
 147
 148 LONG InternalSeek
 149 (
 150     struct FileHandle *fh,
 151     LONG               position,
 152     LONG               mode,
 153     struct DosLibrary *DOSBase
 154 );
 155 LONG InternalFlush( struct FileHandle *fh, struct DosLibrary *DOSBase );
 156
 157
 158 /* match_misc.c */
 159
 160 struct AChain *Match_AllocAChain(LONG extrasize, struct DosLibrary *DOSBase);
 161 void Match_FreeAChain(struct AChain *ac, struct DosLibrary *DOSBase);
 162 LONG Match_BuildAChainList(CONST_STRPTR pattern, struct AnchorPath *ap,
 163                            struct AChain **retac, struct DosLibrary *DOSBase);
 164 LONG Match_MakeResult(struct AnchorPath *ap, struct DosLibrary *DOSBase);
 165
 166 void addprocesstoroot(struct Process * , struct DosLibrary *);
 167 void removefromrootnode(struct Process *, struct DosLibrary *);
 168
 169 struct marker
 170 {
 171     UBYTE type; /* 0: Split 1: MP_NOT */
 172     CONST_STRPTR pat; /* Pointer into pattern */
 173     CONST_STRPTR str; /* Pointer into string */
 174 };
 175
 176 struct markerarray
 177 {
 178     struct markerarray *next;
 179     struct markerarray *prev;
 180     struct marker marker[128];
 181 };
 182
 183 #define PUSH(t,p,s)                                                     \
 184 {                                                                       \
 185     if(macnt==128)                                                      \
 186     {                                                                   \
 187         if(macur->next==NULL)                                           \
 188         {                                                               \
 189             macur->next=AllocMem(sizeof(struct markerarray),MEMF_ANY);  \
 190             if(macur->next==NULL)                                       \
 191                 ERROR(ERROR_NO_FREE_STORE);                             \
 192             macur->next->prev=macur;                                    \
 193         }                                                               \
 194         macur=macur->next;                                              \
 195         macnt=0;                                                        \
 196     }                                                                   \
 197     macur->marker[macnt].type=(t);                                      \
 198     macur->marker[macnt].pat=(p);                                       \
 199     macur->marker[macnt].str=(s);                                       \
 200     macnt++;                                                            \
 201 }
 202
 203 #define POP(t,p,s)                      \
 204 {                                       \
 205     macnt--;                            \
 206     if(macnt<0)                         \
 207     {                                   \
 208         macnt=127;                      \
 209         macur=macur->prev;              \
 210         if(macur==NULL)                 \
 211             ERROR(0);                   \
 212     }                                   \
 213     (t)=macur->marker[macnt].type;      \
 214     (p)=macur->marker[macnt].pat;       \
 215     (s)=macur->marker[macnt].str;       \
 216 }
 217
 218 #define MP_ESCAPE               0x81 /* Before characters in [0x81;0x8a] */
 219 #define MP_MULT                 0x82 /* _#(_a) */
 220 #define MP_MULT_END             0x83 /* #(a_)_ */
 221 #define MP_NOT                  0x84 /* _~(_a) */
 222 #define MP_NOT_END              0x85 /* ~(a_)_ */
 223 #define MP_OR                   0x86 /* _(_a|b) */
 224 #define MP_OR_NEXT              0x87 /* (a_|_b) */
 225 #define MP_OR_END               0x88 /* (a|b_)_ */
 226 #define MP_SINGLE               0x89 /* ? */
 227 #define MP_ALL                  0x8a /* #? or * */
 228 #define MP_SET                  0x8b /* _[_ad-g] */
 229 #define MP_NOT_SET              0x8c /* _[~_ad-g] */
 230 #define MP_DASH                 0x8d /* [ad_-g_] */
 231 #define MP_SET_END              0x8e /* [ad-g_]_ */
 232
 233 /* Whether MatchFirst/MatchNext/MatchEnd in case of the base
 234    AChain should just take the currentdir lock pointer, or
 235    make a real duplicate with DupLock() */
 236
 237 #define MATCHFUNCS_NO_DUPLOCK   0
 238
 239 #define  __is_task(task)  (((struct Task *)task)->tc_Node.ln_Type == NT_TASK)
 240 #define  __is_process(task)  (((struct Task *)task)->tc_Node.ln_Type == NT_PROCESS)
 241
 242 struct seginfo
 243 {
 244     struct MinNode node;
 245     APTR           addr;
 246     char           name[32];
 247 };
 248
 249 struct debug_segnode
 250 {
 251     struct MinNode node;
 252     UBYTE          name[200];
 253     BPTR           seglist;
 254     IPTR           start_address; // start address of loaded executable segment
 255     struct MinList seginfos;
 256 };
 257
 258 struct InternalExAllControl
 259 {
 260     struct ExAllControl   eac;
 261     /* Used for ExAll emulation. If non null, it means
 262        ExAll emulation is being performed.  */
 263     struct FileInfoBlock *fib;
 264 };
 265
 266
 267 typedef struct FileHandle* FileHandlePtr;
 268
 269 void vbuf_free(FileHandlePtr fh);
 270 APTR vbuf_alloc(FileHandlePtr fh, STRPTR buf, ULONG size);
 271 BOOL vbuf_inject(BPTR fh, CONST_STRPTR argptr, ULONG argsize, struct DosLibrary *DOSBase);
 272 LONG vbuf_fetch(BPTR file, UBYTE * buffer, ULONG fetchsize, struct DosLibrary *DOSBase);
 273
 274 LONG FWriteChars(BPTR file, CONST UBYTE* buffer, ULONG length, struct DosLibrary *DOSBase);
 275
 276
 277 #ifdef AROS_FAST_BSTR
 278
 279 #define CMPBSTR(x, y)       Stricmp(BADDR(x), BADDR(y))
 280 #define CMPNICBSTR(x, y, n) Strnicmp(x, BADDR(y), n)
 281 #define BSTR2C(s)           ((STRPTR)BADDR(s))
 282 #define FreeCSTR(s)
 283
 284 #else
 285
 286 BOOL CMPBSTR(BSTR, BSTR);
 287 BOOL CMPNICBSTR(CONST_STRPTR, BSTR, UBYTE);
 288 char *BSTR2C(BSTR);
 289
 290 #define FreeCSTR(s) FreeVec(s)
 291
 292 #endif
 293
 294 #ifdef AROS_FAST_BSTR
 295 #define C2BSTR(x)       ((char *)(x))
 296 #define FREEC2BSTR(x)   do { } while (0)
 297 #define CMPCBSTR(a,b)   strcmp(a,b)
 298 #define CMPICBSTR(a,b)  Stricmp(a,b)
 299 #else
 300 BSTR C2BSTR(CONST_STRPTR);
 301 #define FREEC2BSTR(bstr) FreeVec(BADDR(bstr))
 302 BOOL CMPCBSTR(CONST_STRPTR, BSTR);
 303 BOOL CMPICBSTR(CONST_STRPTR, BSTR);
 304 #endif
 305
 306 void fixfib(struct FileInfoBlock*);
 307
 308 struct PacketHelperStruct
 309 {
 310         BSTR name;
 311         struct MsgPort *port;
 312         BPTR lock;
 313         struct DevProc *dp;
 314 };
 315
 316 BOOL getpacketinfo(struct DosLibrary *DOSBase, CONST_STRPTR, struct PacketHelperStruct*);
 317 BOOL getdevpacketinfo(struct DosLibrary *DOSBase, CONST_STRPTR devname, CONST_STRPTR name, struct PacketHelperStruct *phs);
 318 void freepacketinfo(struct DosLibrary *DOSBase, struct PacketHelperStruct*);
 319
 320 #ifndef __SRCFILENAME__
 321 #define __SRCFILENAME__ __FILE__
 322 #endif /* !__SRCFILENAME__ */
 323
 324 #define ASSERT_VALID_FILELOCK(lock) do { \
 325         struct FileLock *fl = BADDR(lock); \
 326         if (fl && fl->fl_Access != SHARED_LOCK && fl->fl_Access != EXCLUSIVE_LOCK) { \
 327             bug("%s() bogus FileLock! '%s' %x %d %s/%s/%d\n", \
 328                 __FUNCTION__, FindTask(NULL)->tc_Node.ln_Name, fl, fl->fl_Access, __SRCFILENAME__,__FUNCTION__,__LINE__); \
 329         } \
 330     } while (0);
 331
 332 /* Shell utilities */
 333 BPTR findseg_cli(BOOL isBoot, struct DosLibrary *DOSBase);
 334
 335 BPTR findseg_shell(BOOL isBoot, struct DosLibrary *DOSBase);
 336
 337 /* Helper for IN:, OUT:, ERR:, STDIN:, STDOUT:, STDERR:
 338  */
 339 BOOL pseudoLock(CONST_STRPTR name, LONG lockMode, BPTR *lock, LONG *ret, struct DosLibrary *DOSBase);
 340
 341 #endif /* DOS_INTERN_H */