rom/dos/dos_intern.h

   1 /*
   2     Copyright © 1995-2011, 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     1
  82 #define FHF_APPEND  2
  83 #define FHF_LINEBUF 4
  84 #define FHF_NOBUF   8
  85 #define FHF_OWNBUF  16
  86
  87 #define FPUTC(f,c) \
  88 (((struct FileHandle *)BADDR(f))->fh_Flags&FHF_WRITE&& \
  89  ((struct FileHandle *)BADDR(f))->fh_Pos<((struct FileHandle *)BADDR(f))->fh_End? \
  90 *((struct FileHandle *)BADDR(f))->fh_Pos++=c,0:FPutC(f,c))
  91
  92 #define DOS_FH_MAGIC    AROS_MAKE_ID('F','h','n','d')
  93 #define ISFILEHANDLE(f) \
  94     ((((struct FileHandle *)BADDR(f))->fh_Func2) == DOS_FH_MAGIC)
  95
  96 /* Softlink handling */
  97 STRPTR ResolveSoftlink(BPTR cur, struct DevProc *dvp, CONST_STRPTR name, struct DosLibrary *DOSBase);
  98 LONG RootDir(struct DevProc *dvp, struct DosLibrary *DOSBase);
  99
 100 /* Packet I/O */
 101 struct DosPacket *allocdospacket(void);
 102 void freedospacket(struct DosPacket *dp);
 103 SIPTR dopacket(SIPTR *res2, struct MsgPort *port, LONG action, SIPTR arg1, SIPTR arg2, SIPTR arg3, SIPTR arg4, SIPTR arg5, SIPTR arg6, SIPTR arg7);
 104 void internal_SendPkt(struct DosPacket *dp, struct MsgPort *port, struct MsgPort *replyport);
 105 struct DosPacket *internal_WaitPkt(struct MsgPort *msgPort);
 106 void internal_ReplyPkt(struct DosPacket *dp, struct MsgPort *replyPort, SIPTR res1, LONG res2);
 107
 108 #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)
 109 #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)
 110 #define dopacket3(base, res2, port, action, arg1, arg2, arg3)             dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), (SIPTR)(arg3), 0, 0, 0, 0)
 111 #define dopacket2(base, res2, port, action, arg1, arg2)                   dopacket(res2, port, action, (SIPTR)(arg1), (SIPTR)(arg2), 0, 0, 0, 0, 0)
 112 #define dopacket1(base, res2, port, action, arg1)                         dopacket(res2, port, action, (SIPTR)(arg1), 0, 0, 0, 0, 0, 0)
 113 #define dopacket0(base, res2, port, action)                               dopacket(res2, port, action, 0, 0, 0, 0, 0, 0, 0)
 114
 115 #ifdef __mc68000
 116 extern void BCPL_Fixup(struct Process *me);
 117 #else
 118 #define BCPL_Fixup(p) do { } while (0)
 119 #endif
 120
 121 ULONG CallEntry(STRPTR argptr, ULONG argsize, LONG_FUNC entry, struct Process *me);
 122
 123 struct MsgPort *RunHandler(struct DeviceNode *deviceNode, const char *path, struct DosLibrary *DOSBase);
 124 BOOL namefrom_internal(struct DosLibrary *DOSBase, BPTR lock, STRPTR buffer, LONG length);
 125
 126 /* Platform-overridable boot sequence */
 127 void __dos_Boot(struct DosLibrary *DOSBase, ULONG BootFlags, UBYTE Flags);
 128 BOOL __dos_IsBootable(struct DosLibrary *DOSBase, BPTR Lock);
 129
 130 /* Cli dependent SetProgramName() for use in CreateNewProc() */
 131 BOOL internal_SetProgramName(struct CommandLineInterface *cli,
 132     CONST_STRPTR name, struct DosLibrary *DOSBase);
 133 /* Duplicate a cli_CommandDir BPTR list */
 134 BPTR internal_CopyPath(BPTR boldpath, struct DosLibrary * DOSBase);
 135
 136
 137 /* Pattern matching function used by MatchPattern() and MatchPatternNoCase() */
 138 BOOL patternMatch(CONST_STRPTR pat, CONST_STRPTR str, BOOL useCase,
 139                   struct DosLibrary *DOSBase);
 140
 141 /* Pattern parsing function used by ParsePattern() and ParsePatternNoCase() */
 142 LONG patternParse(CONST_STRPTR Source, STRPTR Dest, LONG DestLength,
 143     BOOL useCase, struct DosLibrary *DOSBase);
 144
 145
 146 LONG InternalSeek
 147 (
 148     struct FileHandle *fh,
 149     LONG               position,
 150     LONG               mode,
 151     struct DosLibrary *DOSBase
 152 );
 153 LONG InternalFlush( struct FileHandle *fh, struct DosLibrary *DOSBase );
 154
 155
 156 /* match_misc.c */
 157
 158 struct AChain *Match_AllocAChain(LONG extrasize, struct DosLibrary *DOSBase);
 159 void Match_FreeAChain(struct AChain *ac, struct DosLibrary *DOSBase);
 160 LONG Match_BuildAChainList(CONST_STRPTR pattern, struct AnchorPath *ap,
 161                            struct AChain **retac, struct DosLibrary *DOSBase);
 162 LONG Match_MakeResult(struct AnchorPath *ap, struct DosLibrary *DOSBase);
 163
 164 void addprocesstoroot(struct Process * , struct DosLibrary *);
 165 void removefromrootnode(struct Process *, struct DosLibrary *);
 166
 167 struct marker
 168 {
 169     UBYTE type; /* 0: Split 1: MP_NOT */
 170     CONST_STRPTR pat; /* Pointer into pattern */
 171     CONST_STRPTR str; /* Pointer into string */
 172 };
 173
 174 struct markerarray
 175 {
 176     struct markerarray *next;
 177     struct markerarray *prev;
 178     struct marker marker[128];
 179 };
 180
 181 #define PUSH(t,p,s)                                                     \
 182 {                                                                       \
 183     if(macnt==128)                                                      \
 184     {                                                                   \
 185         if(macur->next==NULL)                                           \
 186         {                                                               \
 187             macur->next=AllocMem(sizeof(struct markerarray),MEMF_ANY);  \
 188             if(macur->next==NULL)                                       \
 189                 ERROR(ERROR_NO_FREE_STORE);                             \
 190             macur->next->prev=macur;                                    \
 191         }                                                               \
 192         macur=macur->next;                                              \
 193         macnt=0;                                                        \
 194     }                                                                   \
 195     macur->marker[macnt].type=(t);                                      \
 196     macur->marker[macnt].pat=(p);                                       \
 197     macur->marker[macnt].str=(s);                                       \
 198     macnt++;                                                            \
 199 }
 200
 201 #define POP(t,p,s)                      \
 202 {                                       \
 203     macnt--;                            \
 204     if(macnt<0)                         \
 205     {                                   \
 206         macnt=127;                      \
 207         macur=macur->prev;              \
 208         if(macur==NULL)                 \
 209             ERROR(0);                   \
 210     }                                   \
 211     (t)=macur->marker[macnt].type;      \
 212     (p)=macur->marker[macnt].pat;       \
 213     (s)=macur->marker[macnt].str;       \
 214 }
 215
 216 #define MP_ESCAPE               0x81 /* Before characters in [0x81;0x8a] */
 217 #define MP_MULT                 0x82 /* _#(_a) */
 218 #define MP_MULT_END             0x83 /* #(a_)_ */
 219 #define MP_NOT                  0x84 /* _~(_a) */
 220 #define MP_NOT_END              0x85 /* ~(a_)_ */
 221 #define MP_OR                   0x86 /* _(_a|b) */
 222 #define MP_OR_NEXT              0x87 /* (a_|_b) */
 223 #define MP_OR_END               0x88 /* (a|b_)_ */
 224 #define MP_SINGLE               0x89 /* ? */
 225 #define MP_ALL                  0x8a /* #? or * */
 226 #define MP_SET                  0x8b /* _[_ad-g] */
 227 #define MP_NOT_SET              0x8c /* _[~_ad-g] */
 228 #define MP_DASH                 0x8d /* [ad_-g_] */
 229 #define MP_SET_END              0x8e /* [ad-g_]_ */
 230
 231 /* Whether MatchFirst/MatchNext/MatchEnd in case of the base
 232    AChain should just take the currentdir lock pointer, or
 233    make a real duplicate with DupLock() */
 234
 235 #define MATCHFUNCS_NO_DUPLOCK   0
 236
 237 #define  __is_task(task)  (((struct Task *)task)->tc_Node.ln_Type == NT_TASK)
 238 #define  __is_process(task)  (((struct Task *)task)->tc_Node.ln_Type == NT_PROCESS)
 239
 240 struct seginfo
 241 {
 242     struct MinNode node;
 243     APTR           addr;
 244     char           name[32];
 245 };
 246
 247 struct debug_segnode
 248 {
 249     struct MinNode node;
 250     UBYTE          name[200];
 251     BPTR           seglist;
 252     IPTR           start_address; // start address of loaded executable segment
 253     struct MinList seginfos;
 254 };
 255
 256 struct InternalExAllControl
 257 {
 258     struct ExAllControl   eac;
 259     /* Used for ExAll emulation. If non null, it means
 260        ExAll emulation is being performed.  */
 261     struct FileInfoBlock *fib;
 262 };
 263
 264
 265 typedef struct FileHandle* FileHandlePtr;
 266
 267 void vbuf_free(FileHandlePtr fh);
 268 APTR vbuf_alloc(FileHandlePtr fh, STRPTR buf, ULONG size);
 269 BOOL vbuf_inject(BPTR fh, CONST_STRPTR argptr, ULONG argsize, struct DosLibrary *DOSBase);
 270
 271 LONG FWriteChars(BPTR file, CONST UBYTE* buffer, ULONG length, struct DosLibrary *DOSBase);
 272
 273
 274 #ifdef AROS_FAST_BSTR
 275
 276 #define CMPBSTR(x, y)       Stricmp(BADDR(x), BADDR(y))
 277 #define CMPNICBSTR(x, y, n) Strnicmp(x, BADDR(y), n)
 278 #define BSTR2C(s)           ((STRPTR)BADDR(s))
 279 #define FreeCSTR(s)
 280
 281 #else
 282
 283 BOOL CMPBSTR(BSTR, BSTR);
 284 BOOL CMPNICBSTR(CONST_STRPTR, BSTR, UBYTE);
 285 char *BSTR2C(BSTR);
 286
 287 #define FreeCSTR(s) FreeVec(s)
 288
 289 #endif
 290
 291 #ifdef AROS_FAST_BSTR
 292 #define C2BSTR(x)       ((char *)(x))
 293 #define FREEC2BSTR(x)   do { } while (0)
 294 #define CMPCBSTR(a,b)   strcmp(a,b)
 295 #define CMPICBSTR(a,b)  Stricmp(a,b)
 296 #else
 297 BSTR C2BSTR(CONST_STRPTR);
 298 #define FREEC2BSTR(bstr) FreeVec(BADDR(bstr))
 299 BOOL CMPCBSTR(CONST_STRPTR, BSTR);
 300 BOOL CMPICBSTR(CONST_STRPTR, BSTR);
 301 #endif
 302
 303 void fixfib(struct FileInfoBlock*);
 304
 305 struct PacketHelperStruct
 306 {
 307         BSTR name;
 308         struct MsgPort *port;
 309         BPTR lock;
 310         struct DevProc *dp;
 311 };
 312
 313 BOOL getpacketinfo(struct DosLibrary *DOSBase, CONST_STRPTR, struct PacketHelperStruct*);
 314 BOOL getdevpacketinfo(struct DosLibrary *DOSBase, CONST_STRPTR devname, CONST_STRPTR name, struct PacketHelperStruct *phs);
 315 void freepacketinfo(struct DosLibrary *DOSBase, struct PacketHelperStruct*);
 316
 317 #define ASSERT_VALID_FILELOCK(lock) do { \
 318         struct FileLock *fl = BADDR(lock); \
 319         if (fl && fl->fl_Access != SHARED_LOCK && fl->fl_Access != EXCLUSIVE_LOCK) { \
 320             bug("%s() bogus FileLock! '%s' %x %d %s/%s/%d\n", \
 321                 __FUNCTION__, SysBase->ThisTask->tc_Node.ln_Name, fl, fl->fl_Access, __FILE__,__FUNCTION__,__LINE__); \
 322         } \
 323     } while (0);
 324
 325 /* Shell utilities */
 326 BPTR findseg_cli(BOOL isBoot, struct DosLibrary *DOSBase);
 327
 328 BPTR findseg_shell(BOOL isBoot, struct DosLibrary *DOSBase);
 329
 330 /* Helper for IN:, OUT:, ERR:, STDIN:, STDOUT:, STDERR:
 331  */
 332 BOOL pseudoLock(CONST_STRPTR name, LONG lockMode, BPTR *lock, LONG *ret, struct DosLibrary *DOSBase);
 333
 334 #endif /* DOS_INTERN_H */