Support for wincache

I am testing this out, I have it working on a development site I soon hope to make live.
I am having one minor problem possibly, I'm getting a lot of errors in my PHP log about line 208.

[02-Apr-2010 13:44:10] PHP Fatal error: Maximum execution time of 240 seconds exceeded in #### on line 208

Is this anything to be concerned about?

I am running:
Windows 2008 IIS7 x86
PHP 5.2.13
Wincache 1.1 Beta
Drupal 6.16
Cacherouter 6.x-1.x-dev

a piece of docs for readme file is needed mostly about pointing to help pages

sorry i should have specified, I assumed people would think I was talking about the wincache.php file attached to this thread.

I am also getting this error from time to time. and Twice have had this error fill up the page with hundreds of repeats.

warning: wincache_ucache_add() [function.wincache-ucache-add]: function called with a key which already exists in \sites\all\modules\contrib\cacherouter\engines\wincache.php on line 205.

Both this and the previous error are related to the function lock()

My site will run fine for awhile then grind to a halt, when this happens and i manage to get a pageload in, I see hundreds and hundresds of the above error. I've attached 2 screenshots of the "database logging" and a detail. Something odd to note, I clicked on the details for about 10 entries randomly, they all have "?fbc_channel=1" in the location

http://i355.photobucket.com/albums/r469/canadaka_bucket/wincache_ucache_...
http://i355.photobucket.com/albums/r469/canadaka_bucket/wincache_fbconne...

So could it be some incompatability with the fbconnect module? if so why does it run fine for a period then die.

There was idea to implement native locking functyionality in wincache because php under windows does not heve support for semaphores and shm

EDIT: as ugly solution I recommend to use @wincache_add() to suppess errors

I added PHP @ to supress the errors and increased the user cache memory in PHP.ini to "wincache.ucachesize=64" and i've been running the wincache engine all day with no errors so far.

Now that we have wincache_loc and wincache_unlock functionality, we should use that. Details aabout these functions are available at http://us3.php.net/manual/en/function.wincache-lock.php. The build which has these changes can be downloaded from http://sourceforge.net/projects/wincache/files/. Look under development folder.

One thing which we need to be careful about is the fact that lock name should comprise of chatracters which is allowed in file name. I have observed that currently we use things like C:\Windows\Temp\ as a lock. This will not work as name cannot have characters like \ and :. A modified code can be like:

function lock() {
// Lock once by trying to add lock file, if we can't get the lock, we will loop
// for 3 seconds attempting to get lock. If we still can't get it at that point,
// then we give up and return FALSE.
$key = $this->lock;
$key = strrchr($this->lock, '/');
$key = substr($key, 1);
if (wincache_lock($key) == FALSE) {
$time = time();
while (wincache_lock($key) == FALSE) {
if (time() - $time >= 3) {
return FALSE;
}
}
}
return TRUE;
}

function unlock() {
$key = $this->lock;
$key = strrchr($this->lock, '/');
$key = substr($key, 1);
return wincache_unlock($key);
}

Or something similar. I am not 100% sure but we need to either strip C:\WIndows\Temp or replace : and / with something which is acceptable as part of Windows file name.

@donraman your code is wrong take a look at eacc.php

  /**
   * lock()
   *   lock the cache from other writes.
   *
   * @param none
   * @return string
   *   Returns TRUE on success, FALSE on failure
   */
  function lock() {
    return eaccelerator_lock($this->lock);
  }

  /**
   * unlock()
   *   unlock the cache from other writes.
   *
   * @param none
   * @return bool
   *   Returns TRUE on success, FALSE on failure
   */
  function unlock() {
    return  eaccelerator_unlock($this->lock);
  }

The same should be done here

No need to loop through because
The execution of the current script will be blocked until the lock can be obtained.

Patch seems good to go! Need some reviews!

@andypost Thanks for clarifying it. Yes the lock will wait and hence there is no need to loop. I didn't realize it as the previous code was doing the loop. Good catch.

