Documentation cleanups.
[perl-fuse.git] / Fuse.xs
diff --git a/Fuse.xs b/Fuse.xs
index a211041..519037c 100755 (executable)
--- a/Fuse.xs
+++ b/Fuse.xs
@@ -5,13 +5,45 @@
 
 #include <fuse.h>
 
-#if defined(__FreeBSD__) || defined(__NetBSD__)
+#if (defined(__FreeBSD__) && __FreeBSD__ < 10) || defined(__NetBSD__)
 # define XATTR_CREATE 1
 # define XATTR_REPLACE 2
 #else
 # include <sys/xattr.h>
 #endif
 
+#if defined(__linux__)
+# define STAT_NSEC(st, st_xtim) ((st)->st_xtim.tv_nsec)
+#else
+# define STAT_NSEC(st, st_xtim) ((st)->st_xtim##espec.tv_nsec)
+#endif
+
+/* Implement a macro to handle multiple formats (integer, float, and array
+ * containing seconds and nanoseconds). */
+#define PULL_TIME(st, st_xtim, svp)                                    \
+{                                                                      \
+       SV *sv = svp;                                                   \
+       if (SvROK(sv)) {                                                \
+               AV *av = (AV *)SvRV(sv);                                \
+               if (SvTYPE((SV *)av) != SVt_PVAV) {                     \
+                       Perl_croak_nocontext("Reference was not array ref"); \
+               }                                                       \
+               if (av_len(av) != 1) {                                  \
+                       Perl_croak_nocontext("Array of incorrect dimension"); \
+               }                                                       \
+               (st)->st_xtim##e = SvIV(*(av_fetch(av, 0, FALSE)));     \
+               STAT_NSEC(st, st_xtim) = SvIV(*(av_fetch(av, 1, FALSE))); \
+       }                                                               \
+       else if (SvNOK(sv) || SvIOK(sv)) {                              \
+               double tm = SvNV(sv);                                   \
+               (st)->st_xtim##e = (int)tm;                             \
+               STAT_NSEC(st, st_xtim) = (tm - (int)tm) * 1000000000;   \
+       }                                                               \
+       else {                                                          \
+               Perl_croak_nocontext("Invalid data type passed");       \
+       }                                                               \
+}
+
 /* Determine if threads support should be included */
 #ifdef USE_ITHREADS
 # ifdef I_PTHREAD
@@ -33,8 +65,7 @@
 
 #define MY_CXT_KEY "Fuse::_guts" XS_VERSION
 #if FUSE_VERSION >= 28
-# define N_CALLBACKS 40
-/* # define N_CALLBACKS 41 */
+# define N_CALLBACKS 41
 #elif FUSE_VERSION >= 26
 # define N_CALLBACKS 38
 #elif FUSE_VERSION >= 25
@@ -55,6 +86,7 @@ typedef struct {
 #ifdef USE_ITHREADS
        perl_mutex mutex;
 #endif
+       int utimens_as_array;
 } my_cxt_t;
 START_MY_CXT;
 
@@ -130,8 +162,10 @@ void S_fh_store_handle(pTHX_ pMY_CXT_ struct fuse_file_info *fi, SV *sv) {
                        SvSHARE(sv);
                }
 #endif
-               MAGIC *mg = (SvTYPE(sv) == SVt_PVMG) ? mg_find(sv, PERL_MAGIC_shared_scalar) : NULL;
-               fi->fh = mg ? PTR2IV(mg->mg_ptr) : PTR2IV(sv);
+        /* This seems to be screwing things up... */
+               // MAGIC *mg = (SvTYPE(sv) == SVt_PVMG) ? mg_find(sv, PERL_MAGIC_shared_scalar) : NULL;
+               // fi->fh = mg ? PTR2IV(mg->mg_ptr) : PTR2IV(sv);
+               fi->fh = PTR2IV(sv);
                if(hv_store_ent(MY_CXT.handles, FH_KEY(fi), SvREFCNT_inc(sv), 0) == NULL) {
                        SvREFCNT_dec(sv);
                }
