Abstract:
A method for moving open files on a computer system is disclosed. According to one aspect of the invention, an open file may be accessed by a user while being moved. To ensure accuracy, if data is to be written to an open file while it is being moved, the data is written to both the old and new locations.

Description:
This application is a continuation of application Ser. No. 08/400,002, filed Mar. 6, 1995 entitled &#34;METHOD FOR MOVING AN OPEN FILE BEING ACCESSED BY AT LEAST ONE USER, which is a continuation of application Ser. No. 07/987,755, filed Dec. 7, 1992, now abandoned. 
    
    
     FIELD OF THE INVENTION 
     The invention relates to an apparatus and method for moving open files in a computer system. 
     BACKGROUND OF THE INVENTION 
     It is well known in the computer field that for performance and other reasons, it is desirable to defragment (i.e., consolidate the segments of a file into one logically contiguous location on a disk) and/or optimize the position of files at a location on a disk other than their current location. Typically, defragmenting and positioning have been performed on files not currently in use. 
     Commercial defragmenters and disk optimizers (which both defragment and/or optimize file position on a disk) have been available for a number of years. Specifically, defragmenters and disk optimizers for use in the VAX/VMS marketplace are available. While the discussion herein is primarily directed to the VAX/VMS, application of this method to other systems will be readily apparent to one of ordinary skill in the art. However, none of these products can move files that are concurrently being read and written (i.e., &#34;open&#34; files). These commercial defragmenters and disk optimizers have a number of key features which are necessary to make them generally useful. Among these necessary and currently available functions are the following. 
     First, the software must run in a VAXcluster. VAXcluster is the name of the software environment created by DEC which allows multiple VAX systems to be linked together in such a way that any or all of the systems can share the disks on any or all of the other systems just as though those disks were attached to the local systems. 
     Second, the operation must be completely transparent to any and all user applications. That is, all user programs must run exactly the same and produce the exact same results, regardless of whether or not files are being defragmented or moved. Currently available software accomplishes this feat in part by not moving files that are currently being accessed by other users. If another user were to try to access the file being moved, that user would either be stalled until the file move was completed or else the file move would be aborted, leaving the old version of the file for the user to access. 
     Third, the move file operation must be &#34;atomic.&#34; That is, a file can never be left in an intermediate state. For example, it is possible that a system can crash at any time (for example, due to a power failure, hardware failure, etc.). Regardless of the nature of the failure, the file must be left either in its original state or else in its completely copied state. 
     The reference to &#34;locks&#34; herein is intended to refer to the standard Distributed Lock Manager locks described in the VAX/VMS documentation set. These are logical locks on arbitrary &#34;resources&#34; whose names can be up to 31 characters. The lock manager is a standard part of the VMS operating system and is maintained cluster-wide by VMS through standard VMS system calls. A working knowledge of the Distributed Lock Manager is assumed. 
     One prior software package is called Perfect Disk (&#34;PD&#34;), which operates as follows. When a process in the VMS file system tries to open, close, extend, or delete a file, the XQP (the file system processing code) takes out a &#34;protected write&#34; mode (PW) lock on the file that is called the &#34;file serialization&#34; lock. Its name is F11B$s+the file identification number. This lock will be referred to herein as the F11B$s lock or the file serialization lock. By taking out this lock, the system can check the status of the file (opened, closed, etc.) and be guaranteed that no other user will change the status while it is doing so. When the status check or state change is completed, the XQP gives up the lock so that other users may access the file. 
     When PD determines that it would like to move a particular file, it starts by taking out &#34;file serialization&#34; lock in &#34;protected read&#34; (PR) mode with a &#34;blocking AST&#34; (the blocking AST causes a notification if another user tries to take out an incompatible lock). While it holds the F11B$s lock in PR mode, no other users in the cluster can change the state of its access. In particular, if no other user has the file open, then no other user can access the file while the lock is held. 
     After PD acquires the lock, it checks locally to determine if another user has the file open locally. This is done by searching the file control blocks (FCBs) maintained in main memory by the XQP for all open files. If it is not open on the local node, then PD takes out a &#34;file access arbitration&#34; lock (referred herein as the F11B$a lock) in null (NL) mode. If a file is open on any node in a VAXcluster, then there exists such a lock on that node. PD can then do a $GETLKI (get lock information) system call and determine how many such locks exist in the cluster. If there is more than one (PD&#39;s lock), then another user has the file open and PD will not attempt to move the file. PD then drops the F11B$a lock since it has no further use for it at that time. Assuming the process is to continue, PD then allocates space on the disk at the target location for the defragmented/optimized version of the file. It reads the file data from the old location and writes it to the new location. A verification pass can be performed if desired to guarantee that the data was correctly copied. Up to this point, if the system crashes for some reason, the old file exists as always and there is no problem. The space allocated for the new version of the file will be deallocated when the disk bitmap is rebuilt, a normal operation at start-up. 
     As is well known, a file on a disk contains not only the data portion of the file, but also a file header containing &#34;metadata.&#34; This file header contains data about the file including its name, size, creation, last backup, expiration, and modification dates, and mapping pointers that describe where the data portion of the file exists on the disk. The file header typically exists in block(s), and if it exists in more than one block, PD only moves the portion mapped by one file header block at a time. PD reads the old header, rewrites the file mapping pointers in memory, and then queues the rewrite of the header to disk. Either this rewrite succeeds or it fails. If it succeeds, then the file exists at its new location. If it fails, it exists at its old location. PD then deallocates the space where the old version of the file existed and drops the F11B$s lock so other users can then access the file. Note that any user that tried to access the file while PD was copying it was naturally put into a wait state by the lock manager (the process would be waiting to get its F11B$s lock in PW mode). When PD drops the F11B$s lock, the process may resume. 
     The foregoing method is useful for moving files (or segments) that are not open. However, various problems arise when trying to move open files. As a result, the above scheme is inadequate to move &#34;open files&#34; (i.e., files that are being accessed for read or write by other users). While it has been previously recognized that it would be desirable to perform these functions while users are using the system and perhaps even the very file(s) to be defragmented or positioned, no solution to the various problems associated with such a capability has been provided. For example, in trying to move open files, one or more of the following problems may arise, among others. 
     A user that has the file open (anywhere in the cluster) has two data structures in memory that describe the state of the file and its location. The first is the file control block (FCB) mentioned before. It may have information that indicates the logical blocking number on the disk of the first block of the file (if the file is contiguous). It also has a &#34;window control block&#34; (WCB) that indicates where at least a portion of the file exists on the disk. If PD moves the file without causing these structures to be updated, then the reads and writes depending upon these structures will read and write where the file previously existed. This is undesirable. 
     For example, consider the case where a user is writing to the file while it is being copied. The writes must be coordinated with the copy of the file. For example, if a portion of the file has been read from the old location and written to the new location, then the writes must be made over the new portion of the file. If the write is to a portion of the file that has not yet been copied, then it must be made to the old portion of the file so that when PD copies over the new portion of the file, updated data will be written. If a user extends a file (that is, allocates more space to the file, and perhaps writes new data to it), PD must make sure that the new segment(s) of the file exists somehow in the new version of the file. If a user write to the file&#39;s new location should fail to properly write the data due to some I/O error (perhaps a bad spot on the surface of the disk) that would not have occurred writing to the file in its old location, then PD must be notified that the new copy of the file is bad so that it will not complete the copy operation. Various other concerns and problems also exist when trying to open files. 
     DEC and third-party developers have written products for the highly competitive defragmenter market since at least 1985 but none of these products has moved open files. Potential developers would be highly motivated to provide such a capability because of the great marketing and technical advantages of being able to work on all of the files on a disk instead of just a portion of them. The failure of others to provide a workable solution evidences the long-felt but unfulfilled need to move open files. 
     SUMMARY OF THE INVENTION 
     It is an object of the invention to overcome these and other drawbacks of the prior art. More specifically, it is one object of the invention to provide a method for moving open files. 
     In order to solve the foregoing and other problems, a cooperating &#34;server&#34; process is provided on each node in the VAXcluster. In this description, the file moving process will be called PD, and the server process will be called PD --  SERVER. 
    
    
     BRIEF DESCRIPTION OF THE DRAWINGS 
     FIG. 1 is a flow chart illustrating a portion of the initial operation of PD and PD --  SERVER. 
     FIG. 2 and 2a show the flow of control for a portion of PD and PD --  SERVER. 
     FIG. 3 is a flow chart illustrating a portion of the synchronization of PD and a user file I/O. 
    
    
     DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS 
     Before attempting to copy a file, the PD --  SERVER process is started on every node in the cluster on which the file to be copied is open. In this particular implementation, PD automatically tries to start the server on every node in the cluster before it tries to copy its first file so that it does not suffer the overhead at each file copy. 
     There are a number of ways to start processes on both local and remote nodes as will be readily apparent to one skilled in the art. In this implementation, PD copies the server process code to the disk being optimized and then uses &#34;SYSMAN,&#34; a VMS utility, to start it from a spawned process. 
     As shown in FIG. 1, for example, before starting the PD --  SERVER processes, PD takes out a lock with the name PD --  SERVER --  diskname (where diskname is the name of the disk to be optimized) in PW mode (101). It holds this lock as long as it is working on the disk. When it gives up the lock, it is a signal to the PD --  SERVER processes that PD is no longer interested in the disk and that the PD --  SERVER process should exit. If the node upon which PD is running should crash, then the other nodes are automatically notified because this lock will go away when the node does. Before starting the PD --  SERVER processes, PD also takes out a lock with the name PD --  FID --  diskname in PW mode (102). This lock has several uses as discussed below. For example, this lock is used to signal to the PD --  SERVER processes that a new file is being copied, which file is being worked upon, and completion status (success or failure) of the copy operation. The PD --  SERVER can tell which disk it is being run from and therefore, it knows which disk it is serving. It also makes checks to see that it is the only copy of PD --  SERVER which is serving that disk. If there is already another such process, it just exits. Once the PD --  Server processes are started (103, 104), the PD --  SERVER process queues a lock with the name PD --  SERVER --  diskname in PR mode (105). This lock is incompatible with the PD --  SERVER --  diskname lock held by the PD process. If the lock is ever granted, it is a signal that the PD process is exiting or that the PD process&#39;s node has crashed. If PD --  SERVER is currently assisting with the copying of a file, it also serves as a signal that the copy will not be completed and the final update should not be made. The PD --  SERVER process then takes out a lock with the name PD --  SERVER --  diskname in concurrent write (CW) mode (106). (This lock mode is compatible with other CW mode locks on the resource but not with PW locks. The utility of this will become apparent from the discussion below). The PD --  SERVER process then queues for a PD --  FID --  diskname lock in PR mode (107). The PR mode is compatible with similar locks queued for by the PD --  SERVER processes but not with the PW lock held by PD. PD --  SERVER waits for the lock to be granted (108). 
     Meanwhile, PD identifies a file to be copied and starts a file copy operation at A (FIG. 2) similar to the one described for moving dosed files. In step 201 it takes out the F11B$s lock on the file in EX mode to keep other users from opening, closing, extending, deleting, or truncating the file while it holds the lock. It checks for other users accessing the file anywhere in the cluster. If none are accessing it, then the normal closed file copy procedure may be used. However, if the file is open anywhere on the system, PD checks that PD --  SERVER is holding the PD --  FID --  diskname lock on every node that has the file open. It is not necessary for the PD --  SERVER to be running on nodes that do not have the file open (202). If all such nodes have not successfully started and maintained the PD --  SERVER processes, then the file will not be copied. PD solves the problem(s) of other users opening the file during the copy by not relinquishing the F11B$s lock during the copy. It also avoids the problem(s) of other users closing, extending, truncating, or deleting the file because none of these operations can occur while PD is holding the F11B$s lock. 
     PD then takes out a lock on PD --  ERROR --  diskname lock in PR mode with blocking AST (203). If a PD --  SERVER process queues for a PD --  ERROR --  diskname lock in CW mode, PD will get such a blocking AST. This is a mechanism that is used for the PD --  SERVER processes to notify PD that an error has occurred &#34;remotely&#34; which should cause PD to abort the copy operation without updating the header to point to the new data. 
     PD next determines which part of the file it will move (it doesn&#39;t necessarily have to move the entire file) to what location on the disk and allocates that space (204). When all of this setup is completed, PD notifies the PD --  SERVER processes by writing the file ID (a unique identifier), the starting virtual blocking number (VBN) of the file to be copied, the number of blocks to be copied, and the starting logical blocking that the new portion of the file will occupy into the &#34;value block&#34; of the PD --  FID --  diskname lock and converts the PD --  FID --  diskname lock from the PW to PR mode (205). 
     When PD lowers the PD --  FID --  diskname lock to PR mode, any waiting requests for the PD --  FID --  diskname locks in PR mode in all of the PD --  SERVER processes are granted (206). The PD --  SERVER processes then read the lock&#39;s value blocking to learn the file ID, starting VBN, number of blocks to be copied, and target LBN. At this point, the PD --  SERVER processes are ready to cooperate with PD in the file copy. However, the PD --  SERVER process must stall the PD process from starting the file copy until certain housekeeping functions are taken care of. 
     It must be guaranteed that user processes will read and particularly write to the fight location on the disk while PD is copying a file. While PD is copying a file and before it updates the header, all of the user processes can read the file from its original position. The old data is there the entire time, and furthermore, VMS naturally makes the processes read the fight data under all conditions. So reads are not a particular problem while PD is copying the data to the new location. 
     Writes to the file are, however, a particular problem. It is not sufficient to write any given I/O to just one of the old or new locations of the file. While it might seem that some scheme would allow the data to be written to just one location or the other, depending upon PD&#39;s progress at copying the data, this is not adequate since, for example, PD may fail to complete the copy. (For example, its node might have a power failure, etc.) Therefore, all writes to the file during the PD copy phase are preferably written over the old version of the file. Furthermore, if PD has already copied that area of the file to its new location, the write must also occur at the new location. The solution therefore, is to make all write I/Os write to both locations. Methods for &#34;shadowing&#34; disk I/Os (i.e., making them write in two or more locations), in general, are known to those skilled in the art, but have not been used for this particular purpose. PD --  SERVER can identify and shadow just exactly those I/O since it knows which blocks in which files must be shadowed. 
     However, there remain at least three other problems related to the file copy phase that must be recognized and addressed. First, when PD wants to start copying a file, PD --  SERVER acquires the PD --  FID --  diskname lock as described above and is ready to go. It knows to shadow all future write I/Os to the file until the copy phase is done. However, this alone is inadequate. It is possible that one or more write I/Os to the file were queued before PD wanted to copy the file, but that for one reason or another, have not yet completed. (Though unlikely, in VAXclusters, it is possible that disk I/Os may take minutes or even hours to complete.) Therefore, PD must wait to start its copy until all outstanding write I/Os to the file have completed. 
     Another problem is that even though shadowing the write I/Os to both the old and new copies of the file is occurring, the system still must synchronize the write I/Os. with the PD copy process for at least the following reason. Suppose that during the copy phase, PD reads some block of data from the old location of the file, but before it can write it out to the new location, a user process writes that block of data. Even though the user write is shadowed to the new location, if it is written before PD can write its version of the data to the new location (and that is quite possible), user data will be lost in the new portion of the file. If the file copy is completed by PD, the user data will be lost. Therefore, writes to the disk should preferably be synchronized to prohibit this possibility. 
     Finally, when PD is done copying the file, it must point the file header mapping pointers to the new location of the file, rewrite the file header, and then deallocate the space where the file previously but no longer exists. This space can then be allocated to another file. If PD --  SERVER was shadowing a write I/O to the file and the I/O was somehow delayed (a distinct possibility), when it completed later on, it might incorrectly write old data over another file. The following solutions overcome these potential problems. 
     In order for any user process on any node to be able to write to a file being copied, the PD --  SERVER process must hold the PD --  BLOCK --  diskname lock in CW mode. In order for PD to do a read and then write of any data in the file for its copy operation, it must hold the PD --  BLOCK --  diskname in PW mode. While any PD --  SERVER holds this lock in CW mode, PD cannot hold the lock in PW mode. So PD is preferably programmed so that it will not do the copy unless it holds the PD --  BLOCK diskname lock in PW mode and the PD --  SERVER processes are preferably programmed to stall all write I/Os (302) until it holds the PD --  BLOCK --  diskname lock in CW mode. (Acquiring and releasing the locks is standard VMS lock work for those skilled in the art.) This solves the problem of users writing data during PD copy read-then-write copy operations. As shown in FIG. 3, for example, this may be implemented as follows. 
     To write to a file being copied, PD --  SERVER determines whether it is currently holding PD --  BLOCK --  diskname lock in CW mode (301). If not, it holds the I/O and queues and waits for PD --  BLOCK --  diskname lock in CW mode (302). When this occurs, it sends the I/O request to the driver to write to the old location (303). When complete, it requeues the driver to write to the new location (304). Upon completion of the second queuing (305), it determines whether there is a blocking AST on PD --  BLOCK --  diskname lock (306). If yes, it drops the PD --  BLOCK --  diskname lock and waits for a next event (307). If not, it is done and waits for the next I/O or PD done with file or blocking AST signal (308). 
     Meanwhile, PD determines whether it holds PD --  BLOCK --  diskname lock (309). If not, it queues and waits for PD --  BLOCK --  diskname lock in PW mode (310). If yes, it reads the next segment of data from the file (311), writes data to the new file location (312) and determines whether there is a blocking AST on PD --  BLOCK --  diskname lock (313). If yes, PD drops the PD --  BLOCK --  diskname lock (314) and control returns to 310. If not, control passes to 311. 
     To make sure that there are no latent I/Os at the start or finish which would cause other problems (for example, as described above), the PD --  SERVER process stalls operations as follows. As described above, at the start of a file copy operation, PD --  SERVER acquires the PD --  FID --  diskname lock which tells it which file is to be moved (206), but it is already holding the PD --  BLOCK --  diskname lock in CW mode (106) so that PD cannot actually start the data transfer. PD --  SERVER then watches all of the new diskname I/Os that are queued to the diskname device from the local node. It passes all of the I/O requests onto the driver except for the I/Os to the file being copied (208), which it holds in a temporary queue. It then compares the number of requests in its temporary queue with the VMS device driver field (UCB$W --  QLEN) which contains the number of outstanding I/Os on the device. When the two numbers are equal, then there are no previously queued I/Os to the file still outstanding. This allows the diskname to service all other I/Os and still stall the key ones as long as necessary. When all of the outstanding I/Os for the file have been &#34;collected&#34; in the temporary queue, synchronization has been accomplished and they are just requeued to the driver in the standard VMS way. If PD is just starting to process a new file, then when they are reprocessed by the driver, PD --  SERVER will intercept them and shadow the writes properly. If PD is finishing a file, PD --  SERVER will have done its cleanup. and will cause only the second half of the shadowing to occur. That is, the part in which the new location of the file is written. 
     Referring to the flow of a file copy, once PD --  SERVER has performed the above described stall operations, it waits for the outstanding write I/Os to complete (208). PD --  SERVER then drops the PD --  BLOCK --  diskname CW lock (209). When all of the servers have done so, PD&#39;s request for the PD --  BLOCK --  diskname PW lock will be granted (207) and PD can copy file data (211). PD will hold the lock through each individual sequence of reading and write each portion of the file. (A large file may require many reads and writes.) At the end of each individual read/write, PD will check to see if any PD --  SERVER has requested the PD --  BLOCK --  diskname. If so, PD will drop the lock, which will allow other users to write the file as described, and then will requeue for it. When the other write(s) have completed, the PD --  SERVER process(es) will drop the PD --  BLOCK --  diskname lock(s) and PD will reacquire the PD --  BLOCK --  diskname PW lock and then can continue its read/write operations. 
     From the PD --  SERVER viewpoint, PD --  SERVER is watching all of the diskname I/O requests. If it encounters a write I/O to the file being copied, rather than sending the request on to the driver, it stalls the request until the PD --  SERVER --  diskname lock is acquired in CW mode. When it gets the lock, it then sends the request to the driver to write to the original location. When the original request is completed, it then shadows the I/O to the new location. Only then does PD --  SERVER drop the PD --  BLOCK --  diskname lock so that PD can start another read/write operation. If PD --  SERVER detects an error in either of the writes, then PD --  SERVER takes out a lock with the name PD --  ERROR --  diskname in CW mode (220). This is incompatible with PD&#39;s PR lock on the resource, so a blocking AST is generated in PD which informs PD that there is an error somewhere and that PD should not finish moving the file and control passes to 225. 
     Otherwise, PD finishes copying the data portion of the file. Up to this point, there is no problem if any of the systems in the cluster should crash. If the system running PD crashes, then its PD --  SERVER --  diskname PW lock is released, all of the remaining PD --  SERVER process acquire their locks and know to exit without finishing a file update. The original file and data structures are just as before the start of the copy. If any of the remote nodes running PD --  SERVER crash, there is no problem because they will not be doing any I/O to the file and will not be able to do so until the copy is completely finished. 
     Then, PD (while holding the PD --  BLOCK --  diskname lock in PW mode) rewrites the file header pointing to the new location of the data (221). Once again, if any of the remote nodes crash, there is no problem because the new file will exist properly when the system is rebooted. If the node running PD crashes, the signalling scheme still works. The PD --  SERVER processes will acquire the PD --  SERVER --  diskname lock and know that there was a failure. PD --  SERVER will mark the file&#39;s FCB and WCBs stale so that the file system will reread the file header (PD may or may not have updated it.) Any pre-existing write I/Os will be shadowed to both the old and new locations. Since the PD process had not yet deallocated the old file space, it is safe to write to both places. New I/Os will write to the proper place. 
     After writing the header (221), PD drops the PD --  BLOCK --  diskname lock so that outstanding I/Os are allowed to proceed by PD --  SERVER. PD queues to convert its PD --  FID --  diskname to PW mode if the copy was a success (222) (or to EX mode if the header was not updated (226)). Meanwhile, the PD --  SERVER processes, which are holding the lock in PR mode, receive a blocking AST which informs them the PD is done copying the file (210). Then PD --  SERVER checks the lock mode of the PD request to determine success or failure, but it matters little. In either case, PD --  SERVER marks the FCB and WCBs &#34;stale&#34; (228) so that the file system must reread the file header so that new I/O requests will read/write the file in its new location. PD --  SERVER does its &#34;stall&#34; operation so that outstanding I/Os (possibly shadowed) can complete. Upon completion of all outstanding I/Os, PD --  SERVER drops the PD --  FID --  diskname lock to signify to PD that it has done all its cleanup (229). PD --  SERVER requeues for the PD --  FID --  diskname lock (230) so that it will be ready for the next file to be copied by PD (231). 
     When all the PD --  SERVERs have dropped their PD --  FID --  diskname locks (229), PD acquires the lock in PW mode (232) and knows that the PD --  SERVER cleanup is complete. At this point, PD deallocates the diskname space where the old file no longer resides, and finally, PD drops the F11B$s lock (233) so that other users may open, close, extend, truncate, or delete the file in the normal manner. This completes the file copy operation and PD finds the next file to process (234). 
     The foregoing is a description of the preferred embodiments of the present invention. However, various modifications within the scope of the invention will be readily apparent to those skilled in the art. The invention is only limited by the claims appended hereto.