@tauno/@andypost Doing it eaacelerator way will not work as I already explained. The name of the object cannot contain backslash. And in your code if you print the name of the lock name ($this->lock) it prints something like C:\Windows\Temp/lock_file_name. The reason why backslash is not allowed is because we are using CreateMutex call as described at http://msdn.microsoft.com/en-us/library/ms682411(VS.85).aspx. So code should be something like:

  /**
   * lock()
   *   lock the cache from other writes.
   *
   * @param none
   * @return string
   *   Returns TRUE on success, FALSE on failure
   */
  function lock() {
    return wincache_lock(basename($this->lock));
  }

  /**
   * unlock()
   *   unlock the cache from other writes.
   *
   * @param none
   * @return bool
   *   Returns TRUE on success, FALSE on failure
   */
  function unlock() {
    return  wincache_unlock(basename($this->lock));
  }

Or something similar. You guys are the best judge for it. My point is all backslash ('\') should be stripped somehow, otherwise lock will fail.

Thanks,
Don

One additional information, I did test the new wincache.php with the above code and it works. This is just an information from my side.

Thanks,
Don.

@donraman thanx for explanation of implementation, there's no need to strip backslash form lock name because it's name is {prefix}_{cache_table}_lock
I think we could drop a line into readme about prefix that should not contain backslash

PS: I think you are using WaitForSingleObject() to wait for mutex get released so why not add a $timeout to wincache_lock() to make API more common for synchronization? Also it could prevent a deadlocks.

Patch looks fine for me, so I'm going to make some local tests and commit it.

Also I'm waiting more reviews.

@andypost thanks for the enhancement request. I have filed a change request at http://pecl.php.net/bugs/bug.php?id=17287. We will triage it appropriately and see when this can be considered.

where is the newest wincache.php code? I tried the code in psot #12 and it doens't work, the usercache is not populated. I'm trying to test out the new Wincache 1.1 Beta2

Sounds good, so I glad to commit this when I get a time

Not sure what the problem was, but this patch caused some pretty unpredictable behavior on my machine. It would fill the fastcgi queue and lock up my server. Disabled this patch and it never happended again. Sorry I could not provide more debugging info.

Double post. My bad

I heavily suspect it had to do with the locking issue. So i might not have the right wincache.php file. had a bunch of error in my logs:

[14-Oct-2010 15:37:07] PHP Warning: wincache_ucache_add() [<a href='function.wincache-ucache-add'>function.wincache-ucache-add</a>]: function called with a key which already exists in <snip>\sites\all\modules\cacherouter\engines\wincache.php on line 207

I was using the attached wincache.php which probably needs a couple of the patches in this post applied to it. Anyone mind posting their working wincache.php?

Thanks.

iis: 7.5
php: 5.2.14
wincache: 1.1.0630.0

NOTE: Do no use the wincache.php attached to this post.

Yup. I used the patch in #24 and its been working fine ever since. #29 is identical with what I am using.

Thank you very much for your help tauno and everyone else in this thread!

I've had CacheRouter/WinCache installed and running great for about two months now, but recently we noticed an issue - when we go to update a module, some files/folders won't delete, and for a short while (15 minutes to an hour) we lose all access to those files/folders in Windows. Then, mysteriously, the folders will either a) disappear or b) give us our access back so we can delete them.

Disabling CacheRouter and WinCache fixes the problem. Anyone else experiencing something similar?

Now that Drupal 7 is released is there anyway to utilize wincache's usercache with it? Seems cacherouter is not making a version for 7, so will there be a seperate wincache project?

I've started a WinCache implementation of DrupalCacheInterface here:
http://drupal.org/sandbox/Akaoni/1154744

It seems to be working fine, but it hasn't had any proper testing yet.

Seems no one has moved forward in creating a wincache module for Drupal 7. Your work is all I've seen.
I'm not sure how you utilize it? Once your module is enabled then what? Is there some lines that need to be added to settings.php?

$conf['cache_backends'] = array('sites/all/modules/wincache/wincache.module');
$conf['cache_class_cache'] = 'WinCacheDrupal';
$conf['cache_class_cache_bootstrap'] = 'WinCacheDrupal';

And executing variable_set('cache_class_cache', 'WinCacheDrupal'); via devel/php did the trick, now the site uses the wincache, everything seems to be fine so far

It seems that Microsoft have taken on this task over at http://drupal.org/sandbox/microsoft/1441326.

If you're at all interested in seeing this module happen, please help out by giving them a code review over at http://drupal.org/node/1473540

Changed version to 6.x-1-x dev, cacherouter module is not being ported to Drupal 7 or 8, and thus being deprecated.

I am not sure, but I think the issue should be closed.

For a Drupal 7 version of the Wincache Module visit:

https://www.drupal.org/project/wincachedrupal