@@ -161,9 +195,9 @@ int _PLfuse_getattr(const char *file, struct stat *result) {
        } else {
                result->st_blocks = POPi;
                result->st_blksize = POPi;
-               result->st_ctime = POPi;
-               result->st_mtime = POPi;
-               result->st_atime = POPi;
+               PULL_TIME(result, st_ctim, POPs);
+               PULL_TIME(result, st_mtim, POPs);
+               PULL_TIME(result, st_atim, POPs);
                result->st_size = POPn; // we pop double here to support files larger than 4Gb (long limit)
                result->st_rdev = POPi;
                result->st_gid = POPi;
@@ -511,7 +545,7 @@ int _PLfuse_open (const char *file, struct fuse_file_info *fi) {
        (void) hv_store(fihash, "direct_io",    9, newSViv(fi->direct_io),   0);
        (void) hv_store(fihash, "keep_cache",  10, newSViv(fi->keep_cache),  0);
 #endif
-#if FUSE_VERSION >= 29
+#if FUSE_VERSION >= 28
        (void) hv_store(fihash, "nonseekable", 11, newSViv(fi->nonseekable), 0);
 #endif
        XPUSHs(sv_2mortal(newRV_noinc((SV*) fihash)));
@@ -539,7 +573,7 @@ int _PLfuse_open (const char *file, struct fuse_file_info *fi) {
                if ((svp = hv_fetch(fihash, "keep_cache",  10, 0)) != NULL)
                        fi->keep_cache  = SvIV(*svp);
 #endif
-#if FUSE_VERSION >= 29
+#if FUSE_VERSION >= 28
                if ((svp = hv_fetch(fihash, "nonseekable", 11, 0)) != NULL)
                        fi->nonseekable = SvIV(*svp);
 #endif
@@ -996,9 +1030,9 @@ int _PLfuse_readdir(const char *file, void *dirh, fuse_fill_dir_t dirfil,
                                                st.st_gid     = SvIV(*(av_fetch(av2,  5, FALSE)));
                                                st.st_rdev    = SvIV(*(av_fetch(av2,  6, FALSE)));
                                                st.st_size    = SvNV(*(av_fetch(av2,  7, FALSE)));
-                                               st.st_atime   = SvIV(*(av_fetch(av2,  8, FALSE)));
-                                               st.st_mtime   = SvIV(*(av_fetch(av2,  9, FALSE)));
-                                               st.st_ctime   = SvIV(*(av_fetch(av2, 10, FALSE)));
+                                               PULL_TIME(&st, st_atim, *(av_fetch(av2,  8, FALSE)));
+                                               PULL_TIME(&st, st_mtim, *(av_fetch(av2,  9, FALSE)));
+                                               PULL_TIME(&st, st_ctim, *(av_fetch(av2, 10, FALSE)));
                                                st.st_blksize = SvIV(*(av_fetch(av2, 11, FALSE)));
                                                st.st_blocks  = SvIV(*(av_fetch(av2, 12, FALSE)));
                                                st_filled = 1;
@@ -1169,7 +1203,7 @@ int _PLfuse_create(const char *file, mode_t mode, struct fuse_file_info *fi) {
        fihash = newHV();
        (void) hv_store(fihash, "direct_io",    9, newSViv(fi->direct_io),   0);
        (void) hv_store(fihash, "keep_cache",  10, newSViv(fi->keep_cache),  0);
-#if FUSE_VERSION >= 29
+#if FUSE_VERSION >= 28
        (void) hv_store(fihash, "nonseekable", 11, newSViv(fi->nonseekable), 0);
 #endif
        XPUSHs(sv_2mortal(newRV_noinc((SV*) fihash)));
@@ -1195,7 +1229,7 @@ int _PLfuse_create(const char *file, mode_t mode, struct fuse_file_info *fi) {
                        fi->direct_io   = SvIV(*svp);
                if ((svp = hv_fetch(fihash, "keep_cache",  10, 0)) != NULL)
                        fi->keep_cache  = SvIV(*svp);
-#if FUSE_VERSION >= 29
+#if FUSE_VERSION >= 28
                if ((svp = hv_fetch(fihash, "nonseekable", 11, 0)) != NULL)
                        fi->nonseekable = SvIV(*svp);
 #endif
@@ -1264,9 +1298,9 @@ int _PLfuse_fgetattr(const char *file, struct stat *result,
        } else {
                result->st_blocks = POPi;
                result->st_blksize = POPi;
-               result->st_ctime = POPi;
-               result->st_mtime = POPi;
-               result->st_atime = POPi;
+               PULL_TIME(result, st_ctim, POPs);
+               PULL_TIME(result, st_mtim, POPs);
+               PULL_TIME(result, st_atim, POPs);
                result->st_size = POPn; // we pop double here to support files larger than 4Gb (long limit)
                result->st_rdev = POPi;
                result->st_gid = POPi;
@@ -1364,8 +1398,30 @@ int _PLfuse_utimens(const char *file, const struct timespec tv[2]) {
        SAVETMPS;
        PUSHMARK(SP);
        XPUSHs(sv_2mortal(newSVpv(file,0)));
-       XPUSHs(tv ? sv_2mortal(newSVnv(tv[0].tv_sec + (tv[0].tv_nsec / 1000000000.0))) : &PL_sv_undef);
-       XPUSHs(tv ? sv_2mortal(newSVnv(tv[1].tv_sec + (tv[1].tv_nsec / 1000000000.0))) : &PL_sv_undef);
+       if (MY_CXT.utimens_as_array) {
+               /* Pushing timespecs as 2-element arrays (if tv is present). */
+               AV *av;
+               if (tv) {
+                       av = newAV();
+                       av_push(av, newSViv(tv[0].tv_sec));
+                       av_push(av, newSViv(tv[0].tv_nsec));
+                       XPUSHs(sv_2mortal(newRV_noinc((SV *)av)));
+                       av = newAV();
+                       av_push(av, newSViv(tv[1].tv_sec));
+                       av_push(av, newSViv(tv[1].tv_nsec));
+                       XPUSHs(sv_2mortal(newRV_noinc((SV *)av)));
+               }
+               else {
+                       XPUSHs(&PL_sv_undef);
+                       XPUSHs(&PL_sv_undef);
+               }
+
+       }
+       else {
+               /* Pushing timespecs as floating point (double) values. */
+               XPUSHs(tv ? sv_2mortal(newSVnv(tv[0].tv_sec + (tv[0].tv_nsec / 1000000000.0))) : &PL_sv_undef);
+               XPUSHs(tv ? sv_2mortal(newSVnv(tv[1].tv_sec + (tv[1].tv_nsec / 1000000000.0))) : &PL_sv_undef);
+       }
        PUTBACK;
        rv = call_sv(MY_CXT.callback[36],G_SCALAR);
        SPAGAIN;
@@ -1423,14 +1479,17 @@ int _PLfuse_bmap(const char *file, size_t blocksize, uint64_t *idx) {
 int _PLfuse_ioctl(const char *file, int cmd, void *arg,
                   struct fuse_file_info *fi, unsigned int flags, void *data) {
        int rv;
+       SV *sv = NULL;
        FUSE_CONTEXT_PRE;
        DEBUGf("ioctl begin\n");
        ENTER;
        SAVETMPS;
        PUSHMARK(SP);
        XPUSHs(sv_2mortal(newSVpv(file,0)));
-       XPUSHs(sv_2mortal(newSViv(cmd)));
-    XPUSHs(sv_2mortal(newSViv((uintptr_t)arg)));
+       /* I don't know why cmd is a signed int in the first place;
+        * casting as unsigned so stupid tricks don't have to be done on
+        * the perl side */
+       XPUSHs(sv_2mortal(newSViv((unsigned int)cmd)));
        XPUSHs(sv_2mortal(newSViv(flags)));
        if (_IOC_DIR(cmd) & _IOC_WRITE)
                XPUSHs(sv_2mortal(newSVpvn(data, _IOC_SIZE(cmd))));
@@ -1440,12 +1499,18 @@ int _PLfuse_ioctl(const char *file, int cmd, void *arg,
        PUTBACK;
        rv = call_sv(MY_CXT.callback[39],G_ARRAY);
        SPAGAIN;
-       if (_IOC_DIR(cmd) & _IOC_READ) {
-               if (rv == 2) {
-                       SV *sv = POPs;
+       if ((_IOC_DIR(cmd) & _IOC_READ) && (rv == 2)) {
+               sv = POPs;
+               rv--;
+       }
+
+       if (rv > 0)
+               rv = POPi;
+
+       if ((_IOC_DIR(cmd) & _IOC_READ) && !rv) {
+               if (sv) {
                        size_t len;
                        char *rdata = SvPV(sv, len);
-            rv--;
 
                        if (len > _IOC_SIZE(cmd)) {
                                fprintf(stderr, "ioctl(): returned data was too large for data area\n");
@@ -1457,12 +1522,10 @@ int _PLfuse_ioctl(const char *file, int cmd, void *arg,
                        }
                }
                else {
-                       fprintf(stderr, "ioctl(): ioctl was a write op, but no data was returned from call?\n");
+                       fprintf(stderr, "ioctl(): ioctl was a read op, but no data was returned from call?\n");
                        rv = -EFAULT;
                }
        }
-       if (rv > 0)
-               rv = POPi;
        FREETMPS;
        LEAVE;
        PUTBACK;
@@ -1471,12 +1534,42 @@ int _PLfuse_ioctl(const char *file, int cmd, void *arg,
        return rv;
 }
 
-#if 0
 int _PLfuse_poll(const char *file, struct fuse_file_info *fi,
                  struct fuse_pollhandle *ph, unsigned *reventsp) {
-
+       int rv;
+       SV *sv = NULL;
+       FUSE_CONTEXT_PRE;
+       DEBUGf("poll begin\n");
+       ENTER;
+       SAVETMPS;
+       PUSHMARK(SP);
+       XPUSHs(sv_2mortal(newSVpv(file,0)));
+       if (ph) {
+        /* Still gotta figure out how to do this right... */
+               sv = newSViv(PTR2IV(ph));
+        SvREADONLY_on(sv);
+               SvSHARE(sv);
+               XPUSHs(sv);
+       }
+       else
+               XPUSHs(&PL_sv_undef);
+       XPUSHs(sv_2mortal(newSViv(*reventsp)));
+       XPUSHs(FH_GETHANDLE(fi));
+       PUTBACK;
+       rv = call_sv(MY_CXT.callback[40],G_ARRAY);
+       SPAGAIN;
+       if (rv > 1) {
+               *reventsp = POPi;
+        rv--;
+    }
+       rv = (rv ? POPi : 0);
+       FREETMPS;
+       LEAVE;
+       PUTBACK;
+       DEBUGf("poll end: %i\n", rv);
+       FUSE_CONTEXT_POST;
+       return rv;
 }
-#endif
 #endif /* FUSE_VERSION >= 28 */
 
 struct fuse_operations _available_ops = {
@@ -1526,9 +1619,7 @@ bmap:                     _PLfuse_bmap,
 #endif /* FUSE_VERSION >= 26 */
 #if FUSE_VERSION >= 28
 ioctl:                 _PLfuse_ioctl,
-#if 0
 poll:                  _PLfuse_poll,
-#endif
 #endif /* FUSE_VERSION >= 28 */
 };
 
@@ -1613,7 +1704,6 @@ fuse_version()
        OUTPUT:
        RETVAL
 
-#ifndef __FreeBSD__
 SV *
 XATTR_CREATE()
        CODE:
@@ -1628,8 +1718,6 @@ XATTR_REPLACE()
        OUTPUT:
        RETVAL
 
-#endif
-
 void
 perl_fuse_main(...)
        PREINIT:
@@ -1641,7 +1729,7 @@ perl_fuse_main(...)
        struct fuse_chan *fc;
        dMY_CXT;
        INIT:
-       if(items != N_CALLBACKS + 5) {
+       if(items != N_CALLBACKS + 6) {
                fprintf(stderr,"Perl<->C inconsistency or internal error\n");
                XSRETURN_UNDEF;
        }
@@ -1667,8 +1755,9 @@ perl_fuse_main(...)
 #if FUSE_VERSION >= 28
        fops.flag_nullpath_ok = SvIV(ST(4));
 #endif /* FUSE_VERSION >= 28 */
+       MY_CXT.utimens_as_array = SvIV(ST(5));
        for(i=0;i<N_CALLBACKS;i++) {
-               SV *var = ST(i+5);
+               SV *var = ST(i+6);
                /* allow symbolic references, or real code references. */
                if(SvOK(var) && (SvPOK(var) || (SvROK(var) && SvTYPE(SvRV(var)) == SVt_PVCV))) {
                        void **tmp1 = (void**)&_available_ops, **tmp2 = (void**)&fops;
@@ -1683,7 +1772,7 @@ perl_fuse_main(...)
                } else if(SvOK(var)) {
                        croak("invalid callback (%i) passed to perl_fuse_main "
                              "(%s is not a string, code ref, or undef).\n",
-                             i+5,SvPVbyte_nolen(var));
+                             i+6,SvPVbyte_nolen(var));
                } else {
                        MY_CXT.callback[i] = NULL;
                }
@@ -1718,3 +1807,35 @@ perl_fuse_main(...)
                fuse_loop(fuse_new(fc,&args,&fops,sizeof(fops),NULL));
        fuse_unmount(mountpoint,fc);
        fuse_opt_free_args(&args);
+
+#if FUSE_VERSION >= 28
+
+void
+pollhandle_destroy(...)
+    PREINIT:
+       struct fuse_pollhandle *ph;
+    INIT:
+        if (items != 1) {
+            fprintf(stderr, "No pollhandle passed?\n");
+            XSRETURN_UNDEF;
+        }
+       CODE:
+        ph = INT2PTR(struct fuse_pollhandle*, SvIV(ST(0)));
+               fuse_pollhandle_destroy(ph);
+
+int 
+notify_poll(...)
+    PREINIT:
+        struct fuse_pollhandle *ph;
+    INIT:
+        if (items != 1) {
+            fprintf(stderr, "No pollhandle passed?\n");
+            XSRETURN_UNDEF;
+        }
+       CODE:
+        ph = INT2PTR(struct fuse_pollhandle*, SvIV(ST(0)));
+               RETVAL = fuse_notify_poll(ph);
+       OUTPUT:
+               RETVAL
+
+#endif