| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531 |
- package device
- import (
- "context"
- "errors"
- "fmt"
- "sort"
- "strings"
- "sync"
- "time"
- "vocat/internal/modem"
- )
- type Options struct {
- Discoverer modem.Discoverer
- Opener modem.Opener
- CommandTimeout time.Duration
- LongTimeout time.Duration
- SMSTimeout time.Duration
- ScanTimeout time.Duration
- }
- type Manager struct {
- mu sync.RWMutex
- esimMu sync.Mutex // serializes eSIM card access (list/switch/download)
- esimRecoveryMu sync.Mutex
- esimRecoveries map[string]chan struct{}
- esimCacheMu sync.RWMutex
- esimCache map[string]EsimInfo
- discoverer modem.Discoverer
- opener modem.Opener
- commandTimeout time.Duration
- longTimeout time.Duration
- smsTimeout time.Duration
- scanTimeout time.Duration
- started bool
- devices map[string]*managedDevice
- ussdSessions map[string]ussdSession
- }
- // ussdSession tracks an open USSD dialog on a device so a follow-up Continue or
- // Cancel can be routed back to the right modem. The modem owns the actual
- // network session; this map only records which device a session id belongs to.
- type ussdSession struct {
- deviceID string
- createdAt time.Time
- }
- type managedDevice struct {
- opMu sync.Mutex
- candidate modem.Candidate
- client modem.Client
- snapshot *Snapshot
- lastError string
- lastUpdated time.Time
- discovered bool
- preFlightMode *int
- resetClientOnLock bool
- }
- func NewManager(options Options) (*Manager, error) {
- if options.Discoverer == nil {
- options.Discoverer = modem.NewSystemDiscoverer()
- }
- if options.Opener == nil {
- options.Opener = modem.SerialOpener{}
- }
- if options.CommandTimeout <= 0 {
- options.CommandTimeout = 3 * time.Second
- }
- if options.LongTimeout <= 0 {
- options.LongTimeout = 45 * time.Second
- }
- if options.SMSTimeout <= 0 {
- // Quectel documents a maximum AT+CMGS response time of 120 seconds.
- options.SMSTimeout = 125 * time.Second
- }
- if options.ScanTimeout <= 0 {
- // AT+COPS=? can take well over a minute while the modem sweeps every band.
- options.ScanTimeout = 150 * time.Second
- }
- return &Manager{
- discoverer: options.Discoverer,
- opener: options.Opener,
- commandTimeout: options.CommandTimeout,
- longTimeout: options.LongTimeout,
- smsTimeout: options.SMSTimeout,
- scanTimeout: options.ScanTimeout,
- devices: make(map[string]*managedDevice),
- ussdSessions: make(map[string]ussdSession),
- esimRecoveries: make(map[string]chan struct{}),
- esimCache: make(map[string]EsimInfo),
- }, nil
- }
- func (manager *Manager) Start(ctx context.Context) error {
- manager.mu.Lock()
- if manager.started {
- manager.mu.Unlock()
- return nil
- }
- manager.mu.Unlock()
- if _, err := manager.Discover(ctx); err != nil {
- return err
- }
- manager.mu.Lock()
- manager.started = true
- manager.mu.Unlock()
- return nil
- }
- func (manager *Manager) Stop(ctx context.Context) error {
- if ctx == nil {
- ctx = context.Background()
- }
- manager.mu.Lock()
- manager.started = false
- states := make([]*managedDevice, 0, len(manager.devices))
- for _, state := range manager.devices {
- states = append(states, state)
- }
- manager.mu.Unlock()
- var closeErrors []error
- for _, state := range states {
- if err := ctx.Err(); err != nil {
- return errors.Join(append(closeErrors, err)...)
- }
- state.opMu.Lock()
- if state.client != nil {
- if err := state.client.Close(); err != nil {
- closeErrors = append(closeErrors, err)
- }
- state.client = nil
- }
- state.opMu.Unlock()
- }
- return errors.Join(closeErrors...)
- }
- func (manager *Manager) Discover(ctx context.Context) ([]Device, error) {
- if ctx == nil {
- ctx = context.Background()
- }
- candidates, err := manager.discoverer.Discover(ctx)
- if err != nil {
- return nil, err
- }
- seen := make(map[string]struct{}, len(candidates))
- manager.mu.Lock()
- for _, candidate := range candidates {
- if strings.TrimSpace(candidate.ID) == "" {
- continue
- }
- seen[candidate.ID] = struct{}{}
- state := manager.devices[candidate.ID]
- if state == nil {
- manager.devices[candidate.ID] = &managedDevice{
- candidate: candidate,
- discovered: true,
- }
- continue
- }
- if state.candidate.ATPort.OpenPath() != candidate.ATPort.OpenPath() {
- state.resetClientOnLock = true
- }
- state.candidate = candidate
- state.discovered = true
- }
- var stale []*managedDevice
- for id, state := range manager.devices {
- if _, ok := seen[id]; ok {
- continue
- }
- state.discovered = false
- stale = append(stale, state)
- }
- manager.mu.Unlock()
- for _, state := range stale {
- state.opMu.Lock()
- if state.client != nil {
- _ = state.client.Close()
- state.client = nil
- }
- state.opMu.Unlock()
- }
- manager.resetChangedClients()
- return manager.List(), nil
- }
- func (manager *Manager) resetChangedClients() {
- manager.mu.Lock()
- states := make([]*managedDevice, 0, len(manager.devices))
- for _, state := range manager.devices {
- if state.resetClientOnLock {
- states = append(states, state)
- state.resetClientOnLock = false
- }
- }
- manager.mu.Unlock()
- for _, state := range states {
- state.opMu.Lock()
- if state.client != nil {
- _ = state.client.Close()
- state.client = nil
- }
- state.opMu.Unlock()
- }
- }
- func (manager *Manager) List() []Device {
- manager.mu.RLock()
- result := make([]Device, 0, len(manager.devices))
- for id, state := range manager.devices {
- result = append(result, copyDevice(id, state))
- }
- manager.mu.RUnlock()
- sort.Slice(result, func(i, j int) bool { return result[i].ID < result[j].ID })
- return result
- }
- func (manager *Manager) Get(id string) (Device, error) {
- manager.mu.RLock()
- state := manager.devices[id]
- if state == nil {
- manager.mu.RUnlock()
- return Device{}, ErrNotFound
- }
- result := copyDevice(id, state)
- manager.mu.RUnlock()
- return result, nil
- }
- func copyDevice(id string, state *managedDevice) Device {
- var snapshot *Snapshot
- if state.snapshot != nil {
- value := *state.snapshot
- value.Warnings = append([]string(nil), value.Warnings...)
- snapshot = &value
- }
- return Device{
- ID: id,
- Candidate: copyCandidate(state.candidate),
- Snapshot: snapshot,
- LastError: state.lastError,
- Discovered: state.discovered,
- LastUpdated: state.lastUpdated,
- }
- }
- func copyCandidate(candidate modem.Candidate) modem.Candidate {
- candidate.Ports = append([]modem.Port(nil), candidate.Ports...)
- return candidate
- }
- func (manager *Manager) lookup(id string) (*managedDevice, error) {
- manager.mu.RLock()
- defer manager.mu.RUnlock()
- if !manager.started {
- return nil, ErrNotStarted
- }
- state := manager.devices[id]
- if state == nil || !state.discovered {
- return nil, ErrNotFound
- }
- return state, nil
- }
- func (manager *Manager) clientLocked(
- ctx context.Context,
- state *managedDevice,
- candidate modem.Candidate,
- ) (modem.Client, error) {
- if state.client != nil {
- if poisoned, ok := state.client.(modem.PoisonedClient); ok && poisoned.Poisoned() {
- // The cached session hit a transport-fatal error (a failed
- // write/drain/read or a closed serial line); the underlying fd is
- // wedged and every subsequent command reuses the corpse, so the
- // device stays stuck on EIO forever. Discard it and reopen so the
- // next AT/CSIM call self-heals. AT-level failures (CommandError,
- // command timeout) do not poison — those leave a healthy transport
- // that reopening would only destroy over a transient +CME ERROR.
- _ = state.client.Close()
- state.client = nil
- } else {
- return state.client, nil
- }
- }
- if !candidate.HasATPort() {
- return nil, ErrNoATPort
- }
- client, err := manager.opener.Open(ctx, candidate.ATPort)
- if err != nil {
- return nil, err
- }
- state.client = client
- return client, nil
- }
- func (manager *Manager) setResult(
- id string,
- state *managedDevice,
- snapshot *Snapshot,
- err error,
- ) {
- manager.mu.Lock()
- defer manager.mu.Unlock()
- if manager.devices[id] != state {
- return
- }
- if snapshot != nil {
- value := *snapshot
- value.Warnings = append([]string(nil), snapshot.Warnings...)
- state.snapshot = &value
- state.lastUpdated = snapshot.UpdatedAt
- }
- if err != nil {
- state.lastError = err.Error()
- } else {
- state.lastError = ""
- }
- }
- func (manager *Manager) candidateFor(state *managedDevice) modem.Candidate {
- manager.mu.RLock()
- defer manager.mu.RUnlock()
- return copyCandidate(state.candidate)
- }
- func (manager *Manager) validateActive(
- id string,
- state *managedDevice,
- ) error {
- manager.mu.RLock()
- defer manager.mu.RUnlock()
- if !manager.started {
- return ErrNotStarted
- }
- current := manager.devices[id]
- if current != state || !state.discovered {
- return ErrNotFound
- }
- return nil
- }
- func (manager *Manager) Refresh(ctx context.Context, id string) (Snapshot, error) {
- state, err := manager.lookup(id)
- if err != nil {
- return Snapshot{}, err
- }
- state.opMu.Lock()
- defer state.opMu.Unlock()
- if err := manager.validateActive(id, state); err != nil {
- return Snapshot{}, err
- }
- candidate := manager.candidateFor(state)
- client, err := manager.clientLocked(ctx, state, candidate)
- if err != nil {
- manager.setResult(id, state, nil, err)
- return Snapshot{}, err
- }
- snapshot, err := manager.readSnapshot(ctx, id, candidate, client)
- manager.setResult(id, state, &snapshot, err)
- return snapshot, err
- }
- func (manager *Manager) ExecuteAT(
- ctx context.Context,
- id string,
- command string,
- ) (modem.Response, error) {
- state, err := manager.lookup(id)
- if err != nil {
- return modem.Response{}, err
- }
- state.opMu.Lock()
- defer state.opMu.Unlock()
- if err := manager.validateActive(id, state); err != nil {
- return modem.Response{}, err
- }
- client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
- if err != nil {
- manager.setResult(id, state, nil, err)
- return modem.Response{}, err
- }
- commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
- defer cancel()
- response, err := client.Execute(commandCtx, command)
- manager.setResult(id, state, nil, err)
- return response, err
- }
- // ExecuteSensitiveAT runs an AT command whose payload contains short-lived
- // authentication material. The original transport error is returned to the
- // caller, but it is never retained in the device snapshot because a
- // modem.CommandError may include the full command.
- func (manager *Manager) ExecuteSensitiveAT(
- ctx context.Context,
- id string,
- command string,
- ) (modem.Response, error) {
- state, err := manager.lookup(id)
- if err != nil {
- return modem.Response{}, err
- }
- state.opMu.Lock()
- defer state.opMu.Unlock()
- if err := manager.validateActive(id, state); err != nil {
- return modem.Response{}, err
- }
- client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
- if err != nil {
- manager.setResult(
- id,
- state,
- nil,
- errors.New("sensitive AT command could not open the modem"),
- )
- return modem.Response{}, err
- }
- commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
- defer cancel()
- response, err := client.Execute(commandCtx, command)
- recordedErr := err
- if err != nil {
- recordedErr = errors.New("sensitive AT command failed")
- }
- manager.setResult(id, state, nil, recordedErr)
- return response, err
- }
- func (manager *Manager) Reboot(ctx context.Context, id string) error {
- state, err := manager.lookup(id)
- if err != nil {
- return err
- }
- state.opMu.Lock()
- defer state.opMu.Unlock()
- if err := manager.validateActive(id, state); err != nil {
- return err
- }
- client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
- if err != nil {
- manager.setResult(id, state, nil, err)
- return err
- }
- commandCtx, cancel := manager.withTimeout(ctx, manager.longTimeout)
- defer cancel()
- _, err = client.Execute(commandCtx, "AT+CFUN=1,1")
- if closeErr := client.Close(); err == nil {
- err = closeErr
- }
- state.client = nil
- state.preFlightMode = nil
- manager.clearSnapshot(id, state)
- manager.setResult(id, state, nil, err)
- return err
- }
- // rebootForProfileSwitch is the post-EnableProfile modem reset. After the eUICC
- // marks a new profile active, the modem keeps the old SIM cached and lands in
- // SIM failure (-CME 13) until it is bounced. ESIMSwitchProfile has already
- // released opMu by the time it calls this, so the reset is safe to take the
- // lock. This mirrors Reboot but is separate so the call site can't recurse into
- // a guarded-reset path.
- func (manager *Manager) rebootForProfileSwitch(ctx context.Context, id string) error {
- state, err := manager.lookup(id)
- if err != nil {
- return err
- }
- state.opMu.Lock()
- defer state.opMu.Unlock()
- if err := manager.validateActive(id, state); err != nil {
- return err
- }
- client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
- if err != nil {
- manager.setResult(id, state, nil, err)
- return err
- }
- commandCtx, cancel := manager.withTimeout(ctx, manager.longTimeout)
- defer cancel()
- _, err = client.Execute(commandCtx, "AT+CFUN=1,1")
- if closeErr := client.Close(); err == nil {
- err = closeErr
- }
- state.client = nil
- state.preFlightMode = nil
- manager.clearSnapshot(id, state)
- manager.setResult(id, state, nil, err)
- return err
- }
- func (manager *Manager) clearSnapshot(id string, state *managedDevice) {
- manager.mu.Lock()
- defer manager.mu.Unlock()
- if manager.devices[id] == state {
- state.snapshot = nil
- }
- }
- func (manager *Manager) withTimeout(
- ctx context.Context,
- timeout time.Duration,
- ) (context.Context, context.CancelFunc) {
- if ctx == nil {
- ctx = context.Background()
- }
- if _, ok := ctx.Deadline(); ok {
- return context.WithCancel(ctx)
- }
- return context.WithTimeout(ctx, timeout)
- }
- func (manager *Manager) command(
- ctx context.Context,
- client modem.Client,
- command string,
- ) (modem.Response, error) {
- commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
- defer cancel()
- response, err := client.Execute(commandCtx, command)
- if err != nil {
- return response, fmt.Errorf("%s: %w", command, err)
- }
- return response, nil
- }
|