1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
|
package queue
import (
"bytes"
"errors"
"fmt"
"sync"
"sync/atomic"
"github.com/valinurovam/garagemq/amqp"
"github.com/valinurovam/garagemq/config"
"github.com/valinurovam/garagemq/interfaces"
"github.com/valinurovam/garagemq/metrics"
"github.com/valinurovam/garagemq/qos"
"github.com/valinurovam/garagemq/safequeue"
)
// MetricsState represents current metrics states for queue
type MetricsState struct {
Ready *metrics.TrackCounter
Unacked *metrics.TrackCounter
Total *metrics.TrackCounter
Incoming *metrics.TrackCounter
Deliver *metrics.TrackCounter
Get *metrics.TrackCounter
Ack *metrics.TrackCounter
ServerReady *metrics.TrackCounter
ServerUnacked *metrics.TrackCounter
ServerTotal *metrics.TrackCounter
ServerDeliver *metrics.TrackCounter
ServerAck *metrics.TrackCounter
}
// Queue is an implementation of the AMQP-queue entity
type Queue struct {
safequeue.SafeQueue
name string
connID uint64
exclusive bool
autoDelete bool
durable bool
cmrLock sync.RWMutex
consumers []interfaces.Consumer
consumeExcl bool
call chan struct{}
wasConsumed bool
shardSize int
actLock sync.RWMutex
active bool
// persistent storage
msgPStorage interfaces.MsgStorage
// transient storage
msgTStorage interfaces.MsgStorage
currentConsumer int
metrics *MetricsState
autoDeleteQueue chan string
queueLength int64
// lock for sync load swapped-messages from disk
loadSwapLock sync.Mutex
maxMessagesInRAM uint64
lastStoredMsgID uint64
lastMemMsgID uint64
swappedToDisk bool
maybeLoadFromStorageCh chan struct{}
wg *sync.WaitGroup
}
// NewQueue returns new instance of Queue
func NewQueue(name string, connID uint64, exclusive bool, autoDelete bool, durable bool, config config.Queue, msgStorageP interfaces.MsgStorage, msgStorageT interfaces.MsgStorage, autoDeleteQueue chan string) *Queue {
return &Queue{
SafeQueue: *safequeue.NewSafeQueue(config.ShardSize),
name: name,
connID: connID,
exclusive: exclusive,
autoDelete: autoDelete,
durable: durable,
call: make(chan struct{}, 1),
maybeLoadFromStorageCh: make(chan struct{}, 1),
wasConsumed: false,
active: false,
shardSize: config.ShardSize,
maxMessagesInRAM: config.MaxMessagesInRAM,
msgPStorage: msgStorageP,
msgTStorage: msgStorageT,
currentConsumer: 0,
autoDeleteQueue: autoDeleteQueue,
swappedToDisk: false,
wg: &sync.WaitGroup{},
metrics: &MetricsState{
Ready: metrics.NewTrackCounter(0, true),
Unacked: metrics.NewTrackCounter(0, true),
Total: metrics.NewTrackCounter(0, true),
Incoming: metrics.NewTrackCounter(0, true),
Deliver: metrics.NewTrackCounter(0, true),
Get: metrics.NewTrackCounter(0, true),
Ack: metrics.NewTrackCounter(0, true),
ServerReady: metrics.NewTrackCounter(0, true),
ServerUnacked: metrics.NewTrackCounter(0, true),
ServerTotal: metrics.NewTrackCounter(0, true),
ServerDeliver: metrics.NewTrackCounter(0, true),
ServerAck: metrics.NewTrackCounter(0, true),
},
}
}
// Start starts base queue loop to send events to consumers
// Current consumer to handle message from queue selected by round robin
func (queue *Queue) Start() error {
queue.actLock.Lock()
defer queue.actLock.Unlock()
if queue.active {
return nil
}
queue.active = true
queue.wg.Add(1)
go func() {
defer queue.wg.Done()
for range queue.call {
func() {
queue.cmrLock.RLock()
defer queue.cmrLock.RUnlock()
cmrCount := len(queue.consumers)
for i := 0; i < cmrCount; i++ {
if !queue.active {
return
}
queue.currentConsumer = (queue.currentConsumer + 1) % cmrCount
cmr := queue.consumers[queue.currentConsumer]
if cmr.Consume() {
return
}
}
}()
}
}()
queue.wg.Add(1)
go func() {
defer queue.wg.Done()
for range queue.maybeLoadFromStorageCh {
queue.mayBeLoadFromStorage()
}
}()
return nil
}
// Stop stops main queue loop
// After stop no one can send or receive messages from queue
func (queue *Queue) Stop() error {
queue.actLock.Lock()
defer queue.actLock.Unlock()
queue.active = false
close(queue.maybeLoadFromStorageCh)
close(queue.call)
queue.wg.Wait()
return nil
}
// GetName returns queue name
func (queue *Queue) GetName() string {
return queue.name
}
// Push append message into queue tail and put it into message storage
// if queue is durable and message's persistent flag is true
func (queue *Queue) Push(message *amqp.Message) {
queue.actLock.Lock()
defer queue.actLock.Unlock()
if !queue.active {
return
}
atomic.AddInt64(&queue.queueLength, 1)
queue.metrics.ServerTotal.Counter.Inc(1)
queue.metrics.ServerReady.Counter.Inc(1)
queue.metrics.Total.Counter.Inc(1)
queue.metrics.Ready.Counter.Inc(1)
message.GenerateSeq()
persisted := false
if queue.durable && message.IsPersistent() {
queue.msgPStorage.Add(message, queue.name)
persisted = true
} else {
if queue.SafeQueue.Length() > queue.maxMessagesInRAM || queue.swappedToDisk {
queue.msgTStorage.Add(message, queue.name)
persisted = true
}
if message.ConfirmMeta != nil {
message.ConfirmMeta.ActualConfirms++
}
}
if persisted && !queue.swappedToDisk && queue.SafeQueue.Length() > queue.maxMessagesInRAM {
queue.swappedToDisk = true
queue.lastStoredMsgID = message.ID
}
queue.metrics.Incoming.Counter.Inc(1)
if queue.SafeQueue.Length() <= queue.maxMessagesInRAM && !queue.swappedToDisk {
queue.SafeQueue.Push(message)
queue.lastMemMsgID = message.ID
}
queue.callConsumers()
}
// Pop returns message from queue head without QOS check
func (queue *Queue) Pop() *amqp.Message {
return queue.PopQos([]*qos.AmqpQos{})
}
// PopQos returns message from queue head with QOS check
func (queue *Queue) PopQos(qosList []*qos.AmqpQos) *amqp.Message {
queue.actLock.RLock()
if !queue.active {
queue.actLock.RUnlock()
return nil
}
queue.actLock.RUnlock()
select {
case queue.maybeLoadFromStorageCh <- struct{}{}:
default:
}
queue.SafeQueue.Lock()
var message *amqp.Message
if message = queue.SafeQueue.HeadItem(); message != nil {
allowed := true
for _, q := range qosList {
if !q.IsActive() {
continue
}
if !q.Inc(1, uint32(message.BodySize)) {
allowed = false
break
}
}
if allowed {
queue.SafeQueue.DirtyPop()
atomic.AddInt64(&queue.queueLength, -1)
} else {
message = nil
}
}
queue.SafeQueue.Unlock()
return message
}
func (queue *Queue) mayBeLoadFromStorage() {
swappedToPersistent := true
swappedToTransient := true
currentLength := queue.SafeQueue.Length()
needle := queue.maxMessagesInRAM - currentLength
if currentLength >= queue.maxMessagesInRAM/2 || needle <= 0 || !queue.swappedToDisk {
return
}
pMessages := make([]*amqp.Message, 0, needle)
tMessages := make([]*amqp.Message, 0, needle)
var lastIteratedMsgID uint64
lastMemMsgID := queue.lastMemMsgID
var wg sync.WaitGroup
// 2 - search for transient and persistent
wg.Add(2)
go func() {
if currentLength < queue.maxMessagesInRAM/2 && queue.swappedToDisk {
iterated := queue.msgPStorage.IterateByQueueFromMsgID(queue.name, queue.lastStoredMsgID, needle, func(message *amqp.Message) {
lastIteratedMsgID = message.ID
pMessages = append(pMessages, message)
})
if iterated == 0 || lastMemMsgID == lastIteratedMsgID {
swappedToPersistent = false
}
}
wg.Done()
}()
go func() {
if currentLength < queue.maxMessagesInRAM/2 && queue.swappedToDisk {
iterated := queue.msgTStorage.IterateByQueueFromMsgID(queue.name, queue.lastStoredMsgID, needle, func(message *amqp.Message) {
lastIteratedMsgID = message.ID
tMessages = append(tMessages, message)
})
if iterated == 0 || lastMemMsgID == lastIteratedMsgID {
swappedToTransient = false
}
}
wg.Done()
}()
wg.Wait()
sortedMessages := queue.mergeSortedMessageSlices(pMessages, tMessages)
sortedMessageslength := uint64(len(sortedMessages))
var pos uint64
if sortedMessageslength <= needle {
pos = sortedMessageslength
} else {
pos = needle
}
for _, message := range sortedMessages[0:pos] {
if message.ID == lastMemMsgID {
continue
}
queue.SafeQueue.Push(message)
queue.lastMemMsgID = message.ID
queue.lastStoredMsgID = message.ID
queue.callConsumers()
}
queue.swappedToDisk = swappedToPersistent || swappedToTransient
}
func (queue *Queue) mergeSortedMessageSlices(A, B []*amqp.Message) []*amqp.Message {
result := make([]*amqp.Message, len(A)+len(B))
idxA, idxB := 0, 0
for i := 0; i < len(result); i++ {
if idxA >= len(A) {
result[i] = B[idxB]
idxB++
continue
} else if idxB >= len(B) {
result[i] = A[idxA]
idxA++
continue
}
if A[idxA].ID < B[idxB].ID {
result[i] = A[idxA]
idxA++
} else {
result[i] = B[idxB]
idxB++
}
}
return result
}
// LoadFromMsgStorage loads messages into queue from msgstorage
func (queue *Queue) LoadFromMsgStorage() {
iterated := queue.msgPStorage.IterateByQueueFromMsgID(queue.name, 0, queue.maxMessagesInRAM, func(message *amqp.Message) {
queue.SafeQueue.Push(message)
queue.lastStoredMsgID = message.ID
queue.lastMemMsgID = message.ID
})
if queue.SafeQueue.Length() >= queue.maxMessagesInRAM {
queue.swappedToDisk = true
}
if iterated >= queue.maxMessagesInRAM {
queue.queueLength = int64(queue.msgPStorage.GetQueueLength(queue.name))
} else {
queue.queueLength = int64(iterated)
}
queue.metrics.ServerTotal.Counter.Inc(queue.queueLength)
queue.metrics.ServerReady.Counter.Inc(queue.queueLength)
queue.metrics.Total.Counter.Inc(queue.queueLength)
queue.metrics.Ready.Counter.Inc(queue.queueLength)
}
// AckMsg accept ack event for message
func (queue *Queue) AckMsg(message *amqp.Message) {
queue.actLock.RLock()
if !queue.active {
queue.actLock.RUnlock()
return
}
queue.actLock.RUnlock()
if queue.durable && message.IsPersistent() {
// TODO handle error
queue.msgPStorage.Del(message, queue.name)
}
queue.metrics.Ack.Counter.Inc(1)
queue.metrics.Total.Counter.Dec(1)
queue.metrics.ServerAck.Counter.Inc(1)
queue.metrics.ServerTotal.Counter.Dec(1)
queue.metrics.Unacked.Counter.Dec(1)
queue.metrics.ServerUnacked.Counter.Dec(1)
}
// Requeue add message into queue head
func (queue *Queue) Requeue(message *amqp.Message) {
queue.actLock.RLock()
if !queue.active {
queue.actLock.RUnlock()
return
}
queue.actLock.RUnlock()
message.DeliveryCount++
queue.SafeQueue.PushHead(message)
if queue.durable && message.IsPersistent() {
// TODO handle error
queue.msgPStorage.Update(message, queue.name)
}
queue.metrics.Ready.Counter.Inc(1)
queue.metrics.ServerReady.Counter.Inc(1)
queue.metrics.Unacked.Counter.Dec(1)
queue.metrics.ServerUnacked.Counter.Dec(1)
atomic.AddInt64(&queue.queueLength, 1)
queue.callConsumers()
}
// Purge clean queue and message storage for durable queues
func (queue *Queue) Purge() (length uint64) {
queue.SafeQueue.Lock()
defer queue.SafeQueue.Unlock()
length = uint64(atomic.LoadInt64(&queue.queueLength))
queue.SafeQueue.DirtyPurge()
if queue.durable {
queue.msgPStorage.PurgeQueue(queue.name)
}
queue.metrics.Total.Counter.Dec(int64(length))
queue.metrics.Ready.Counter.Dec(int64(length))
queue.metrics.ServerTotal.Counter.Dec(int64(length))
queue.metrics.ServerReady.Counter.Dec(int64(length))
atomic.StoreInt64(&queue.queueLength, 0)
return
}
// Delete cancel consumers and delete its messages from storage
func (queue *Queue) Delete(ifUnused bool, ifEmpty bool) (uint64, error) {
queue.actLock.Lock()
queue.cmrLock.Lock()
queue.SafeQueue.Lock()
defer queue.actLock.Unlock()
defer queue.cmrLock.Unlock()
defer queue.SafeQueue.Unlock()
queue.active = false
if ifUnused && len(queue.consumers) != 0 {
return 0, errors.New("queue has consumers")
}
if ifEmpty && queue.SafeQueue.DirtyLength() != 0 {
return 0, errors.New("queue has messages")
}
queue.cancelConsumers()
length := uint64(atomic.LoadInt64(&queue.queueLength))
if queue.durable {
queue.msgPStorage.PurgeQueue(queue.name)
}
queue.metrics.Total.Counter.Dec(int64(length))
queue.metrics.Ready.Counter.Dec(int64(length))
queue.metrics.ServerTotal.Counter.Dec(int64(length))
queue.metrics.ServerReady.Counter.Dec(int64(length))
return length, nil
}
// AddConsumer add consumer to consumer messages with exclusive check
func (queue *Queue) AddConsumer(consumer interfaces.Consumer, exclusive bool) error {
queue.cmrLock.Lock()
defer queue.cmrLock.Unlock()
if !queue.active {
return fmt.Errorf("queue is not active")
}
queue.wasConsumed = true
if len(queue.consumers) != 0 && (queue.consumeExcl || exclusive) {
return fmt.Errorf("queue is busy by %d consumers", len(queue.consumers))
}
if exclusive {
queue.consumeExcl = true
}
queue.consumers = append(queue.consumers, consumer)
queue.callConsumers()
return nil
}
// RemoveConsumer remove consumer
// If it was last consumer and queue is auto-delete - queue will be removed
func (queue *Queue) RemoveConsumer(cTag string) {
queue.cmrLock.Lock()
defer queue.cmrLock.Unlock()
for i, cmr := range queue.consumers {
if cmr.Tag() == cTag {
queue.consumers = append(queue.consumers[:i], queue.consumers[i+1:]...)
break
}
}
cmrCount := len(queue.consumers)
if cmrCount == 0 {
queue.currentConsumer = 0
queue.consumeExcl = false
} else {
queue.currentConsumer = (queue.currentConsumer + 1) % cmrCount
}
if cmrCount == 0 && queue.wasConsumed && queue.autoDelete {
queue.autoDeleteQueue <- queue.name
}
}
// Send event to call next consumer, that it can receive next message
func (queue *Queue) callConsumers() {
if !queue.active {
return
}
select {
case queue.call <- struct{}{}:
default:
}
}
func (queue *Queue) cancelConsumers() {
for _, cmr := range queue.consumers {
cmr.Cancel()
}
}
// Length returns queue length
func (queue *Queue) Length() uint64 {
return uint64(atomic.LoadInt64(&queue.queueLength))
}
// ConsumersCount returns consumers count
func (queue *Queue) ConsumersCount() int {
queue.cmrLock.RLock()
defer queue.cmrLock.RUnlock()
return len(queue.consumers)
}
// EqualWithErr returns is given queue equal to current
func (queue *Queue) EqualWithErr(qB *Queue) error {
errTemplate := "inequivalent arg '%s' for queue '%s': received '%t' but current is '%t'"
if queue.durable != qB.IsDurable() {
return fmt.Errorf(errTemplate, "durable", queue.name, qB.IsDurable(), queue.durable)
}
if queue.autoDelete != qB.autoDelete {
return fmt.Errorf(errTemplate, "autoDelete", queue.name, qB.autoDelete, queue.autoDelete)
}
if queue.exclusive != qB.IsExclusive() {
return fmt.Errorf(errTemplate, "exclusive", queue.name, qB.IsExclusive(), queue.exclusive)
}
return nil
}
// Marshal returns raw representation of queue to store into storage
func (queue *Queue) Marshal(protoVersion string) (data []byte, err error) {
buf := bytes.NewBuffer(make([]byte, 0))
if err = amqp.WriteShortstr(buf, queue.name); err != nil {
return nil, err
}
var autoDelete byte
if queue.autoDelete {
autoDelete = 1
} else {
autoDelete = 0
}
if err = amqp.WriteOctet(buf, autoDelete); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
// Unmarshal returns queue from storage raw bytes data
func (queue *Queue) Unmarshal(data []byte, protoVersion string) (err error) {
buf := bytes.NewReader(data)
if queue.name, err = amqp.ReadShortstr(buf); err != nil {
return err
}
var autoDelete byte
if autoDelete, err = amqp.ReadOctet(buf); err != nil {
return err
}
queue.autoDelete = autoDelete > 0
queue.durable = true
return
}
// IsDurable returns is queue durable
func (queue *Queue) IsDurable() bool {
return queue.durable
}
// IsExclusive returns is queue exclusive
func (queue *Queue) IsExclusive() bool {
return queue.exclusive
}
// IsAutoDelete returns is queue should be deleted automatically
func (queue *Queue) IsAutoDelete() bool {
return queue.autoDelete
}
// ConnID returns ID of connection that create this queue
func (queue *Queue) ConnID() uint64 {
return queue.connID
}
// IsActive returns is queue's main loop is active
func (queue *Queue) IsActive() bool {
return queue.active
}
// SetMetrics set external metrics
func (queue *Queue) SetMetrics(m *MetricsState) {
queue.metrics = m
}
// GetMetrics returns metrics
func (queue *Queue) GetMetrics() *MetricsState {
return queue.metrics
}
|