compiler/clib/__fdesc.c

   1 /*
   2     Copyright © 1995-2012, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     File descriptors handling internals.
   6 */
   7
   8 #include "__arosc_privdata.h"
   9
  10 #include <string.h>
  11 #include <fcntl.h>
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <errno.h>
  15
  16 #define DEBUG 0
  17
  18 #include <proto/exec.h>
  19 #include <proto/dos.h>
  20 #include <exec/memory.h>
  21 #include <exec/semaphores.h>
  22 #include <dos/dos.h>
  23 #include <aros/symbolsets.h>
  24 #include <aros/debug.h>
  25 #include "__fdesc.h"
  26 #include "__upath.h"
  27
  28 static struct SignalSemaphore __fdsem;
  29 static struct MinList __fdreglist;
  30
  31 void __getfdarray(APTR *arrayptr, int *slotsptr)
  32 {
  33     struct aroscbase *aroscbase = __GM_GetBase();
  34
  35     *arrayptr = aroscbase->acb_fd_array;
  36     *slotsptr = aroscbase->acb_numslots;
  37 }
  38
  39 void __setfdarray(APTR array, int slots)
  40 {
  41     struct aroscbase *aroscbase = __GM_GetBase();
  42     aroscbase->acb_fd_array = array;
  43     aroscbase->acb_numslots = slots;
  44 }
  45
  46 void __setfdarraybase(struct aroscbase *aroscbase2)
  47 {
  48     struct aroscbase *aroscbase = __GM_GetBase();
  49
  50     aroscbase->acb_fd_array = aroscbase2->acb_fd_array;
  51     aroscbase->acb_numslots = aroscbase2->acb_numslots;
  52 }
  53
  54 int __getfdslots(void)
  55 {
  56     struct aroscbase *aroscbase = __GM_GetBase();
  57     return aroscbase->acb_numslots;
  58 }
  59
  60 fdesc *__getfdesc(register int fd)
  61 {
  62     struct aroscbase *aroscbase = __GM_GetBase();
  63     return ((aroscbase->acb_numslots>fd) && (fd>=0))?aroscbase->acb_fd_array[fd]:NULL;
  64 }
  65
  66 void __setfdesc(register int fd, fdesc *desc)
  67 {
  68     struct aroscbase *aroscbase = __GM_GetBase();
  69     /* FIXME: Check if fd is in valid range... */
  70     aroscbase->acb_fd_array[fd] = desc;
  71 }
  72
  73 int __getfirstfd(register int startfd)
  74 {
  75     struct aroscbase *aroscbase = __GM_GetBase();
  76     /* FIXME: Check if fd is in valid range... */
  77     for (
  78         ;
  79         startfd < aroscbase->acb_numslots && aroscbase->acb_fd_array[startfd];
  80         startfd++
  81     );
  82
  83     return startfd;
  84 }
  85
  86 int __getfdslot(int wanted_fd)
  87 {
  88     struct aroscbase *aroscbase = __GM_GetBase();
  89     if (wanted_fd>=aroscbase->acb_numslots)
  90     {
  91         void *tmp;
  92
  93         tmp = AllocPooled(aroscbase->acb_internalpool, (wanted_fd+1)*sizeof(fdesc *));
  94
  95         if (!tmp) return -1;
  96
  97         if (aroscbase->acb_fd_array)
  98         {
  99             size_t size = aroscbase->acb_numslots*sizeof(fdesc *);
 100             CopyMem(aroscbase->acb_fd_array, tmp, size);
 101             FreePooled(aroscbase->acb_internalpool, aroscbase->acb_fd_array, size);
 102         }
 103
 104         aroscbase->acb_fd_array = tmp;
 105
 106         bzero(aroscbase->acb_fd_array + aroscbase->acb_numslots, (wanted_fd - aroscbase->acb_numslots + 1) * sizeof(fdesc *));
 107         aroscbase->acb_numslots = wanted_fd+1;
 108     }
 109     else if (wanted_fd < 0)
 110     {
 111         errno = EINVAL;
 112         return -1;
 113     }
 114     else if (aroscbase->acb_fd_array[wanted_fd])
 115     {
 116         close(wanted_fd);
 117     }
 118
 119     return wanted_fd;
 120 }
 121
 122 LONG __oflags2amode(int flags)
 123 {
 124     LONG openmode = -1;
 125
 126     /* filter out invalid modes */
 127     switch (flags & (O_CREAT|O_TRUNC|O_EXCL))
 128     {
 129         case O_EXCL:
 130         case O_EXCL|O_TRUNC:
 131             return -1;
 132     }
 133
 134     /* Sorted in 'trumping' order. Ie if
 135      * O_WRITE is on, that overrides O_READ.
 136      * Similarly, O_CREAT overrides O_WRITE.
 137      */
 138     if (flags & O_RDONLY)   openmode = MODE_OLDFILE;
 139     if (flags & O_WRONLY)   openmode = MODE_OLDFILE;
 140     if (flags & O_RDWR)     openmode = MODE_OLDFILE;
 141     if (flags & O_READ)     openmode = MODE_OLDFILE;
 142     if (flags & O_WRITE)    openmode = MODE_READWRITE;
 143     if (flags & O_CREAT)    openmode = MODE_NEWFILE;
 144     if (flags & O_APPEND)   /* Handled later */;
 145     if (flags & O_TRUNC)    /* Handled later */;
 146     if (flags & O_EXEC)     /* Ignored */;
 147     if (flags & O_NONBLOCK) /* Ignored */;
 148
 149     return openmode;
 150 }
 151
 152 int __open(int wanted_fd, const char *pathname, int flags, int mode)
 153 {
 154     struct aroscbase *aroscbase = __GM_GetBase();
 155     BPTR fh = BNULL, lock = BNULL;
 156     fdesc *currdesc = NULL;
 157     fcb *cblock = NULL;
 158     struct FileInfoBlock *fib = NULL;
 159     LONG  openmode = __oflags2amode(flags);
 160
 161     if (aroscbase->acb_doupath && pathname[0] == '\0')
 162     {
 163         /* On *nix "" is not really a valid file name.  */
 164         errno = ENOENT;
 165         return -1;
 166     }
 167
 168     pathname = __path_u2a(pathname);
 169     if (!pathname) return -1;
 170
 171     D(bug("__open: entering, wanted fd = %d, path = %s, flags = %d, mode = %d\n", wanted_fd, pathname, flags, mode));
 172
 173     if (openmode == -1)
 174     {
 175         errno = EINVAL;
 176         D(bug( "__open: exiting with error EINVAL\n"));
 177         return -1;
 178     }
 179
 180     cblock = AllocVec(sizeof(fcb), MEMF_ANY | MEMF_CLEAR);
 181     if (!cblock) { D(bug("__open: no memory [1]\n")); goto err; }
 182     currdesc = __alloc_fdesc();
 183     if (!currdesc) { D(bug("__open: no memory [2]\n")); goto err; }
 184     currdesc->fdflags = 0;
 185     currdesc->fcb = cblock;
 186
 187     wanted_fd = __getfdslot(wanted_fd);
 188     if (wanted_fd == -1) { D(bug("__open: no free fd\n")); goto err; }
 189
 190     lock = Lock((char *)pathname, SHARED_LOCK);
 191     if (!lock)
 192     {
 193         if (IoErr() == ERROR_OBJECT_WRONG_TYPE)
 194         {
 195             /*
 196                Needed for sfs file system which reports this error number on a
 197                Lock aaa/bbb/ccc with bbb being a file instead of a directory.
 198             */
 199             errno = ENOTDIR;
 200             goto err;
 201         }
 202
 203         if
 204         (
 205             (IoErr() != ERROR_OBJECT_NOT_FOUND) ||
 206             /* If the file doesn't exist and the flag O_CREAT is not set return an error */
 207             (IoErr() == ERROR_OBJECT_NOT_FOUND && !(flags & O_CREAT))
 208         )
 209         {
 210             errno = __arosc_ioerr2errno(IoErr());
 211             goto err;
 212         }
 213     }
 214     else
 215     {
 216         /* If the file exists, but O_EXCL is set, then return an error */
 217         if (flags & O_EXCL)
 218         {
 219             errno = EEXIST;
 220             goto err;
 221         }
 222
 223         fib = AllocDosObject(DOS_FIB, NULL);
 224         if (!fib)
 225         {
 226            errno = __arosc_ioerr2errno(IoErr());
 227            goto err;
 228         }
 229
 230         if (!Examine(lock, fib))
 231         {
 232             /*
 233                 The filesystem in which the file resides doesn't support
 234                 the EXAMINE action. It might be broken or might also not
 235                 be a filesystem at all. So let's assume the file is not a
 236                 diretory.
 237            */
 238            fib->fib_DirEntryType = 0;
 239         }
 240
 241         /* FIXME: implement softlink handling */
 242
 243         /* Check if it's a directory or a softlink.
 244            Softlinks are not handled yet, though */
 245         if (fib->fib_DirEntryType > 0)
 246         {
 247             /* A directory cannot be opened for writing */
 248             if (openmode != MODE_OLDFILE)
 249             {
 250                 errno = EISDIR;
 251                 goto err;
 252             }
 253
 254             fh = lock;
 255             FreeDosObject(DOS_FIB, fib);
 256             currdesc->fcb->isdir = 1;
 257
 258             goto success;
 259         }
 260         FreeDosObject(DOS_FIB, fib);
 261         fib = NULL;
 262     }
 263
 264     /* the file exists and it's not a directory or the file doesn't exist */
 265
 266     if (lock)
 267     {
 268         UnLock(lock);
 269         lock = BNULL;
 270     }
 271
 272     if (!(fh = Open ((char *)pathname, openmode)) )
 273     {
 274         ULONG ioerr = IoErr();
 275         D(bug("__open: Open ioerr=%d\n", ioerr));
 276         errno = __arosc_ioerr2errno(ioerr);
 277         goto err;
 278     }
 279
 280     /* Handle O_TRUNC */
 281     if((flags & O_TRUNC) && (flags & (O_RDWR | O_WRONLY)))
 282     {
 283         if(SetFileSize(fh, 0, OFFSET_BEGINNING) != 0)
 284         {
 285             ULONG ioerr = IoErr();
 286             /* Ignore error if ACTION_SET_FILE_SIZE is not implemented */
 287             if(ioerr != ERROR_NOT_IMPLEMENTED &&
 288                ioerr != ERROR_ACTION_NOT_KNOWN)
 289             {
 290                 D(bug("__open: SetFileSize ioerr=%d\n", ioerr));
 291                 errno = __arosc_ioerr2errno(ioerr);
 292                 goto err;
 293             }
 294         }
 295     }
 296
 297     /* Handle O_APPEND */
 298     if((flags & O_APPEND) && (flags & (O_RDWR | O_WRONLY)))
 299     {
 300         if(Seek(fh, 0, OFFSET_END) != 0) {
 301             errno = __arosc_ioerr2errno(IoErr());
 302             goto err;
 303         }
 304     }
 305
 306
 307 success:
 308     currdesc->fcb->fh        = fh;
 309     currdesc->fcb->flags     = flags;
 310     currdesc->fcb->opencount = 1;
 311
 312     __setfdesc(wanted_fd, currdesc);
 313
 314     D(bug("__open: exiting fd=%d\n", wanted_fd));
 315
 316     return wanted_fd;
 317
 318 err:
 319     if (fib) FreeDosObject(DOS_FIB, fib);
 320     if (cblock) FreeVec(cblock);
 321     if (currdesc) __free_fdesc(currdesc);
 322     if (fh && fh != lock) Close(fh);
 323     if (lock) UnLock(lock);
 324
 325     D(bug("__open: exiting with error %d\n", errno ));
 326
 327     return -1;
 328 }
 329
 330 fdesc *__alloc_fdesc(void)
 331 {
 332     struct aroscbase *aroscbase = __GM_GetBase();
 333     fdesc * desc;
 334
 335     desc = AllocPooled(aroscbase->acb_internalpool, sizeof(fdesc));
 336
 337     D(bug("Allocated fdesc %x from %x pool\n", desc, aroscbase->acb_internalpool));
 338
 339     return desc;
 340 }
 341
 342 void __free_fdesc(fdesc *desc)
 343 {
 344     struct aroscbase *aroscbase = __GM_GetBase();
 345     D(bug("Freeing fdesc %x from %x pool\n", desc, aroscbase->acb_internalpool));
 346     FreePooled(aroscbase->acb_internalpool, desc, sizeof(fdesc));
 347 }
 348
 349
 350 struct __reg_fdarray {
 351     struct MinNode node;
 352     struct Task *task;
 353     fdesc **fdarray;
 354     int numslots;
 355 };
 356
 357 /* Some local variables for register_init_fdarray */
 358 static struct SignalSemaphore __fdsem;
 359 static struct MinList __fdreglist;
 360
 361 int __init_vars(struct ExecBase *SysBase)
 362 {
 363     InitSemaphore(&__fdsem);
 364     NEWLIST(&__fdreglist);
 365
 366     return TRUE;
 367 }
 368
 369 int __register_init_fdarray(struct aroscbase *base)
 370 {
 371     /* arosc privdata should not be used inside this function,
 372      * this function is called before aroscbase is initialized
 373      */
 374     struct __reg_fdarray *regnode = AllocVec(sizeof(struct __reg_fdarray), MEMF_ANY|MEMF_CLEAR);
 375
 376     if (regnode == NULL)
 377         return 0;
 378
 379     regnode->task = FindTask(NULL);
 380     regnode->fdarray = base->acb_fd_array;
 381     regnode->numslots = base->acb_numslots;
 382
 383     D(bug("Allocated regnode: %p, fdarray: %p, numslots: %d\n",
 384           regnode, regnode->fdarray, regnode->numslots
 385     ));
 386
 387     ObtainSemaphore(&__fdsem);
 388     AddHead((struct List *)&__fdreglist, (struct Node *)regnode);
 389     ReleaseSemaphore(&__fdsem);
 390
 391     return 1;
 392 }
 393
 394 /* FIXME: perhaps this has to be handled in a different way...  */
 395 int __init_stdfiles(struct aroscbase *aroscbase)
 396 {
 397     struct Process *me;
 398     fcb *infcb = NULL, *outfcb = NULL, *errfcb = NULL;
 399     fdesc *indesc=NULL, *outdesc=NULL, *errdesc=NULL;
 400     int res = __getfdslot(2);
 401
 402     if
 403     (
 404         res == -1                           ||
 405         !(infcb  = AllocVec(sizeof(fcb), MEMF_ANY | MEMF_CLEAR)) ||
 406         !(indesc  = __alloc_fdesc()) ||
 407         !(outfcb = AllocVec(sizeof(fcb), MEMF_ANY | MEMF_CLEAR)) ||
 408         !(outdesc = __alloc_fdesc()) ||
 409         !(errfcb = AllocVec(sizeof(fcb), MEMF_ANY | MEMF_CLEAR)) ||
 410         !(errdesc = __alloc_fdesc())
 411     )
 412     {
 413         if(infcb)
 414             FreeVec(infcb);
 415         if(indesc)
 416             __free_fdesc(indesc);
 417         if(outfcb)
 418             FreeVec(outfcb);
 419         if(outdesc)
 420             __free_fdesc(outdesc);
 421         if(errfcb)
 422             FreeVec(errfcb);
 423         if(errdesc)
 424             __free_fdesc(errdesc);
 425         SetIoErr(ERROR_NO_FREE_STORE);
 426         return 0;
 427     }
 428
 429     indesc->fdflags = 0;
 430     outdesc->fdflags = 0;
 431     errdesc->fdflags = 0;
 432
 433     indesc->fcb = infcb;
 434     outdesc->fcb = outfcb;
 435     errdesc->fcb = errfcb;
 436
 437     me = (struct Process *)FindTask (NULL);
 438     indesc->fcb->fh  = Input();
 439     outdesc->fcb->fh = Output();
 440     errdesc->fcb->fh = me->pr_CES ? me->pr_CES : me->pr_COS;
 441
 442     indesc->fcb->flags  = O_RDONLY;
 443     outdesc->fcb->flags = O_WRONLY | O_APPEND;
 444     errdesc->fcb->flags = O_WRONLY | O_APPEND;
 445
 446     indesc->fcb->opencount = outdesc->fcb->opencount = errdesc->fcb->opencount = 1;
 447     indesc->fcb->privflags = outdesc->fcb->privflags = errdesc->fcb->privflags = _FCB_DONTCLOSE_FH;
 448
 449     aroscbase->acb_fd_array[STDIN_FILENO]  = indesc;
 450     aroscbase->acb_fd_array[STDOUT_FILENO] = outdesc;
 451     aroscbase->acb_fd_array[STDERR_FILENO] = errdesc;
 452
 453     return 1;
 454 }
 455
 456 static int __copy_fdarray(fdesc **__src_fd_array, int numslots)
 457 {
 458     struct aroscbase *aroscbase = __GM_GetBase();
 459     int i;
 460
 461     for(i = numslots - 1; i >= 0; i--)
 462     {
 463         if(__src_fd_array[i])
 464         {
 465             if(__getfdslot(i) != i)
 466                 return 0;
 467
 468             if((aroscbase->acb_fd_array[i] = __alloc_fdesc()) == NULL)
 469                 return 0;
 470
 471             aroscbase->acb_fd_array[i]->fdflags = __src_fd_array[i]->fdflags;
 472             aroscbase->acb_fd_array[i]->fcb = __src_fd_array[i]->fcb;
 473             aroscbase->acb_fd_array[i]->fcb->opencount++;
 474         }
 475     }
 476
 477     return 1;
 478 }
 479
 480 int __init_fd(struct aroscbase *aroscbase)
 481 {
 482     struct __reg_fdarray *regnodeit, *regnode = NULL;
 483     struct Task *self = FindTask(NULL);
 484
 485     ObtainSemaphore(&__fdsem);
 486     ForeachNode(&__fdreglist, regnodeit)
 487     {
 488         if (regnodeit->task == self)
 489         {
 490             regnode = regnodeit;
 491
 492             D(bug("Found regnode: %p, fdarray: %p, numslots: %d\n",
 493                   regnode, regnode->fdarray, regnode->numslots
 494             ));
 495             Remove((struct Node *)regnode);
 496             break;
 497         }
 498     }
 499     ReleaseSemaphore(&__fdsem);
 500
 501     if (regnode == NULL)
 502         return __init_stdfiles(aroscbase);
 503     else
 504     {
 505         int ok = __copy_fdarray(regnode->fdarray, regnode->numslots);
 506
 507         FreeVec(regnode);
 508
 509         return ok;
 510     }
 511 }
 512
 513 void __exit_fd(struct aroscbase *aroscbase)
 514 {
 515     int i = aroscbase->acb_numslots;
 516     while (i)
 517     {
 518         if (aroscbase->acb_fd_array[--i])
 519             close(i);
 520     }
 521 }
 522
 523 void __close_on_exec_fdescs(void)
 524 {
 525     struct aroscbase *aroscbase = __GM_GetBase();
 526
 527     int i;
 528     fdesc *fd;
 529
 530     for (i = aroscbase->acb_numslots - 1; i >= 0; i--)
 531     {
 532         if ((fd = __getfdesc(i)) != NULL)
 533         {
 534             D(bug("__close_fdesc_on_exec: checking fd %d\n", i));
 535             if (fd->fdflags & FD_CLOEXEC)
 536             {
 537                 D(bug("__close_fdesc_on_exec: closing fd %d\n", i));
 538                 close(i);
 539             }
 540         }
 541     }
 542 }
 543
 544 #include <stdio.h>
 545
 546 void __updatestdio(void)
 547 {
 548     struct aroscbase *aroscbase = __GM_GetBase();
 549     struct Process *me;
 550
 551     me = (struct Process *)FindTask(NULL);
 552
 553     fflush(stdin);
 554     fflush(stdout);
 555     fflush(stderr);
 556
 557     aroscbase->acb_fd_array[STDIN_FILENO]->fcb->fh  = Input();
 558     aroscbase->acb_fd_array[STDOUT_FILENO]->fcb->fh = Output();
 559     aroscbase->acb_fd_array[STDERR_FILENO]->fcb->fh = me->pr_CES ? me->pr_CES : me->pr_COS;
 560
 561     aroscbase->acb_fd_array[STDIN_FILENO]->fcb->privflags =
 562         aroscbase->acb_fd_array[STDOUT_FILENO]->fcb->privflags =
 563         aroscbase->acb_fd_array[STDERR_FILENO]->fcb->privflags = _FCB_DONTCLOSE_FH;
 564 }
 565
 566 ADD2INIT(__init_vars, 0);
 567 ADD2OPENLIB(__init_fd, 2);
 568 ADD2CLOSELIB(__exit_fd, 2);
 569