services/keepstore/work_queue.go

   1 package main
   2
   3 /* A WorkQueue is an asynchronous thread-safe queue manager.  It
   4    provides a channel from which items can be read off the queue, and
   5    permits replacing the contents of the queue at any time.
   6
   7    The overall work flow for a WorkQueue is as follows:
   8
   9      1. A WorkQueue is created with NewWorkQueue().  This
  10         function instantiates a new WorkQueue and starts a manager
  11         goroutine.  The manager listens on an input channel
  12         (manager.newlist) and an output channel (manager.NextItem).
  13
  14      2. The manager first waits for a new list of requests on the
  15         newlist channel.  When another goroutine calls
  16         manager.ReplaceQueue(lst), it sends lst over the newlist
  17         channel to the manager.  The manager goroutine now has
  18         ownership of the list.
  19
  20      3. Once the manager has this initial list, it listens on both the
  21         input and output channels for one of the following to happen:
  22
  23           a. A worker attempts to read an item from the NextItem
  24              channel.  The manager sends the next item from the list
  25              over this channel to the worker, and loops.
  26
  27           b. New data is sent to the manager on the newlist channel.
  28              This happens when another goroutine calls
  29              manager.ReplaceItem() with a new list.  The manager
  30              discards the current list, replaces it with the new one,
  31              and begins looping again.
  32
  33           c. The input channel is closed.  The manager closes its
  34              output channel (signalling any workers to quit) and
  35              terminates.
  36
  37    Tasks currently handled by WorkQueue:
  38      * the pull list
  39      * the trash list
  40
  41    Example usage:
  42
  43         // Any kind of user-defined type can be used with the
  44         // WorkQueue.
  45                 type FrobRequest struct {
  46                         frob string
  47                 }
  48
  49                 // Make a work list.
  50                 froblist := NewWorkQueue()
  51
  52                 // Start a concurrent worker to read items from the NextItem
  53                 // channel until it is closed, deleting each one.
  54                 go func(list WorkQueue) {
  55                         for i := range list.NextItem {
  56                                 req := i.(FrobRequest)
  57                                 frob.Run(req)
  58                         }
  59                 }(froblist)
  60
  61                 // Set up a HTTP handler for PUT /frob
  62                 router.HandleFunc(`/frob`,
  63                         func(w http.ResponseWriter, req *http.Request) {
  64                                 // Parse the request body into a list.List
  65                                 // of FrobRequests, and give this list to the
  66                                 // frob manager.
  67                                 newfrobs := parseBody(req.Body)
  68                                 froblist.ReplaceQueue(newfrobs)
  69                         }).Methods("PUT")
  70
  71    Methods available on a WorkQueue:
  72
  73                 ReplaceQueue(list)
  74                         Replaces the current item list with a new one.  The list
  75             manager discards any unprocessed items on the existing
  76             list and replaces it with the new one. If the worker is
  77             processing a list item when ReplaceQueue is called, it
  78             finishes processing before receiving items from the new
  79             list.
  80                 Close()
  81                         Shuts down the manager goroutine. When Close is called,
  82                         the manager closes the NextItem channel.
  83 */
  84
  85 import "container/list"
  86
  87 type WorkQueue struct {
  88         getStatus chan WorkQueueStatus
  89         newlist   chan *list.List
  90         // Workers get work items by reading from this channel.
  91         NextItem <-chan interface{}
  92         // Each worker must send struct{}{} to DoneItem exactly once
  93         // for each work item received from NextItem, when it stops
  94         // working on that item (regardless of whether the work was
  95         // successful).
  96         DoneItem chan<- struct{}
  97 }
  98
  99 type WorkQueueStatus struct {
 100         InProgress int
 101         Queued     int
 102 }
 103
 104 // NewWorkQueue returns a new empty WorkQueue.
 105 //
 106 func NewWorkQueue() *WorkQueue {
 107         nextItem := make(chan interface{})
 108         reportDone := make(chan struct{})
 109         newList := make(chan *list.List)
 110         b := WorkQueue{
 111                 getStatus: make(chan WorkQueueStatus),
 112                 newlist:   newList,
 113                 NextItem:  nextItem,
 114                 DoneItem:  reportDone,
 115         }
 116         go func() {
 117                 // Read new work lists from the newlist channel.
 118                 // Reply to "status" and "get next item" queries by
 119                 // sending to the getStatus and nextItem channels
 120                 // respectively. Return when the newlist channel
 121                 // closes.
 122
 123                 todo := &list.List{}
 124                 status := WorkQueueStatus{}
 125
 126                 // When we're done, close the output channel; workers will
 127                 // shut down next time they ask for new work.
 128                 defer close(nextItem)
 129                 defer close(b.getStatus)
 130
 131                 // nextChan and nextVal are both nil when we have
 132                 // nothing to send; otherwise they are, respectively,
 133                 // the nextItem channel and the next work item to send
 134                 // to it.
 135                 var nextChan chan interface{}
 136                 var nextVal interface{}
 137
 138                 for newList != nil || status.InProgress > 0 {
 139                         select {
 140                         case p, ok := <-newList:
 141                                 if !ok {
 142                                         // Closed, stop receiving
 143                                         newList = nil
 144                                 }
 145                                 todo = p
 146                                 if todo == nil {
 147                                         todo = &list.List{}
 148                                 }
 149                                 status.Queued = todo.Len()
 150                                 if status.Queued == 0 {
 151                                         // Stop sending work
 152                                         nextChan = nil
 153                                         nextVal = nil
 154                                 } else {
 155                                         nextChan = nextItem
 156                                         nextVal = todo.Front().Value
 157                                 }
 158                         case nextChan <- nextVal:
 159                                 todo.Remove(todo.Front())
 160                                 status.InProgress++
 161                                 status.Queued--
 162                                 if status.Queued == 0 {
 163                                         // Stop sending work
 164                                         nextChan = nil
 165                                         nextVal = nil
 166                                 } else {
 167                                         nextVal = todo.Front().Value
 168                                 }
 169                         case <-reportDone:
 170                                 status.InProgress--
 171                         case b.getStatus <- status:
 172                         }
 173                 }
 174         }()
 175         return &b
 176 }
 177
 178 // ReplaceQueue abandons any work items left in the existing queue,
 179 // and starts giving workers items from the given list. After giving
 180 // it to ReplaceQueue, the caller must not read or write the given
 181 // list.
 182 //
 183 func (b *WorkQueue) ReplaceQueue(list *list.List) {
 184         b.newlist <- list
 185 }
 186
 187 // Close shuts down the manager and terminates the goroutine, which
 188 // abandons any pending requests, but allows any pull request already
 189 // in progress to continue.
 190 //
 191 // After Close, Status will return correct values, NextItem will be
 192 // closed, and ReplaceQueue will panic.
 193 //
 194 func (b *WorkQueue) Close() {
 195         close(b.newlist)
 196 }
 197
 198 // Status returns an up-to-date WorkQueueStatus reflecting the current
 199 // queue status.
 200 //
 201 func (b *WorkQueue) Status() WorkQueueStatus {
 202         // If the channel is closed, we get the nil value of
 203         // WorkQueueStatus, which is an accurate description of a
 204         // finished queue.
 205         return <-b.getStatus
 206 }