manager.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  1. package device
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "sort"
  7. "strings"
  8. "sync"
  9. "time"
  10. "vocat/internal/modem"
  11. )
  12. type Options struct {
  13. Discoverer modem.Discoverer
  14. Opener modem.Opener
  15. CommandTimeout time.Duration
  16. LongTimeout time.Duration
  17. SMSTimeout time.Duration
  18. ScanTimeout time.Duration
  19. }
  20. type Manager struct {
  21. mu sync.RWMutex
  22. esimMu sync.Mutex // serializes eSIM card access (list/switch/download)
  23. esimRecoveryMu sync.Mutex
  24. esimRecoveries map[string]chan struct{}
  25. esimCacheMu sync.RWMutex
  26. esimCache map[string]EsimInfo
  27. discoverer modem.Discoverer
  28. opener modem.Opener
  29. commandTimeout time.Duration
  30. longTimeout time.Duration
  31. smsTimeout time.Duration
  32. scanTimeout time.Duration
  33. started bool
  34. devices map[string]*managedDevice
  35. ussdSessions map[string]ussdSession
  36. }
  37. // ussdSession tracks an open USSD dialog on a device so a follow-up Continue or
  38. // Cancel can be routed back to the right modem. The modem owns the actual
  39. // network session; this map only records which device a session id belongs to.
  40. type ussdSession struct {
  41. deviceID string
  42. createdAt time.Time
  43. }
  44. type managedDevice struct {
  45. opMu sync.Mutex
  46. candidate modem.Candidate
  47. client modem.Client
  48. snapshot *Snapshot
  49. lastError string
  50. lastUpdated time.Time
  51. discovered bool
  52. preFlightMode *int
  53. resetClientOnLock bool
  54. }
  55. func NewManager(options Options) (*Manager, error) {
  56. if options.Discoverer == nil {
  57. options.Discoverer = modem.NewSystemDiscoverer()
  58. }
  59. if options.Opener == nil {
  60. options.Opener = modem.SerialOpener{}
  61. }
  62. if options.CommandTimeout <= 0 {
  63. options.CommandTimeout = 3 * time.Second
  64. }
  65. if options.LongTimeout <= 0 {
  66. options.LongTimeout = 45 * time.Second
  67. }
  68. if options.SMSTimeout <= 0 {
  69. // Quectel documents a maximum AT+CMGS response time of 120 seconds.
  70. options.SMSTimeout = 125 * time.Second
  71. }
  72. if options.ScanTimeout <= 0 {
  73. // AT+COPS=? can take well over a minute while the modem sweeps every band.
  74. options.ScanTimeout = 150 * time.Second
  75. }
  76. return &Manager{
  77. discoverer: options.Discoverer,
  78. opener: options.Opener,
  79. commandTimeout: options.CommandTimeout,
  80. longTimeout: options.LongTimeout,
  81. smsTimeout: options.SMSTimeout,
  82. scanTimeout: options.ScanTimeout,
  83. devices: make(map[string]*managedDevice),
  84. ussdSessions: make(map[string]ussdSession),
  85. esimRecoveries: make(map[string]chan struct{}),
  86. esimCache: make(map[string]EsimInfo),
  87. }, nil
  88. }
  89. func (manager *Manager) Start(ctx context.Context) error {
  90. manager.mu.Lock()
  91. if manager.started {
  92. manager.mu.Unlock()
  93. return nil
  94. }
  95. manager.mu.Unlock()
  96. if _, err := manager.Discover(ctx); err != nil {
  97. return err
  98. }
  99. manager.mu.Lock()
  100. manager.started = true
  101. manager.mu.Unlock()
  102. return nil
  103. }
  104. func (manager *Manager) Stop(ctx context.Context) error {
  105. if ctx == nil {
  106. ctx = context.Background()
  107. }
  108. manager.mu.Lock()
  109. manager.started = false
  110. states := make([]*managedDevice, 0, len(manager.devices))
  111. for _, state := range manager.devices {
  112. states = append(states, state)
  113. }
  114. manager.mu.Unlock()
  115. var closeErrors []error
  116. for _, state := range states {
  117. if err := ctx.Err(); err != nil {
  118. return errors.Join(append(closeErrors, err)...)
  119. }
  120. state.opMu.Lock()
  121. if state.client != nil {
  122. if err := state.client.Close(); err != nil {
  123. closeErrors = append(closeErrors, err)
  124. }
  125. state.client = nil
  126. }
  127. state.opMu.Unlock()
  128. }
  129. return errors.Join(closeErrors...)
  130. }
  131. func (manager *Manager) Discover(ctx context.Context) ([]Device, error) {
  132. if ctx == nil {
  133. ctx = context.Background()
  134. }
  135. candidates, err := manager.discoverer.Discover(ctx)
  136. if err != nil {
  137. return nil, err
  138. }
  139. seen := make(map[string]struct{}, len(candidates))
  140. manager.mu.Lock()
  141. for _, candidate := range candidates {
  142. if strings.TrimSpace(candidate.ID) == "" {
  143. continue
  144. }
  145. seen[candidate.ID] = struct{}{}
  146. state := manager.devices[candidate.ID]
  147. if state == nil {
  148. manager.devices[candidate.ID] = &managedDevice{
  149. candidate: candidate,
  150. discovered: true,
  151. }
  152. continue
  153. }
  154. if state.candidate.ATPort.OpenPath() != candidate.ATPort.OpenPath() {
  155. state.resetClientOnLock = true
  156. }
  157. state.candidate = candidate
  158. state.discovered = true
  159. }
  160. var stale []*managedDevice
  161. for id, state := range manager.devices {
  162. if _, ok := seen[id]; ok {
  163. continue
  164. }
  165. state.discovered = false
  166. stale = append(stale, state)
  167. }
  168. manager.mu.Unlock()
  169. for _, state := range stale {
  170. state.opMu.Lock()
  171. if state.client != nil {
  172. _ = state.client.Close()
  173. state.client = nil
  174. }
  175. state.opMu.Unlock()
  176. }
  177. manager.resetChangedClients()
  178. return manager.List(), nil
  179. }
  180. func (manager *Manager) resetChangedClients() {
  181. manager.mu.Lock()
  182. states := make([]*managedDevice, 0, len(manager.devices))
  183. for _, state := range manager.devices {
  184. if state.resetClientOnLock {
  185. states = append(states, state)
  186. state.resetClientOnLock = false
  187. }
  188. }
  189. manager.mu.Unlock()
  190. for _, state := range states {
  191. state.opMu.Lock()
  192. if state.client != nil {
  193. _ = state.client.Close()
  194. state.client = nil
  195. }
  196. state.opMu.Unlock()
  197. }
  198. }
  199. func (manager *Manager) List() []Device {
  200. manager.mu.RLock()
  201. result := make([]Device, 0, len(manager.devices))
  202. for id, state := range manager.devices {
  203. result = append(result, copyDevice(id, state))
  204. }
  205. manager.mu.RUnlock()
  206. sort.Slice(result, func(i, j int) bool { return result[i].ID < result[j].ID })
  207. return result
  208. }
  209. func (manager *Manager) Get(id string) (Device, error) {
  210. manager.mu.RLock()
  211. state := manager.devices[id]
  212. if state == nil {
  213. manager.mu.RUnlock()
  214. return Device{}, ErrNotFound
  215. }
  216. result := copyDevice(id, state)
  217. manager.mu.RUnlock()
  218. return result, nil
  219. }
  220. func copyDevice(id string, state *managedDevice) Device {
  221. var snapshot *Snapshot
  222. if state.snapshot != nil {
  223. value := *state.snapshot
  224. value.Warnings = append([]string(nil), value.Warnings...)
  225. snapshot = &value
  226. }
  227. return Device{
  228. ID: id,
  229. Candidate: copyCandidate(state.candidate),
  230. Snapshot: snapshot,
  231. LastError: state.lastError,
  232. Discovered: state.discovered,
  233. LastUpdated: state.lastUpdated,
  234. }
  235. }
  236. func copyCandidate(candidate modem.Candidate) modem.Candidate {
  237. candidate.Ports = append([]modem.Port(nil), candidate.Ports...)
  238. return candidate
  239. }
  240. func (manager *Manager) lookup(id string) (*managedDevice, error) {
  241. manager.mu.RLock()
  242. defer manager.mu.RUnlock()
  243. if !manager.started {
  244. return nil, ErrNotStarted
  245. }
  246. state := manager.devices[id]
  247. if state == nil || !state.discovered {
  248. return nil, ErrNotFound
  249. }
  250. return state, nil
  251. }
  252. func (manager *Manager) clientLocked(
  253. ctx context.Context,
  254. state *managedDevice,
  255. candidate modem.Candidate,
  256. ) (modem.Client, error) {
  257. if state.client != nil {
  258. if poisoned, ok := state.client.(modem.PoisonedClient); ok && poisoned.Poisoned() {
  259. // The cached session hit a transport-fatal error (a failed
  260. // write/drain/read or a closed serial line); the underlying fd is
  261. // wedged and every subsequent command reuses the corpse, so the
  262. // device stays stuck on EIO forever. Discard it and reopen so the
  263. // next AT/CSIM call self-heals. AT-level failures (CommandError,
  264. // command timeout) do not poison — those leave a healthy transport
  265. // that reopening would only destroy over a transient +CME ERROR.
  266. _ = state.client.Close()
  267. state.client = nil
  268. } else {
  269. return state.client, nil
  270. }
  271. }
  272. if !candidate.HasATPort() {
  273. return nil, ErrNoATPort
  274. }
  275. client, err := manager.opener.Open(ctx, candidate.ATPort)
  276. if err != nil {
  277. return nil, err
  278. }
  279. state.client = client
  280. return client, nil
  281. }
  282. func (manager *Manager) setResult(
  283. id string,
  284. state *managedDevice,
  285. snapshot *Snapshot,
  286. err error,
  287. ) {
  288. manager.mu.Lock()
  289. defer manager.mu.Unlock()
  290. if manager.devices[id] != state {
  291. return
  292. }
  293. if snapshot != nil {
  294. value := *snapshot
  295. value.Warnings = append([]string(nil), snapshot.Warnings...)
  296. state.snapshot = &value
  297. state.lastUpdated = snapshot.UpdatedAt
  298. }
  299. if err != nil {
  300. state.lastError = err.Error()
  301. } else {
  302. state.lastError = ""
  303. }
  304. }
  305. func (manager *Manager) candidateFor(state *managedDevice) modem.Candidate {
  306. manager.mu.RLock()
  307. defer manager.mu.RUnlock()
  308. return copyCandidate(state.candidate)
  309. }
  310. func (manager *Manager) validateActive(
  311. id string,
  312. state *managedDevice,
  313. ) error {
  314. manager.mu.RLock()
  315. defer manager.mu.RUnlock()
  316. if !manager.started {
  317. return ErrNotStarted
  318. }
  319. current := manager.devices[id]
  320. if current != state || !state.discovered {
  321. return ErrNotFound
  322. }
  323. return nil
  324. }
  325. func (manager *Manager) Refresh(ctx context.Context, id string) (Snapshot, error) {
  326. state, err := manager.lookup(id)
  327. if err != nil {
  328. return Snapshot{}, err
  329. }
  330. state.opMu.Lock()
  331. defer state.opMu.Unlock()
  332. if err := manager.validateActive(id, state); err != nil {
  333. return Snapshot{}, err
  334. }
  335. candidate := manager.candidateFor(state)
  336. client, err := manager.clientLocked(ctx, state, candidate)
  337. if err != nil {
  338. manager.setResult(id, state, nil, err)
  339. return Snapshot{}, err
  340. }
  341. snapshot, err := manager.readSnapshot(ctx, id, candidate, client)
  342. manager.setResult(id, state, &snapshot, err)
  343. return snapshot, err
  344. }
  345. func (manager *Manager) ExecuteAT(
  346. ctx context.Context,
  347. id string,
  348. command string,
  349. ) (modem.Response, error) {
  350. state, err := manager.lookup(id)
  351. if err != nil {
  352. return modem.Response{}, err
  353. }
  354. state.opMu.Lock()
  355. defer state.opMu.Unlock()
  356. if err := manager.validateActive(id, state); err != nil {
  357. return modem.Response{}, err
  358. }
  359. client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
  360. if err != nil {
  361. manager.setResult(id, state, nil, err)
  362. return modem.Response{}, err
  363. }
  364. commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
  365. defer cancel()
  366. response, err := client.Execute(commandCtx, command)
  367. manager.setResult(id, state, nil, err)
  368. return response, err
  369. }
  370. // ExecuteSensitiveAT runs an AT command whose payload contains short-lived
  371. // authentication material. The original transport error is returned to the
  372. // caller, but it is never retained in the device snapshot because a
  373. // modem.CommandError may include the full command.
  374. func (manager *Manager) ExecuteSensitiveAT(
  375. ctx context.Context,
  376. id string,
  377. command string,
  378. ) (modem.Response, error) {
  379. state, err := manager.lookup(id)
  380. if err != nil {
  381. return modem.Response{}, err
  382. }
  383. state.opMu.Lock()
  384. defer state.opMu.Unlock()
  385. if err := manager.validateActive(id, state); err != nil {
  386. return modem.Response{}, err
  387. }
  388. client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
  389. if err != nil {
  390. manager.setResult(
  391. id,
  392. state,
  393. nil,
  394. errors.New("sensitive AT command could not open the modem"),
  395. )
  396. return modem.Response{}, err
  397. }
  398. commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
  399. defer cancel()
  400. response, err := client.Execute(commandCtx, command)
  401. recordedErr := err
  402. if err != nil {
  403. recordedErr = errors.New("sensitive AT command failed")
  404. }
  405. manager.setResult(id, state, nil, recordedErr)
  406. return response, err
  407. }
  408. func (manager *Manager) Reboot(ctx context.Context, id string) error {
  409. state, err := manager.lookup(id)
  410. if err != nil {
  411. return err
  412. }
  413. state.opMu.Lock()
  414. defer state.opMu.Unlock()
  415. if err := manager.validateActive(id, state); err != nil {
  416. return err
  417. }
  418. client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
  419. if err != nil {
  420. manager.setResult(id, state, nil, err)
  421. return err
  422. }
  423. commandCtx, cancel := manager.withTimeout(ctx, manager.longTimeout)
  424. defer cancel()
  425. _, err = client.Execute(commandCtx, "AT+CFUN=1,1")
  426. if closeErr := client.Close(); err == nil {
  427. err = closeErr
  428. }
  429. state.client = nil
  430. state.preFlightMode = nil
  431. manager.clearSnapshot(id, state)
  432. manager.setResult(id, state, nil, err)
  433. return err
  434. }
  435. // rebootForProfileSwitch is the post-EnableProfile modem reset. After the eUICC
  436. // marks a new profile active, the modem keeps the old SIM cached and lands in
  437. // SIM failure (-CME 13) until it is bounced. ESIMSwitchProfile has already
  438. // released opMu by the time it calls this, so the reset is safe to take the
  439. // lock. This mirrors Reboot but is separate so the call site can't recurse into
  440. // a guarded-reset path.
  441. func (manager *Manager) rebootForProfileSwitch(ctx context.Context, id string) error {
  442. state, err := manager.lookup(id)
  443. if err != nil {
  444. return err
  445. }
  446. state.opMu.Lock()
  447. defer state.opMu.Unlock()
  448. if err := manager.validateActive(id, state); err != nil {
  449. return err
  450. }
  451. client, err := manager.clientLocked(ctx, state, manager.candidateFor(state))
  452. if err != nil {
  453. manager.setResult(id, state, nil, err)
  454. return err
  455. }
  456. commandCtx, cancel := manager.withTimeout(ctx, manager.longTimeout)
  457. defer cancel()
  458. _, err = client.Execute(commandCtx, "AT+CFUN=1,1")
  459. if closeErr := client.Close(); err == nil {
  460. err = closeErr
  461. }
  462. state.client = nil
  463. state.preFlightMode = nil
  464. manager.clearSnapshot(id, state)
  465. manager.setResult(id, state, nil, err)
  466. return err
  467. }
  468. func (manager *Manager) clearSnapshot(id string, state *managedDevice) {
  469. manager.mu.Lock()
  470. defer manager.mu.Unlock()
  471. if manager.devices[id] == state {
  472. state.snapshot = nil
  473. }
  474. }
  475. func (manager *Manager) withTimeout(
  476. ctx context.Context,
  477. timeout time.Duration,
  478. ) (context.Context, context.CancelFunc) {
  479. if ctx == nil {
  480. ctx = context.Background()
  481. }
  482. if _, ok := ctx.Deadline(); ok {
  483. return context.WithCancel(ctx)
  484. }
  485. return context.WithTimeout(ctx, timeout)
  486. }
  487. func (manager *Manager) command(
  488. ctx context.Context,
  489. client modem.Client,
  490. command string,
  491. ) (modem.Response, error) {
  492. commandCtx, cancel := manager.withTimeout(ctx, manager.commandTimeout)
  493. defer cancel()
  494. response, err := client.Execute(commandCtx, command)
  495. if err != nil {
  496. return response, fmt.Errorf("%s: %w", command, err)
  497. }
  498. return response, nil
  499. }