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 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
|
package operations
import (
"context"
"errors"
"fmt"
"maps"
"net/http"
"sync"
"time"
"github.com/google/uuid"
"github.com/lxc/incus/v6/internal/server/auth"
"github.com/lxc/incus/v6/internal/server/db/operationtype"
"github.com/lxc/incus/v6/internal/server/events"
"github.com/lxc/incus/v6/internal/server/request"
"github.com/lxc/incus/v6/internal/server/response"
"github.com/lxc/incus/v6/internal/server/state"
"github.com/lxc/incus/v6/internal/version"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/cancel"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/util"
)
var debug bool
var (
operationsLock sync.Mutex
operations = make(map[string]*Operation)
)
// OperationClass represents the OperationClass type.
type OperationClass int
const (
// OperationClassTask represents the Task OperationClass.
OperationClassTask OperationClass = 1
// OperationClassWebsocket represents the Websocket OperationClass.
OperationClassWebsocket OperationClass = 2
// OperationClassToken represents the Token OperationClass.
OperationClassToken OperationClass = 3
)
func (t OperationClass) String() string {
return map[OperationClass]string{
OperationClassTask: api.OperationClassTask,
OperationClassWebsocket: api.OperationClassWebsocket,
OperationClassToken: api.OperationClassToken,
}[t]
}
// Init sets the debug value for the operations package.
func Init(d bool) {
debug = d
}
// Lock locks the operations mutex.
func Lock() {
operationsLock.Lock()
}
// Unlock unlocks the operations mutex.
func Unlock() {
operationsLock.Unlock()
}
// Clone returns a clone of the internal operations map containing references to the actual operations.
func Clone() map[string]*Operation {
operationsLock.Lock()
defer operationsLock.Unlock()
return util.CloneMap(operations)
}
// OperationGetInternal returns the operation with the given id. It returns an
// error if it doesn't exist.
func OperationGetInternal(id string) (*Operation, error) {
operationsLock.Lock()
op, ok := operations[id]
operationsLock.Unlock()
if !ok {
return nil, fmt.Errorf("Operation '%s' doesn't exist", id)
}
return op, nil
}
// Operation represents an operation.
type Operation struct {
projectName string
id string
class OperationClass
createdAt time.Time
updatedAt time.Time
status api.StatusCode
url string
resources map[string][]api.URL
metadata map[string]any
err error
readonly bool
canceler *cancel.HTTPRequestCanceller
description string
objectType auth.ObjectType
entitlement auth.Entitlement
dbOpType operationtype.Type
requestor *api.EventLifecycleRequestor
logger logger.Logger
// Those functions are called at various points in the Operation lifecycle
onRun func(*Operation) error
onCancel func(*Operation) error
onConnect func(*Operation, *http.Request, http.ResponseWriter) error
// Indicates if operation has finished.
finished *cancel.Canceller
// Locking for concurrent access to the Operation
lock sync.Mutex
state *state.State
events *events.Server
}
// OperationCreate creates a new operation and returns it. If it cannot be
// created, it returns an error.
func OperationCreate(s *state.State, projectName string, opClass OperationClass, opType operationtype.Type, opResources map[string][]api.URL, opMetadata any, onRun func(*Operation) error, onCancel func(*Operation) error, onConnect func(*Operation, *http.Request, http.ResponseWriter) error, r *http.Request) (*Operation, error) {
// Don't allow new operations when Incus is shutting down.
if s != nil && errors.Is(s.ShutdownCtx.Err(), context.Canceled) {
return nil, errors.New("Incus is shutting down")
}
// Main attributes
op := Operation{}
op.projectName = projectName
op.id = uuid.New().String()
op.description = opType.Description()
op.objectType, op.entitlement = opType.Permission()
op.dbOpType = opType
op.class = opClass
op.createdAt = time.Now()
op.updatedAt = op.createdAt
op.status = api.Pending
op.url = fmt.Sprintf("/%s/operations/%s", version.APIVersion, op.id)
op.resources = opResources
op.finished = cancel.New(context.Background())
op.state = s
op.logger = logger.AddContext(logger.Ctx{"operation": op.id, "project": op.projectName, "class": op.class.String(), "description": op.description})
if s != nil {
op.SetEventServer(s.Events)
}
newMetadata, err := parseMetadata(opMetadata)
if err != nil {
return nil, err
}
op.metadata = newMetadata
// Callback functions
op.onRun = onRun
op.onCancel = onCancel
op.onConnect = onConnect
// Quick check.
if op.class != OperationClassWebsocket && op.onConnect != nil {
return nil, errors.New("Only websocket operations can have a Connect hook")
}
if op.class == OperationClassWebsocket && op.onConnect == nil {
return nil, errors.New("Websocket operations must have a Connect hook")
}
if op.class == OperationClassToken && op.onRun != nil {
return nil, errors.New("Token operations can't have a Run hook")
}
if op.class == OperationClassToken && op.onCancel != nil {
return nil, errors.New("Token operations can't have a Cancel hook")
}
// Set requestor if request was provided.
if r != nil {
op.SetRequestor(r)
}
operationsLock.Lock()
operations[op.id] = &op
operationsLock.Unlock()
err = registerDBOperation(&op, opType)
if err != nil {
return nil, err
}
op.logger.Debug("New operation")
_, md, _ := op.Render()
operationsLock.Lock()
op.sendEvent(md)
operationsLock.Unlock()
return &op, nil
}
// SetEventServer allows injection of event server.
func (op *Operation) SetEventServer(events *events.Server) {
op.events = events
}
// SetRequestor sets a requestor for this operation from an http.Request.
func (op *Operation) SetRequestor(r *http.Request) {
op.requestor = request.CreateRequestor(r)
}
// IsSameRequestor compares the current request requestor to that stored (if any).
func (op *Operation) IsSameRequestor(r *http.Request) bool {
// If no requestor was previously recorded, it's not the same requestor.
if op.requestor == nil {
return false
}
// Compare with the recorded requestor.
curRequestor := request.CreateRequestor(r)
if op.requestor.Username != curRequestor.Username || op.requestor.Protocol != curRequestor.Protocol {
return false
}
return true
}
// CopyRequestor sets a requestor to match that of another operation.
func (op *Operation) CopyRequestor(otherOp *Operation) {
op.requestor = otherOp.requestor
}
// Requestor returns the initial requestor for this operation.
func (op *Operation) Requestor() *api.EventLifecycleRequestor {
return op.requestor
}
func (op *Operation) done() {
if op.readonly {
return
}
op.lock.Lock()
op.readonly = true
op.onRun = nil
op.onCancel = nil
op.onConnect = nil
op.finished.Cancel()
op.lock.Unlock()
go func() {
shutdownCtx := context.Background()
if op.state != nil {
shutdownCtx = op.state.ShutdownCtx
}
select {
case <-shutdownCtx.Done():
return // Expect all operation records to be removed by waitForOperations in one query.
case <-time.After(time.Second * 5): // Wait 5s before removing from internal map and database.
}
operationsLock.Lock()
_, ok := operations[op.id]
if !ok {
operationsLock.Unlock()
return
}
delete(operations, op.id)
operationsLock.Unlock()
if op.state == nil {
return
}
err := removeDBOperation(op)
if err != nil && !api.StatusErrorCheck(err, http.StatusNotFound) {
// Operations can be deleted from the database before the operation clean up go routine has
// run in cases where the project that the operation(s) are associated to is deleted first.
// So don't log warning if operation not found.
op.logger.Warn("Failed to delete operation", logger.Ctx{"status": op.status, "err": err})
}
}()
}
// Start a pending operation. It returns an error if the operation cannot be started.
func (op *Operation) Start() error {
op.lock.Lock()
if op.status != api.Pending {
op.lock.Unlock()
return errors.New("Only pending operations can be started")
}
op.status = api.Running
if op.onRun != nil {
go func(op *Operation) {
err := op.onRun(op)
if err != nil {
op.lock.Lock()
op.status = api.Failure
op.err = err
op.lock.Unlock()
op.done()
op.logger.Debug("Failure for operation", logger.Ctx{"err": err})
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return
}
op.lock.Lock()
op.status = api.Success
op.lock.Unlock()
op.done()
op.logger.Debug("Success for operation")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
}(op)
}
op.lock.Unlock()
op.logger.Debug("Started operation")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return nil
}
// Cancel cancels a running operation. If the operation cannot be cancelled, it
// returns an error.
func (op *Operation) Cancel() (chan error, error) {
op.lock.Lock()
if op.status != api.Running {
op.lock.Unlock()
return nil, errors.New("Only running operations can be cancelled")
}
if !op.mayCancel() {
op.lock.Unlock()
return nil, errors.New("This operation can't be cancelled")
}
chanCancel := make(chan error, 1)
oldStatus := op.status
op.status = api.Cancelling
op.lock.Unlock()
hasOnCancel := op.onCancel != nil
if hasOnCancel {
go func(op *Operation, oldStatus api.StatusCode, chanCancel chan error) {
err := op.onCancel(op)
if err != nil {
op.lock.Lock()
op.status = oldStatus
op.lock.Unlock()
chanCancel <- err
op.logger.Debug("Failed to cancel operation", logger.Ctx{"err": err})
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return
}
op.lock.Lock()
op.status = api.Cancelled
op.lock.Unlock()
op.done()
chanCancel <- nil
op.logger.Debug("Cancelled operation")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
}(op, oldStatus, chanCancel)
}
op.logger.Debug("Cancelling operation")
_, md, _ := op.Render()
op.sendEvent(md)
if op.canceler != nil {
err := op.canceler.Cancel()
if err != nil {
return nil, err
}
}
if !hasOnCancel {
op.lock.Lock()
op.status = api.Cancelled
op.lock.Unlock()
op.done()
chanCancel <- nil
}
op.logger.Debug("Cancelled operation")
_, md, _ = op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return chanCancel, nil
}
// Connect connects a websocket operation. If the operation is not a websocket
// operation or the operation is not running, it returns an error.
func (op *Operation) Connect(r *http.Request, w http.ResponseWriter) (chan error, error) {
op.lock.Lock()
if op.class != OperationClassWebsocket {
op.lock.Unlock()
return nil, errors.New("Only websocket operations can be connected")
}
if op.status != api.Running {
op.lock.Unlock()
return nil, errors.New("Only running operations can be connected")
}
chanConnect := make(chan error, 1)
go func(op *Operation, chanConnect chan error) {
err := op.onConnect(op, r, w)
if err != nil {
chanConnect <- err
op.logger.Debug("Failed to connect to operation", logger.Ctx{"err": err})
return
}
chanConnect <- nil
op.logger.Debug("Connected to operation")
}(op, chanConnect)
op.lock.Unlock()
op.logger.Debug("Connecting to operation")
return chanConnect, nil
}
func (op *Operation) mayCancel() bool {
if op.class == OperationClassToken {
return true
}
if op.onCancel != nil {
return true
}
if op.canceler != nil && op.canceler.Cancelable() {
return true
}
return false
}
// Render renders the operation structure.
// Returns URL of operation and operation info.
func (op *Operation) Render() (string, *api.Operation, error) {
// Setup the resource URLs
renderedResources := make(map[string][]string)
resources := op.resources
if resources != nil {
tmpResources := make(map[string][]string)
for key, value := range resources {
var values []string
for _, c := range value {
values = append(values, c.Project(op.Project()).String())
}
tmpResources[key] = values
}
renderedResources = tmpResources
}
// Local server name
op.lock.Lock()
retOp := &api.Operation{
ID: op.id,
Class: op.class.String(),
Description: op.description,
CreatedAt: op.createdAt,
UpdatedAt: op.updatedAt,
Status: op.status.String(),
StatusCode: op.status,
Resources: renderedResources,
Metadata: op.metadata,
MayCancel: op.mayCancel(),
}
if op.state != nil {
retOp.Location = op.state.ServerName
}
if op.err != nil {
retOp.Err = response.SmartError(op.err).String()
}
op.lock.Unlock()
return op.url, retOp, nil
}
// Wait for the operation to be done.
// Returns non-nil error if operation failed or context was cancelled.
func (op *Operation) Wait(ctx context.Context) error {
select {
case <-op.finished.Done():
return op.err
case <-ctx.Done():
return ctx.Err()
}
}
// UpdateResources updates the resources of the operation. It returns an error
// if the operation is not pending or running, or the operation is read-only.
func (op *Operation) UpdateResources(opResources map[string][]api.URL) error {
op.lock.Lock()
if op.status != api.Pending && op.status != api.Running {
op.lock.Unlock()
return errors.New("Only pending or running operations can be updated")
}
if op.readonly {
op.lock.Unlock()
return errors.New("Read-only operations can't be updated")
}
op.updatedAt = time.Now()
op.resources = opResources
op.lock.Unlock()
op.logger.Debug("Updated resources for oeration")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return nil
}
// UpdateMetadata updates the metadata of the operation. It returns an error
// if the operation is not pending or running, or the operation is read-only.
func (op *Operation) UpdateMetadata(opMetadata any) error {
op.lock.Lock()
if op.status != api.Pending && op.status != api.Running {
op.lock.Unlock()
return errors.New("Only pending or running operations can be updated")
}
if op.readonly {
op.lock.Unlock()
return errors.New("Read-only operations can't be updated")
}
newMetadata, err := parseMetadata(opMetadata)
if err != nil {
return err
}
op.updatedAt = time.Now()
op.metadata = newMetadata
op.lock.Unlock()
op.logger.Debug("Updated metadata for operation")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return nil
}
// ExtendMetadata updates the metadata of the operation with the additional data provided.
// It returns an error if the operation is not pending or running, or the operation is read-only.
func (op *Operation) ExtendMetadata(metadata any) error {
op.lock.Lock()
// Quick checks.
if op.status != api.Pending && op.status != api.Running {
op.lock.Unlock()
return errors.New("Only pending or running operations can be updated")
}
if op.readonly {
op.lock.Unlock()
return errors.New("Read-only operations can't be updated")
}
// Parse the new metadata.
extraMetadata, err := parseMetadata(metadata)
if err != nil {
return err
}
// Get current metadata.
newMetadata := op.metadata
op.lock.Unlock()
// Merge with current one.
if op.metadata == nil {
newMetadata = extraMetadata
} else {
maps.Copy(newMetadata, extraMetadata)
}
// Update the operation.
op.lock.Lock()
op.updatedAt = time.Now()
op.metadata = newMetadata
op.lock.Unlock()
op.logger.Debug("Updated metadata for operation")
_, md, _ := op.Render()
op.lock.Lock()
op.sendEvent(md)
op.lock.Unlock()
return nil
}
// ID returns the operation ID.
func (op *Operation) ID() string {
return op.id
}
// Metadata returns the operation Metadata.
func (op *Operation) Metadata() map[string]any {
return op.metadata
}
// URL returns the operation URL.
func (op *Operation) URL() string {
return op.url
}
// Resources returns the operation resources.
func (op *Operation) Resources() map[string][]api.URL {
return op.resources
}
// SetCanceler sets a canceler.
func (op *Operation) SetCanceler(canceler *cancel.HTTPRequestCanceller) {
op.canceler = canceler
}
// Permission returns the operations auth.ObjectType and auth.Entitlement.
func (op *Operation) Permission() (auth.ObjectType, auth.Entitlement) {
return op.objectType, op.entitlement
}
// Project returns the operation project.
func (op *Operation) Project() string {
return op.projectName
}
// Status returns the operation status.
func (op *Operation) Status() api.StatusCode {
return op.status
}
// Class returns the operation class.
func (op *Operation) Class() OperationClass {
return op.class
}
// Type returns the db operation type.
func (op *Operation) Type() operationtype.Type {
return op.dbOpType
}
|