src/lib_io.c

   1 /*
   2 ** I/O library.
   3 ** Copyright (C) 2005-2014 Mike Pall. See Copyright Notice in luajit.h
   4 **
   5 ** Major portions taken verbatim or adapted from the Lua interpreter.
   6 ** Copyright (C) 1994-2011 Lua.org, PUC-Rio. See Copyright Notice in lua.h
   7 */
   8
   9 #include <errno.h>
  10 #include <stdio.h>
  11
  12 #define lib_io_c
  13 #define LUA_LIB
  14
  15 #include "lua.h"
  16 #include "lauxlib.h"
  17 #include "lualib.h"
  18
  19 #include "lj_obj.h"
  20 #include "lj_gc.h"
  21 #include "lj_err.h"
  22 #include "lj_buf.h"
  23 #include "lj_str.h"
  24 #include "lj_state.h"
  25 #include "lj_strfmt.h"
  26 #include "lj_ff.h"
  27 #include "lj_lib.h"
  28
  29 /* Userdata payload for I/O file. */
  30 typedef struct IOFileUD {
  31   FILE *fp;             /* File handle. */
  32   uint32_t type;        /* File type. */
  33 } IOFileUD;
  34
  35 #define IOFILE_TYPE_FILE        0       /* Regular file. */
  36 #define IOFILE_TYPE_PIPE        1       /* Pipe. */
  37 #define IOFILE_TYPE_STDF        2       /* Standard file handle. */
  38 #define IOFILE_TYPE_MASK        3
  39
  40 #define IOFILE_FLAG_CLOSE       4       /* Close after io.lines() iterator. */
  41
  42 #define IOSTDF_UD(L, id)        (&gcref(G(L)->gcroot[(id)])->ud)
  43 #define IOSTDF_IOF(L, id)       ((IOFileUD *)uddata(IOSTDF_UD(L, (id))))
  44
  45 /* -- Open/close helpers -------------------------------------------------- */
  46
  47 static IOFileUD *io_tofilep(lua_State *L)
  48 {
  49   if (!(L->base < L->top && tvisudata(L->base) &&
  50         udataV(L->base)->udtype == UDTYPE_IO_FILE))
  51     lj_err_argtype(L, 1, "FILE*");
  52   return (IOFileUD *)uddata(udataV(L->base));
  53 }
  54
  55 static IOFileUD *io_tofile(lua_State *L)
  56 {
  57   IOFileUD *iof = io_tofilep(L);
  58   if (iof->fp == NULL)
  59     lj_err_caller(L, LJ_ERR_IOCLFL);
  60   return iof;
  61 }
  62
  63 static FILE *io_stdfile(lua_State *L, ptrdiff_t id)
  64 {
  65   IOFileUD *iof = IOSTDF_IOF(L, id);
  66   if (iof->fp == NULL)
  67     lj_err_caller(L, LJ_ERR_IOSTDCL);
  68   return iof->fp;
  69 }
  70
  71 static IOFileUD *io_file_new(lua_State *L)
  72 {
  73   IOFileUD *iof = (IOFileUD *)lua_newuserdata(L, sizeof(IOFileUD));
  74   GCudata *ud = udataV(L->top-1);
  75   ud->udtype = UDTYPE_IO_FILE;
  76   /* NOBARRIER: The GCudata is new (marked white). */
  77   setgcrefr(ud->metatable, curr_func(L)->c.env);
  78   iof->fp = NULL;
  79   iof->type = IOFILE_TYPE_FILE;
  80   return iof;
  81 }
  82
  83 static IOFileUD *io_file_open(lua_State *L, const char *mode)
  84 {
  85   const char *fname = strdata(lj_lib_checkstr(L, 1));
  86   IOFileUD *iof = io_file_new(L);
  87   iof->fp = fopen(fname, mode);
  88   if (iof->fp == NULL)
  89     luaL_argerror(L, 1, lj_strfmt_pushf(L, "%s: %s", fname, strerror(errno)));
  90   return iof;
  91 }
  92
  93 static int io_file_close(lua_State *L, IOFileUD *iof)
  94 {
  95   int ok;
  96   if ((iof->type & IOFILE_TYPE_MASK) == IOFILE_TYPE_FILE) {
  97     ok = (fclose(iof->fp) == 0);
  98   } else if ((iof->type & IOFILE_TYPE_MASK) == IOFILE_TYPE_PIPE) {
  99     int stat = -1;
 100 #if LJ_TARGET_POSIX
 101     stat = pclose(iof->fp);
 102 #elif LJ_TARGET_WINDOWS
 103     stat = _pclose(iof->fp);
 104 #else
 105     lua_assert(0);
 106     return 0;
 107 #endif
 108 #if LJ_52
 109     iof->fp = NULL;
 110     return luaL_execresult(L, stat);
 111 #else
 112     ok = (stat != -1);
 113 #endif
 114   } else {
 115     lua_assert((iof->type & IOFILE_TYPE_MASK) == IOFILE_TYPE_STDF);
 116     setnilV(L->top++);
 117     lua_pushliteral(L, "cannot close standard file");
 118     return 2;
 119   }
 120   iof->fp = NULL;
 121   return luaL_fileresult(L, ok, NULL);
 122 }
 123
 124 /* -- Read/write helpers -------------------------------------------------- */
 125
 126 static int io_file_readnum(lua_State *L, FILE *fp)
 127 {
 128   lua_Number d;
 129   if (fscanf(fp, LUA_NUMBER_SCAN, &d) == 1) {
 130     if (LJ_DUALNUM) {
 131       int32_t i = lj_num2int(d);
 132       if (d == (lua_Number)i && !tvismzero((cTValue *)&d)) {
 133         setintV(L->top++, i);
 134         return 1;
 135       }
 136     }
 137     setnumV(L->top++, d);
 138     return 1;
 139   } else {
 140     setnilV(L->top++);
 141     return 0;
 142   }
 143 }
 144
 145 static int io_file_readline(lua_State *L, FILE *fp, MSize chop)
 146 {
 147   MSize m = LUAL_BUFFERSIZE, n = 0, ok = 0;
 148   char *buf;
 149   for (;;) {
 150     buf = lj_buf_tmp(L, m);
 151     if (fgets(buf+n, m-n, fp) == NULL) break;
 152     n += (MSize)strlen(buf+n);
 153     ok |= n;
 154     if (n && buf[n-1] == '\n') { n -= chop; break; }
 155     if (n >= m - 64) m += m;
 156   }
 157   setstrV(L, L->top++, lj_str_new(L, buf, (size_t)n));
 158   lj_gc_check(L);
 159   return (int)ok;
 160 }
 161
 162 static void io_file_readall(lua_State *L, FILE *fp)
 163 {
 164   MSize m, n;
 165   for (m = LUAL_BUFFERSIZE, n = 0; ; m += m) {
 166     char *buf = lj_buf_tmp(L, m);
 167     n += (MSize)fread(buf+n, 1, m-n, fp);
 168     if (n != m) {
 169       setstrV(L, L->top++, lj_str_new(L, buf, (size_t)n));
 170       lj_gc_check(L);
 171       return;
 172     }
 173   }
 174 }
 175
 176 static int io_file_readlen(lua_State *L, FILE *fp, MSize m)
 177 {
 178   if (m) {
 179     char *buf = lj_buf_tmp(L, m);
 180     MSize n = (MSize)fread(buf, 1, m, fp);
 181     setstrV(L, L->top++, lj_str_new(L, buf, (size_t)n));
 182     lj_gc_check(L);
 183     return (n > 0 || m == 0);
 184   } else {
 185     int c = getc(fp);
 186     ungetc(c, fp);
 187     setstrV(L, L->top++, &G(L)->strempty);
 188     return (c != EOF);
 189   }
 190 }
 191
 192 static int io_file_read(lua_State *L, FILE *fp, int start)
 193 {
 194   int ok, n, nargs = (int)(L->top - L->base) - start;
 195   clearerr(fp);
 196   if (nargs == 0) {
 197     ok = io_file_readline(L, fp, 1);
 198     n = start+1;  /* Return 1 result. */
 199   } else {
 200     /* The results plus the buffers go on top of the args. */
 201     luaL_checkstack(L, nargs+LUA_MINSTACK, "too many arguments");
 202     ok = 1;
 203     for (n = start; nargs-- && ok; n++) {
 204       if (tvisstr(L->base+n)) {
 205         const char *p = strVdata(L->base+n);
 206         if (p[0] != '*')
 207           lj_err_arg(L, n+1, LJ_ERR_INVOPT);
 208         if (p[1] == 'n')
 209           ok = io_file_readnum(L, fp);
 210         else if ((p[1] & ~0x20) == 'L')
 211           ok = io_file_readline(L, fp, (p[1] == 'l'));
 212         else if (p[1] == 'a')
 213           io_file_readall(L, fp);
 214         else
 215           lj_err_arg(L, n+1, LJ_ERR_INVFMT);
 216       } else if (tvisnumber(L->base+n)) {
 217         ok = io_file_readlen(L, fp, (MSize)lj_lib_checkint(L, n+1));
 218       } else {
 219         lj_err_arg(L, n+1, LJ_ERR_INVOPT);
 220       }
 221     }
 222   }
 223   if (ferror(fp))
 224     return luaL_fileresult(L, 0, NULL);
 225   if (!ok)
 226     setnilV(L->top-1);  /* Replace last result with nil. */
 227   return n - start;
 228 }
 229
 230 static int io_file_write(lua_State *L, FILE *fp, int start)
 231 {
 232   cTValue *tv;
 233   int status = 1;
 234   for (tv = L->base+start; tv < L->top; tv++) {
 235     char buf[STRFMT_MAXBUF_NUM];
 236     MSize len;
 237     const char *p = lj_strfmt_wstrnum(buf, tv, &len);
 238     if (!p)
 239       lj_err_argt(L, (int)(tv - L->base) + 1, LUA_TSTRING);
 240     status = status && (fwrite(p, 1, len, fp) == len);
 241   }
 242   if (LJ_52 && status) {
 243     L->top = L->base+1;
 244     if (start == 0)
 245       setudataV(L, L->base, IOSTDF_UD(L, GCROOT_IO_OUTPUT));
 246     return 1;
 247   }
 248   return luaL_fileresult(L, status, NULL);
 249 }
 250
 251 static int io_file_iter(lua_State *L)
 252 {
 253   GCfunc *fn = curr_func(L);
 254   IOFileUD *iof = uddata(udataV(&fn->c.upvalue[0]));
 255   int n = fn->c.nupvalues - 1;
 256   if (iof->fp == NULL)
 257     lj_err_caller(L, LJ_ERR_IOCLFL);
 258   L->top = L->base;
 259   if (n) {  /* Copy upvalues with options to stack. */
 260     if (n > LUAI_MAXCSTACK)
 261       lj_err_caller(L, LJ_ERR_STKOV);
 262     lj_state_checkstack(L, (MSize)n);
 263     memcpy(L->top, &fn->c.upvalue[1], n*sizeof(TValue));
 264     L->top += n;
 265   }
 266   n = io_file_read(L, iof->fp, 0);
 267   if (ferror(iof->fp))
 268     lj_err_callermsg(L, strVdata(L->top-2));
 269   if (tvisnil(L->base) && (iof->type & IOFILE_FLAG_CLOSE)) {
 270     io_file_close(L, iof);  /* Return values are ignored. */
 271     return 0;
 272   }
 273   return n;
 274 }
 275
 276 /* -- I/O file methods ---------------------------------------------------- */
 277
 278 #define LJLIB_MODULE_io_method
 279
 280 LJLIB_CF(io_method_close)
 281 {
 282   IOFileUD *iof = L->base < L->top ? io_tofile(L) :
 283                   IOSTDF_IOF(L, GCROOT_IO_OUTPUT);
 284   return io_file_close(L, iof);
 285 }
 286
 287 LJLIB_CF(io_method_read)
 288 {
 289   return io_file_read(L, io_tofile(L)->fp, 1);
 290 }
 291
 292 LJLIB_CF(io_method_write)               LJLIB_REC(io_write 0)
 293 {
 294   return io_file_write(L, io_tofile(L)->fp, 1);
 295 }
 296
 297 LJLIB_CF(io_method_flush)               LJLIB_REC(io_flush 0)
 298 {
 299   return luaL_fileresult(L, fflush(io_tofile(L)->fp) == 0, NULL);
 300 }
 301
 302 LJLIB_CF(io_method_seek)
 303 {
 304   FILE *fp = io_tofile(L)->fp;
 305   int opt = lj_lib_checkopt(L, 2, 1, "\3set\3cur\3end");
 306   int64_t ofs = 0;
 307   cTValue *o;
 308   int res;
 309   if (opt == 0) opt = SEEK_SET;
 310   else if (opt == 1) opt = SEEK_CUR;
 311   else if (opt == 2) opt = SEEK_END;
 312   o = L->base+2;
 313   if (o < L->top) {
 314     if (tvisint(o))
 315       ofs = (int64_t)intV(o);
 316     else if (tvisnum(o))
 317       ofs = (int64_t)numV(o);
 318     else if (!tvisnil(o))
 319       lj_err_argt(L, 3, LUA_TNUMBER);
 320   }
 321 #if LJ_TARGET_POSIX
 322   res = fseeko(fp, ofs, opt);
 323 #elif _MSC_VER >= 1400
 324   res = _fseeki64(fp, ofs, opt);
 325 #elif defined(__MINGW32__)
 326   res = fseeko64(fp, ofs, opt);
 327 #else
 328   res = fseek(fp, (long)ofs, opt);
 329 #endif
 330   if (res)
 331     return luaL_fileresult(L, 0, NULL);
 332 #if LJ_TARGET_POSIX
 333   ofs = ftello(fp);
 334 #elif _MSC_VER >= 1400
 335   ofs = _ftelli64(fp);
 336 #elif defined(__MINGW32__)
 337   ofs = ftello64(fp);
 338 #else
 339   ofs = (int64_t)ftell(fp);
 340 #endif
 341   setint64V(L->top-1, ofs);
 342   return 1;
 343 }
 344
 345 LJLIB_CF(io_method_setvbuf)
 346 {
 347   FILE *fp = io_tofile(L)->fp;
 348   int opt = lj_lib_checkopt(L, 2, -1, "\4full\4line\2no");
 349   size_t sz = (size_t)lj_lib_optint(L, 3, LUAL_BUFFERSIZE);
 350   if (opt == 0) opt = _IOFBF;
 351   else if (opt == 1) opt = _IOLBF;
 352   else if (opt == 2) opt = _IONBF;
 353   return luaL_fileresult(L, setvbuf(fp, NULL, opt, sz) == 0, NULL);
 354 }
 355
 356 LJLIB_CF(io_method_lines)
 357 {
 358   io_tofile(L);
 359   lua_pushcclosure(L, io_file_iter, (int)(L->top - L->base));
 360   return 1;
 361 }
 362
 363 LJLIB_CF(io_method___gc)
 364 {
 365   IOFileUD *iof = io_tofilep(L);
 366   if (iof->fp != NULL && (iof->type & IOFILE_TYPE_MASK) != IOFILE_TYPE_STDF)
 367     io_file_close(L, iof);
 368   return 0;
 369 }
 370
 371 LJLIB_CF(io_method___tostring)
 372 {
 373   IOFileUD *iof = io_tofilep(L);
 374   if (iof->fp != NULL)
 375     lua_pushfstring(L, "file (%p)", iof->fp);
 376   else
 377     lua_pushliteral(L, "file (closed)");
 378   return 1;
 379 }
 380
 381 LJLIB_PUSH(top-1) LJLIB_SET(__index)
 382
 383 #include "lj_libdef.h"
 384
 385 /* -- I/O library functions ----------------------------------------------- */
 386
 387 #define LJLIB_MODULE_io
 388
 389 LJLIB_PUSH(top-2) LJLIB_SET(!)  /* Set environment. */
 390
 391 LJLIB_CF(io_open)
 392 {
 393   const char *fname = strdata(lj_lib_checkstr(L, 1));
 394   GCstr *s = lj_lib_optstr(L, 2);
 395   const char *mode = s ? strdata(s) : "r";
 396   IOFileUD *iof = io_file_new(L);
 397   iof->fp = fopen(fname, mode);
 398   return iof->fp != NULL ? 1 : luaL_fileresult(L, 0, fname);
 399 }
 400
 401 LJLIB_CF(io_popen)
 402 {
 403 #if LJ_TARGET_POSIX || LJ_TARGET_WINDOWS
 404   const char *fname = strdata(lj_lib_checkstr(L, 1));
 405   GCstr *s = lj_lib_optstr(L, 2);
 406   const char *mode = s ? strdata(s) : "r";
 407   IOFileUD *iof = io_file_new(L);
 408   iof->type = IOFILE_TYPE_PIPE;
 409 #if LJ_TARGET_POSIX
 410   fflush(NULL);
 411   iof->fp = popen(fname, mode);
 412 #else
 413   iof->fp = _popen(fname, mode);
 414 #endif
 415   return iof->fp != NULL ? 1 : luaL_fileresult(L, 0, fname);
 416 #else
 417   return luaL_error(L, LUA_QL("popen") " not supported");
 418 #endif
 419 }
 420
 421 LJLIB_CF(io_tmpfile)
 422 {
 423   IOFileUD *iof = io_file_new(L);
 424 #if LJ_TARGET_PS3 || LJ_TARGET_PS4 || LJ_TARGET_PSVITA
 425   iof->fp = NULL; errno = ENOSYS;
 426 #else
 427   iof->fp = tmpfile();
 428 #endif
 429   return iof->fp != NULL ? 1 : luaL_fileresult(L, 0, NULL);
 430 }
 431
 432 LJLIB_CF(io_close)
 433 {
 434   return lj_cf_io_method_close(L);
 435 }
 436
 437 LJLIB_CF(io_read)
 438 {
 439   return io_file_read(L, io_stdfile(L, GCROOT_IO_INPUT), 0);
 440 }
 441
 442 LJLIB_CF(io_write)              LJLIB_REC(io_write GCROOT_IO_OUTPUT)
 443 {
 444   return io_file_write(L, io_stdfile(L, GCROOT_IO_OUTPUT), 0);
 445 }
 446
 447 LJLIB_CF(io_flush)              LJLIB_REC(io_flush GCROOT_IO_OUTPUT)
 448 {
 449   return luaL_fileresult(L, fflush(io_stdfile(L, GCROOT_IO_OUTPUT)) == 0, NULL);
 450 }
 451
 452 static int io_std_getset(lua_State *L, ptrdiff_t id, const char *mode)
 453 {
 454   if (L->base < L->top && !tvisnil(L->base)) {
 455     if (tvisudata(L->base)) {
 456       io_tofile(L);
 457       L->top = L->base+1;
 458     } else {
 459       io_file_open(L, mode);
 460     }
 461     /* NOBARRIER: The standard I/O handles are GC roots. */
 462     setgcref(G(L)->gcroot[id], gcV(L->top-1));
 463   } else {
 464     setudataV(L, L->top++, IOSTDF_UD(L, id));
 465   }
 466   return 1;
 467 }
 468
 469 LJLIB_CF(io_input)
 470 {
 471   return io_std_getset(L, GCROOT_IO_INPUT, "r");
 472 }
 473
 474 LJLIB_CF(io_output)
 475 {
 476   return io_std_getset(L, GCROOT_IO_OUTPUT, "w");
 477 }
 478
 479 LJLIB_CF(io_lines)
 480 {
 481   if (L->base == L->top) setnilV(L->top++);
 482   if (!tvisnil(L->base)) {  /* io.lines(fname) */
 483     IOFileUD *iof = io_file_open(L, "r");
 484     iof->type = IOFILE_TYPE_FILE|IOFILE_FLAG_CLOSE;
 485     L->top--;
 486     setudataV(L, L->base, udataV(L->top));
 487   } else {  /* io.lines() iterates over stdin. */
 488     setudataV(L, L->base, IOSTDF_UD(L, GCROOT_IO_INPUT));
 489   }
 490   lua_pushcclosure(L, io_file_iter, (int)(L->top - L->base));
 491   return 1;
 492 }
 493
 494 LJLIB_CF(io_type)
 495 {
 496   cTValue *o = lj_lib_checkany(L, 1);
 497   if (!(tvisudata(o) && udataV(o)->udtype == UDTYPE_IO_FILE))
 498     setnilV(L->top++);
 499   else if (((IOFileUD *)uddata(udataV(o)))->fp != NULL)
 500     lua_pushliteral(L, "file");
 501   else
 502     lua_pushliteral(L, "closed file");
 503   return 1;
 504 }
 505
 506 #include "lj_libdef.h"
 507
 508 /* ------------------------------------------------------------------------ */
 509
 510 static GCobj *io_std_new(lua_State *L, FILE *fp, const char *name)
 511 {
 512   IOFileUD *iof = (IOFileUD *)lua_newuserdata(L, sizeof(IOFileUD));
 513   GCudata *ud = udataV(L->top-1);
 514   ud->udtype = UDTYPE_IO_FILE;
 515   /* NOBARRIER: The GCudata is new (marked white). */
 516   setgcref(ud->metatable, gcV(L->top-3));
 517   iof->fp = fp;
 518   iof->type = IOFILE_TYPE_STDF;
 519   lua_setfield(L, -2, name);
 520   return obj2gco(ud);
 521 }
 522
 523 LUALIB_API int luaopen_io(lua_State *L)
 524 {
 525   LJ_LIB_REG(L, NULL, io_method);
 526   copyTV(L, L->top, L->top-1); L->top++;
 527   lua_setfield(L, LUA_REGISTRYINDEX, LUA_FILEHANDLE);
 528   LJ_LIB_REG(L, LUA_IOLIBNAME, io);
 529   setgcref(G(L)->gcroot[GCROOT_IO_INPUT], io_std_new(L, stdin, "stdin"));
 530   setgcref(G(L)->gcroot[GCROOT_IO_OUTPUT], io_std_new(L, stdout, "stdout"));
 531   io_std_new(L, stderr, "stderr");
 532   return 1;
 533 }
 534