sched.go 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811
  1. package server
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "log/slog"
  7. "reflect"
  8. "runtime"
  9. "sort"
  10. "strings"
  11. "sync"
  12. "time"
  13. "github.com/ollama/ollama/api"
  14. "github.com/ollama/ollama/envconfig"
  15. "github.com/ollama/ollama/format"
  16. "github.com/ollama/ollama/gpu"
  17. "github.com/ollama/ollama/llm"
  18. )
  19. type LlmRequest struct {
  20. ctx context.Context //nolint:containedctx
  21. model *Model
  22. opts api.Options
  23. origNumCtx int // Track the initial ctx request
  24. sessionDuration *api.Duration
  25. successCh chan *runnerRef
  26. errCh chan error
  27. schedAttempts uint
  28. }
  29. type Scheduler struct {
  30. pendingReqCh chan *LlmRequest
  31. finishedReqCh chan *LlmRequest
  32. expiredCh chan *runnerRef
  33. unloadedCh chan interface{}
  34. loaded map[string]*runnerRef
  35. loadedMu sync.Mutex
  36. loadFn func(req *LlmRequest, ggml *llm.GGML, gpus gpu.GpuInfoList, numParallel int)
  37. newServerFn func(gpus gpu.GpuInfoList, model string, ggml *llm.GGML, adapters []string, projectors []string, opts api.Options, numParallel int) (llm.LlamaServer, error)
  38. getGpuFn func() gpu.GpuInfoList
  39. getCpuFn func() gpu.GpuInfoList
  40. reschedDelay time.Duration
  41. }
  42. // Default automatic value for number of models we allow per GPU
  43. // Model will still need to fit in VRAM, but loading many small models
  44. // on a large GPU can cause stalling
  45. var defaultModelsPerGPU = 3
  46. // Default automatic value for parallel setting
  47. // Model will still need to fit in VRAM. If this setting wont fit
  48. // we'll back off down to 1 to try to get it to fit
  49. var defaultParallel = 4
  50. var ErrMaxQueue = fmt.Errorf("server busy, please try again. maximum pending requests exceeded")
  51. func InitScheduler(ctx context.Context) *Scheduler {
  52. sched := &Scheduler{
  53. pendingReqCh: make(chan *LlmRequest, envconfig.MaxQueuedRequests),
  54. finishedReqCh: make(chan *LlmRequest, envconfig.MaxQueuedRequests),
  55. expiredCh: make(chan *runnerRef, envconfig.MaxQueuedRequests),
  56. unloadedCh: make(chan interface{}, envconfig.MaxQueuedRequests),
  57. loaded: make(map[string]*runnerRef),
  58. newServerFn: llm.NewLlamaServer,
  59. getGpuFn: gpu.GetGPUInfo,
  60. getCpuFn: gpu.GetCPUInfo,
  61. reschedDelay: 250 * time.Millisecond,
  62. }
  63. sched.loadFn = sched.load
  64. return sched
  65. }
  66. // context must be canceled to decrement ref count and release the runner
  67. func (s *Scheduler) GetRunner(c context.Context, model *Model, opts api.Options, sessionDuration *api.Duration) (chan *runnerRef, chan error) {
  68. if opts.NumCtx < 4 {
  69. opts.NumCtx = 4
  70. }
  71. req := &LlmRequest{
  72. ctx: c,
  73. model: model,
  74. opts: opts,
  75. sessionDuration: sessionDuration,
  76. successCh: make(chan *runnerRef),
  77. errCh: make(chan error, 1),
  78. }
  79. select {
  80. case s.pendingReqCh <- req:
  81. default:
  82. req.errCh <- ErrMaxQueue
  83. }
  84. return req.successCh, req.errCh
  85. }
  86. // Returns immediately, spawns go routines for the scheduler which will shutdown when ctx is done
  87. func (s *Scheduler) Run(ctx context.Context) {
  88. slog.Debug("starting llm scheduler")
  89. go func() {
  90. s.processPending(ctx)
  91. }()
  92. go func() {
  93. s.processCompleted(ctx)
  94. }()
  95. }
  96. func (s *Scheduler) processPending(ctx context.Context) {
  97. for {
  98. select {
  99. case <-ctx.Done():
  100. slog.Debug("shutting down scheduler pending loop")
  101. return
  102. case pending := <-s.pendingReqCh:
  103. // Block other requests until we get this pending request running
  104. pending.schedAttempts++
  105. if pending.origNumCtx == 0 {
  106. pending.origNumCtx = pending.opts.NumCtx
  107. }
  108. if pending.ctx.Err() != nil {
  109. slog.Debug("pending request cancelled or timed out, skipping scheduling")
  110. continue
  111. }
  112. numParallel := envconfig.NumParallel
  113. // TODO (jmorganca): multimodal models don't support parallel yet
  114. // see https://github.com/ollama/ollama/issues/4165
  115. if len(pending.model.ProjectorPaths) > 0 && numParallel != 1 {
  116. numParallel = 1
  117. slog.Warn("multimodal models don't support parallel requests yet")
  118. }
  119. // Keep NumCtx and numParallel in sync
  120. if numParallel > 1 {
  121. pending.opts.NumCtx = pending.origNumCtx * numParallel
  122. }
  123. for {
  124. cpus := s.getCpuFn()
  125. var systemMem gpu.GpuInfo
  126. if len(cpus) > 0 {
  127. systemMem = cpus[0]
  128. }
  129. var runnerToExpire *runnerRef
  130. s.loadedMu.Lock()
  131. runner := s.loaded[pending.model.ModelPath]
  132. loadedCount := len(s.loaded)
  133. s.loadedMu.Unlock()
  134. if runner != nil {
  135. if runner.needsReload(ctx, pending) {
  136. runnerToExpire = runner
  137. } else {
  138. // Runner is usable, return it
  139. pending.useLoadedRunner(runner, s.finishedReqCh)
  140. break
  141. }
  142. } else if envconfig.MaxRunners > 0 && loadedCount >= envconfig.MaxRunners {
  143. slog.Debug("max runners achieved, unloading one to make room", "runner_count", loadedCount)
  144. runnerToExpire = s.findRunnerToUnload()
  145. } else {
  146. // Either no models are loaded or below envconfig.MaxRunners
  147. // Get a refreshed GPU list
  148. var gpus gpu.GpuInfoList
  149. if pending.opts.NumGPU == 0 {
  150. gpus = s.getCpuFn()
  151. } else {
  152. gpus = s.getGpuFn()
  153. }
  154. if envconfig.MaxRunners <= 0 {
  155. // No user specified MaxRunners, so figure out what automatic setting to use
  156. // If all GPUs have reliable free memory reporting, defaultModelsPerGPU * the number of GPUs
  157. // if any GPU has unreliable free memory reporting, 1x the number of GPUs
  158. allReliable := true
  159. for _, gpu := range gpus {
  160. if gpu.UnreliableFreeMemory {
  161. allReliable = false
  162. break
  163. }
  164. }
  165. if allReliable {
  166. envconfig.MaxRunners = defaultModelsPerGPU * len(gpus)
  167. slog.Debug("updating default concurrency", "OLLAMA_MAX_LOADED_MODELS", envconfig.MaxRunners, "gpu_count", len(gpus))
  168. } else {
  169. slog.Info("one or more GPUs detected that are unable to accurately report free memory - disabling default concurrency")
  170. envconfig.MaxRunners = len(gpus)
  171. }
  172. }
  173. // Load model for fitting
  174. ggml, err := llm.LoadModel(pending.model.ModelPath, 0)
  175. if err != nil {
  176. pending.errCh <- err
  177. break
  178. }
  179. // Block attempting to load a model larger than system memory + GPU memory
  180. estimate := llm.EstimateGPULayers(gpus, ggml, pending.model.ProjectorPaths, pending.opts)
  181. maxSize := systemMem.FreeMemory
  182. for _, gpu := range gpus {
  183. if gpu.Library == "cpu" {
  184. continue
  185. }
  186. if loadedCount == 0 {
  187. // If no other models are loaded, set the limit based on what's available
  188. maxSize += gpu.FreeMemory
  189. } else {
  190. // Other models could be unloaded, favor total memory for limit
  191. maxSize += gpu.TotalMemory
  192. }
  193. }
  194. if estimate.TotalSize > maxSize {
  195. slog.Warn("model request too large for system", "requested", format.HumanBytes2(estimate.TotalSize), "system", format.HumanBytes2(maxSize))
  196. pending.errCh <- fmt.Errorf("requested model (%s) is too large for this system (%s)", format.HumanBytes2(estimate.TotalSize), format.HumanBytes2(maxSize))
  197. break
  198. }
  199. // Evaluate if the model will fit in the available system memory, or if we should unload a model first
  200. if len(gpus) == 1 && gpus[0].Library == "cpu" {
  201. // simplifying assumption of defaultParallel when in CPU mode
  202. if numParallel <= 0 {
  203. numParallel = defaultParallel
  204. pending.opts.NumCtx = pending.origNumCtx * numParallel
  205. }
  206. if loadedCount == 0 {
  207. slog.Debug("cpu mode with first model, loading")
  208. s.loadFn(pending, ggml, gpus, numParallel)
  209. break
  210. }
  211. runnerToExpire = s.maybeFindCPURunnerToUnload(pending, ggml, gpus)
  212. if runnerToExpire == nil {
  213. slog.Debug("cpu mode with available system memory or first model, loading")
  214. s.loadFn(pending, ggml, gpus, numParallel)
  215. break
  216. }
  217. // else we need to expire a runner
  218. } else if loadedCount == 0 {
  219. // No models loaded. Load the model but prefer the best fit.
  220. slog.Debug("loading first model", "model", pending.model.ModelPath)
  221. g := pickBestFitGPUs(pending, ggml, gpus, &numParallel)
  222. if g != nil {
  223. gpus = g
  224. }
  225. s.loadFn(pending, ggml, gpus, numParallel)
  226. break
  227. }
  228. if runnerToExpire == nil {
  229. // More than one loaded model, so we have to see if the
  230. // new one fits
  231. //
  232. // We want to avoid loading on any GPUs that have other
  233. // models still loading on them to avoid potential races
  234. // with VRAM consumption ramping up during load
  235. availGpus := s.filterGPUsWithoutLoadingModels(gpus)
  236. // Update free memory from currently loaded models
  237. s.updateFreeSpace(availGpus)
  238. fitGpus := pickBestFitGPUs(pending, ggml, availGpus, &numParallel)
  239. if fitGpus != nil {
  240. slog.Debug("new model fits with existing models, loading")
  241. s.loadFn(pending, ggml, fitGpus, numParallel)
  242. break
  243. }
  244. // We couldn't find a set of GPUs to fully load the new
  245. // model. If no other models are loading (both GPU lists
  246. // are the same) then we need to unload another model to
  247. // make room
  248. if len(availGpus) < len(gpus) {
  249. // There are other requests pending, and this one
  250. // needs more time, so put it on the back of the
  251. // queue so that we might satisfy other pending
  252. // requests that aren't blocked
  253. go func() {
  254. // Process in a go routine to avoid deadlocking
  255. // the scheduler if our queue is full
  256. slog.Debug("delaying scheduling while other models finish loading", "attempts", pending.schedAttempts, "model", pending.model.ModelPath)
  257. time.Sleep(s.reschedDelay)
  258. s.pendingReqCh <- pending
  259. }()
  260. break
  261. }
  262. runnerToExpire = s.findRunnerToUnload()
  263. }
  264. }
  265. if runnerToExpire == nil {
  266. // Shouildn't happen
  267. slog.Error("runner to expire was nil!")
  268. continue
  269. }
  270. // Trigger an expiration to unload once it's done
  271. runnerToExpire.refMu.Lock()
  272. slog.Debug("resetting model to expire immediately to make room", "modelPath", runnerToExpire.modelPath, "refCount", runnerToExpire.refCount)
  273. if runnerToExpire.expireTimer != nil {
  274. runnerToExpire.expireTimer.Stop()
  275. runnerToExpire.expireTimer = nil
  276. }
  277. runnerToExpire.sessionDuration = 0
  278. if runnerToExpire.refCount <= 0 {
  279. s.expiredCh <- runnerToExpire
  280. }
  281. runnerToExpire.refMu.Unlock()
  282. // Wait for the unload to happen
  283. // Note: at this point we're queueing up all incoming requests, even if they were for
  284. // a different model that's loaded and not scheduled to be removed.
  285. slog.Debug("waiting for pending requests to complete and unload to occur", "modelPath", runnerToExpire.modelPath)
  286. select {
  287. case <-ctx.Done():
  288. slog.Debug("shutting down scheduler pending loop")
  289. return
  290. case <-s.unloadedCh:
  291. slog.Debug("unload completed", "modelPath", runnerToExpire.modelPath)
  292. continue
  293. }
  294. }
  295. case <-s.unloadedCh:
  296. // An unload request when there are no pending request can be ignored
  297. slog.Debug("ignoring unload event with no pending requests")
  298. }
  299. }
  300. }
  301. func (s *Scheduler) processCompleted(ctx context.Context) {
  302. // Process completed requests, expired timers, and unloading models
  303. for {
  304. select {
  305. case <-ctx.Done():
  306. slog.Debug("shutting down scheduler completed loop")
  307. return
  308. case finished := <-s.finishedReqCh:
  309. s.loadedMu.Lock()
  310. runner := s.loaded[finished.model.ModelPath]
  311. s.loadedMu.Unlock()
  312. if runner == nil {
  313. slog.Error("finished request signal received after model unloaded", "modelPath", finished.model.ModelPath)
  314. continue
  315. }
  316. runner.refMu.Lock()
  317. runner.refCount--
  318. if runner.refCount <= 0 {
  319. if runner.sessionDuration <= 0 {
  320. slog.Debug("runner with zero duration has gone idle, expiring to unload", "modelPath", runner.modelPath)
  321. if runner.expireTimer != nil {
  322. runner.expireTimer.Stop()
  323. runner.expireTimer = nil
  324. }
  325. s.expiredCh <- runner
  326. } else if runner.expireTimer == nil {
  327. slog.Debug("runner with non-zero duration has gone idle, adding timer", "modelPath", runner.modelPath, "duration", runner.sessionDuration)
  328. runner.expireTimer = time.AfterFunc(runner.sessionDuration, func() {
  329. slog.Debug("timer expired, expiring to unload", "modelPath", runner.modelPath)
  330. runner.refMu.Lock()
  331. defer runner.refMu.Unlock()
  332. if runner.expireTimer != nil {
  333. runner.expireTimer.Stop()
  334. runner.expireTimer = nil
  335. }
  336. s.expiredCh <- runner
  337. })
  338. runner.expiresAt = time.Now().Add(runner.sessionDuration)
  339. } else {
  340. slog.Debug("runner with non-zero duration has gone idle, resetting timer", "modelPath", runner.modelPath, "duration", runner.sessionDuration)
  341. runner.expireTimer.Reset(runner.sessionDuration)
  342. runner.expiresAt = time.Now().Add(runner.sessionDuration)
  343. }
  344. }
  345. slog.Debug("after processing request finished event", "modelPath", runner.modelPath, "refCount", runner.refCount)
  346. runner.refMu.Unlock()
  347. case runner := <-s.expiredCh:
  348. slog.Debug("runner expired event received", "modelPath", runner.modelPath)
  349. runner.refMu.Lock()
  350. if runner.refCount > 0 {
  351. // Shouldn't happen, but safeguard to ensure no leaked runners
  352. slog.Debug("expired event with positive ref count, retrying", "modelPath", runner.modelPath, "refCount", runner.refCount)
  353. go func(runner *runnerRef) {
  354. // We can't unload yet, but want to as soon as the current request completes
  355. // So queue up another expired event
  356. time.Sleep(10 * time.Millisecond)
  357. s.expiredCh <- runner
  358. }(runner)
  359. runner.refMu.Unlock()
  360. continue
  361. }
  362. s.loadedMu.Lock()
  363. slog.Debug("got lock to unload", "modelPath", runner.modelPath)
  364. finished := runner.waitForVRAMRecovery()
  365. runner.unload()
  366. delete(s.loaded, runner.modelPath)
  367. s.loadedMu.Unlock()
  368. slog.Debug("runner released", "modelPath", runner.modelPath)
  369. runner.refMu.Unlock()
  370. <-finished
  371. slog.Debug("sending an unloaded event", "modelPath", runner.modelPath)
  372. s.unloadedCh <- struct{}{}
  373. }
  374. }
  375. }
  376. // Complete the pending request and send the runner back to the requester
  377. // Wires up a finished event after the request context is completed
  378. // Updates session duration, and resets expiration timer
  379. func (pending *LlmRequest) useLoadedRunner(runner *runnerRef, finished chan *LlmRequest) {
  380. runner.refMu.Lock()
  381. defer runner.refMu.Unlock()
  382. runner.refCount++
  383. if runner.expireTimer != nil {
  384. runner.expireTimer.Stop()
  385. runner.expireTimer = nil
  386. }
  387. if pending.sessionDuration != nil {
  388. runner.sessionDuration = pending.sessionDuration.Duration
  389. }
  390. pending.successCh <- runner
  391. go func() {
  392. <-pending.ctx.Done()
  393. slog.Debug("context for request finished")
  394. finished <- pending
  395. }()
  396. }
  397. func (s *Scheduler) load(req *LlmRequest, ggml *llm.GGML, gpus gpu.GpuInfoList, numParallel int) {
  398. if numParallel < 1 {
  399. numParallel = 1
  400. }
  401. sessionDuration := envconfig.KeepAlive
  402. if req.sessionDuration != nil {
  403. sessionDuration = req.sessionDuration.Duration
  404. }
  405. llama, err := s.newServerFn(gpus, req.model.ModelPath, ggml, req.model.AdapterPaths, req.model.ProjectorPaths, req.opts, numParallel)
  406. if err != nil {
  407. // some older models are not compatible with newer versions of llama.cpp
  408. // show a generalized compatibility error until there is a better way to
  409. // check for model compatibility
  410. if errors.Is(llm.ErrUnsupportedFormat, err) || strings.Contains(err.Error(), "failed to load model") {
  411. err = fmt.Errorf("%v: this model may be incompatible with your version of Ollama. If you previously pulled this model, try updating it by running `ollama pull %s`", err, req.model.ShortName)
  412. }
  413. slog.Info("NewLlamaServer failed", "model", req.model.ModelPath, "error", err)
  414. req.errCh <- err
  415. return
  416. }
  417. runner := &runnerRef{
  418. model: req.model,
  419. modelPath: req.model.ModelPath,
  420. llama: llama,
  421. Options: &req.opts,
  422. sessionDuration: sessionDuration,
  423. gpus: gpus,
  424. estimatedVRAM: llama.EstimatedVRAM(),
  425. estimatedTotal: llama.EstimatedTotal(),
  426. loading: true,
  427. refCount: 1,
  428. }
  429. runner.numParallel = numParallel
  430. runner.refMu.Lock()
  431. s.loadedMu.Lock()
  432. s.loaded[req.model.ModelPath] = runner
  433. slog.Info("loaded runners", "count", len(s.loaded))
  434. s.loadedMu.Unlock()
  435. go func() {
  436. defer runner.refMu.Unlock()
  437. if err = llama.WaitUntilRunning(req.ctx); err != nil {
  438. slog.Error("error loading llama server", "error", err)
  439. runner.refCount--
  440. req.errCh <- err
  441. slog.Debug("triggering expiration for failed load", "model", runner.modelPath)
  442. s.expiredCh <- runner
  443. return
  444. }
  445. slog.Debug("finished setting up runner", "model", req.model.ModelPath)
  446. runner.loading = false
  447. go func() {
  448. <-req.ctx.Done()
  449. slog.Debug("context for request finished")
  450. s.finishedReqCh <- req
  451. }()
  452. req.successCh <- runner
  453. }()
  454. }
  455. func (s *Scheduler) updateFreeSpace(allGpus gpu.GpuInfoList) {
  456. type predKey struct {
  457. Library string
  458. ID string
  459. }
  460. predMap := map[predKey]uint64{} // Sum up the total predicted usage per GPU for all runners
  461. s.loadedMu.Lock()
  462. for _, r := range s.loaded {
  463. r.refMu.Lock()
  464. if r.llama != nil {
  465. for _, gpu := range allGpus {
  466. predMap[predKey{gpu.Library, gpu.ID}] += r.llama.EstimatedVRAMByGPU(gpu.ID)
  467. }
  468. } else {
  469. slog.Warn("unexpected nil runner reference, memory prediction may be incorrect")
  470. }
  471. r.refMu.Unlock()
  472. }
  473. s.loadedMu.Unlock()
  474. // Now that we've summed up all the GPU usage predictions across all the loaded runners, update the gpu list
  475. for i := range allGpus {
  476. if p, ok := predMap[predKey{allGpus[i].Library, allGpus[i].ID}]; ok {
  477. slog.Debug("gpu reported", "gpu", allGpus[i].ID, "library", allGpus[i].Library, "available", format.HumanBytes2(allGpus[i].FreeMemory))
  478. if p > allGpus[i].TotalMemory {
  479. // Shouldn't happen
  480. slog.Warn("predicted usage exceeds VRAM", "gpu", allGpus[i].ID, "totalMemory", allGpus[i].TotalMemory, "predicted", p)
  481. allGpus[i].FreeMemory = 0
  482. } else if (allGpus[i].TotalMemory - p) < allGpus[i].FreeMemory { // predicted free is smaller than reported free, use it
  483. // TODO maybe we should just always trust our numbers, since cuda's free memory reporting is laggy
  484. // and we might unload models we didn't actually need to. The risk is if some other GPU intensive app is loaded
  485. // after we start our first runner, then we'll never acount for that, so picking the smallest free value seems prudent.
  486. allGpus[i].FreeMemory = allGpus[i].TotalMemory - p
  487. }
  488. slog.Info("updated VRAM based on existing loaded models", "gpu", allGpus[i].ID, "library", allGpus[i].Library, "total", format.HumanBytes2(allGpus[i].TotalMemory), "available", format.HumanBytes2(allGpus[i].FreeMemory))
  489. }
  490. }
  491. }
  492. // While models are loading the VRAM consumption numbers will be indeterminate, so we have
  493. // to avoid scheduling another model on the same GPU(s) that haven't stabilized.
  494. // This routine returns the set of GPUs that do not have an active loading model.
  495. // If all GPUs have loading models, an empty list will be returned (not a single CPU entry)
  496. func (s *Scheduler) filterGPUsWithoutLoadingModels(allGpus gpu.GpuInfoList) gpu.GpuInfoList {
  497. ret := append(gpu.GpuInfoList{}, allGpus...)
  498. s.loadedMu.Lock()
  499. defer s.loadedMu.Unlock()
  500. for _, runner := range s.loaded {
  501. if runner.loading {
  502. slog.Debug("overlapping loads detected", "gpus", runner.gpus, "model", runner.modelPath)
  503. for _, busyGPU := range runner.gpus {
  504. for i := range ret {
  505. if ret[i].ID == busyGPU.ID {
  506. ret = append(ret[:i], ret[i+1:]...)
  507. break
  508. }
  509. }
  510. }
  511. }
  512. }
  513. return ret
  514. }
  515. // TODO consolidate sched_types.go
  516. type runnerRef struct {
  517. refMu sync.Mutex
  518. // refCond sync.Cond // Signaled on transition from 1 -> 0 refCount
  519. refCount uint // prevent unloading if > 0
  520. // unloading bool // set to true when we are trying to unload the runner
  521. llama llm.LlamaServer
  522. loading bool // True only during initial load, then false forever
  523. gpus gpu.GpuInfoList // Recorded at time of provisioning
  524. estimatedVRAM uint64
  525. estimatedTotal uint64
  526. sessionDuration time.Duration
  527. expireTimer *time.Timer
  528. expiresAt time.Time
  529. model *Model
  530. modelPath string
  531. numParallel int
  532. *api.Options
  533. }
  534. // The refMu must already be held when calling unload
  535. func (runner *runnerRef) unload() {
  536. if runner.expireTimer != nil {
  537. runner.expireTimer.Stop()
  538. runner.expireTimer = nil
  539. }
  540. if runner.llama != nil {
  541. runner.llama.Close()
  542. }
  543. runner.model = nil
  544. runner.llama = nil
  545. runner.Options = nil
  546. runner.gpus = nil
  547. }
  548. func (runner *runnerRef) needsReload(ctx context.Context, req *LlmRequest) bool {
  549. slog.Debug("evaluating already loaded", "model", req.model.ModelPath)
  550. runner.refMu.Lock()
  551. defer runner.refMu.Unlock()
  552. timeout := 10 * time.Second
  553. if runner.loading {
  554. timeout = 2 * time.Minute // Initial load can take a long time for big models on slow systems...
  555. }
  556. if runner.Options == nil {
  557. return true
  558. }
  559. // Don't reload runner if num_gpu=-1 was provided
  560. optsExisting := runner.Options.Runner
  561. optsNew := req.opts.Runner
  562. if optsNew.NumGPU < 0 {
  563. optsExisting.NumGPU = -1
  564. optsNew.NumGPU = -1
  565. }
  566. // Normalize the NumCtx for parallelism
  567. optsExisting.NumCtx = optsExisting.NumCtx / runner.numParallel
  568. ctx, cancel := context.WithTimeout(ctx, timeout)
  569. defer cancel()
  570. if !reflect.DeepEqual(runner.model.AdapterPaths, req.model.AdapterPaths) || // have the adapters changed?
  571. !reflect.DeepEqual(runner.model.ProjectorPaths, req.model.ProjectorPaths) || // have the projectors changed?
  572. !reflect.DeepEqual(optsExisting, optsNew) || // have the runner options changed?
  573. runner.llama.Ping(ctx) != nil {
  574. return true
  575. }
  576. return false
  577. }
  578. // Free memory reporting on GPUs can lag for a while even after the runner
  579. // exits, so we have to keep checking until we see the available memory recover,
  580. // otherwise subsequent model loads will get far less layers loaded or worse
  581. // case, may completely fall back to CPU mode.
  582. // This routine must be called before the runner unloads so it can establish
  583. // a before and after GPU memory allocation. The returned channel
  584. // will be notified when we're done waiting, or have timed out and should
  585. // proceed anyway
  586. func (runner *runnerRef) waitForVRAMRecovery() chan interface{} {
  587. finished := make(chan interface{}, 1)
  588. // CPU or Metal don't need checking, so no waiting required
  589. // windows can page VRAM, only cuda currently can report accurate used vram usage
  590. if len(runner.gpus) == 0 ||
  591. (len(runner.gpus) == 1 && (runner.gpus[0].Library == "cpu" || runner.gpus[0].Library == "metal")) ||
  592. (runtime.GOOS == "windows" && runner.gpus[0].Library != "cuda") {
  593. finished <- struct{}{}
  594. return finished
  595. }
  596. start := time.Now()
  597. // Establish a baseline before we unload
  598. gpusBefore := gpu.GetGPUInfo()
  599. var totalMemoryBefore, freeMemoryBefore uint64
  600. for _, gpu := range gpusBefore {
  601. totalMemoryBefore += gpu.TotalMemory
  602. freeMemoryBefore += gpu.FreeMemory
  603. }
  604. go func() {
  605. expiresAt := start.Add(5 * time.Second) // typical convergence is 0.5-1.5s
  606. ticker := time.NewTicker(250 * time.Millisecond)
  607. defer ticker.Stop()
  608. for {
  609. <-ticker.C
  610. if time.Now().After(expiresAt) {
  611. slog.Warn("gpu VRAM usage didn't recover within timeout", "seconds", time.Since(start).Seconds(), "model", runner.modelPath)
  612. finished <- struct{}{}
  613. }
  614. // Query GPUs, look for free to go back up
  615. gpusNow := gpu.GetGPUInfo()
  616. var totalMemoryNow, freeMemoryNow uint64
  617. for _, gpu := range gpusNow {
  618. totalMemoryNow += gpu.TotalMemory
  619. freeMemoryNow += gpu.FreeMemory
  620. }
  621. // If we're within ~80% of the estimated memory usage recovered, bail out
  622. if float32(freeMemoryNow-freeMemoryBefore) > float32(runner.estimatedVRAM)*0.8 {
  623. slog.Debug(fmt.Sprintf("gpu VRAM free memory converged after %0.2f seconds", time.Since(start).Seconds()), "model", runner.modelPath)
  624. finished <- struct{}{}
  625. return
  626. }
  627. }
  628. }()
  629. return finished
  630. }
  631. type ByDuration []*runnerRef
  632. func (a ByDuration) Len() int { return len(a) }
  633. func (a ByDuration) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
  634. func (a ByDuration) Less(i, j int) bool {
  635. // uint64 to turn negative time (never unload) to largest
  636. return uint64(a[i].sessionDuration) < uint64(a[j].sessionDuration)
  637. }
  638. // TODO - future consideration to pick runners based on size
  639. // type BySize []*runnerRef
  640. // func (a BySize) Len() int { return len(a) }
  641. // func (a BySize) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
  642. // func (a BySize) Less(i, j int) bool { return a[i].estimatedVRAM < a[j].estimatedVRAM }
  643. // pickBestFitGPUs will try to find the optimal placement of the model in the available GPUs where the model fully fits
  644. // If the model can not be fit fully within the available GPU(s) nil is returned
  645. // If numParallel is <= 0, this will attempt try to optimize parallism based on available VRAM, and adjust
  646. // opts.NumCtx accordingly
  647. func pickBestFitGPUs(req *LlmRequest, ggml *llm.GGML, gpus gpu.GpuInfoList, numParallel *int) gpu.GpuInfoList {
  648. var estimatedVRAM uint64
  649. var numParallelToTry []int
  650. if *numParallel <= 0 {
  651. // If no specific parallel setting was provided, try larger then smaller, always end with 1
  652. numParallelToTry = append(numParallelToTry, defaultParallel, 1)
  653. } else {
  654. numParallelToTry = []int{*numParallel}
  655. }
  656. for _, gl := range gpus.ByLibrary() {
  657. var ok bool
  658. sgl := append(make(gpu.GpuInfoList, 0, len(gl)), gl...)
  659. // TODO - potentially sort by performance capability, existing models loaded, etc.
  660. // TODO - Eliminate any GPUs that already have envconfig.MaxRunners loaded on them
  661. // Note: at present, this will favor more VRAM over faster GPU speed in mixed setups
  662. sort.Sort(sort.Reverse(gpu.ByFreeMemory(sgl)))
  663. // First attempt to fit the model into a single GPU
  664. for _, p := range numParallelToTry {
  665. req.opts.NumCtx = req.origNumCtx * p
  666. if !envconfig.SchedSpread {
  667. for _, g := range sgl {
  668. if ok, estimatedVRAM = llm.PredictServerFit([]gpu.GpuInfo{g}, ggml, req.model.AdapterPaths, req.model.ProjectorPaths, req.opts); ok {
  669. slog.Info("new model will fit in available VRAM in single GPU, loading", "model", req.model.ModelPath, "gpu", g.ID, "parallel", p, "available", g.FreeMemory, "required", format.HumanBytes2(estimatedVRAM))
  670. *numParallel = p
  671. return []gpu.GpuInfo{g}
  672. }
  673. }
  674. }
  675. }
  676. // TODO future refinements
  677. // - if multiple Libraries, see if any single GPU in any Library will fit
  678. // - try subsets of GPUs instead of just falling back to 1 or all in a family
  679. // Now try all the GPUs
  680. for _, p := range numParallelToTry {
  681. req.opts.NumCtx = req.origNumCtx * p
  682. if ok, estimatedVRAM = llm.PredictServerFit(sgl, ggml, req.model.AdapterPaths, req.model.ProjectorPaths, req.opts); ok {
  683. slog.Info("new model will fit in available VRAM, loading", "model", req.model.ModelPath, "library", sgl[0].Library, "parallel", p, "required", format.HumanBytes2(estimatedVRAM))
  684. *numParallel = p
  685. return sgl
  686. }
  687. }
  688. }
  689. return nil
  690. }
  691. // findRunnerToUnload finds a runner to unload to make room for a new model
  692. func (s *Scheduler) findRunnerToUnload() *runnerRef {
  693. s.loadedMu.Lock()
  694. runnerList := make([]*runnerRef, 0, len(s.loaded))
  695. for _, r := range s.loaded {
  696. runnerList = append(runnerList, r)
  697. }
  698. s.loadedMu.Unlock()
  699. if len(runnerList) == 0 {
  700. slog.Debug("no loaded runner to unload")
  701. return nil
  702. }
  703. // In the future we can enhance the algorithm to be smarter about picking the optimal runner to unload
  704. // e.g., if we have multiple options, will one make room for the request?
  705. sort.Sort(ByDuration(runnerList))
  706. // First try to find a runner that's already idle
  707. for _, runner := range runnerList {
  708. runner.refMu.Lock()
  709. rc := runner.refCount
  710. runner.refMu.Unlock()
  711. if rc == 0 {
  712. slog.Debug("found an idle runner to unload")
  713. return runner
  714. }
  715. }
  716. // None appear idle, just wait for the one with the shortest duration
  717. slog.Debug("no idle runners, picking the shortest duration", "count", len(runnerList))
  718. return runnerList[0]
  719. }
  720. func (s *Scheduler) unloadAllRunners() {
  721. s.loadedMu.Lock()
  722. defer s.loadedMu.Unlock()
  723. for model, runner := range s.loaded {
  724. if runner.llama != nil {
  725. slog.Debug("shutting down runner", "model", model)
  726. runner.llama.Close()
  727. }
  728. }
  729. }
  730. // If other runners are loaded, make sure the pending request will fit in system memory
  731. // If not, pick a runner to unload, else return nil and the request can be loaded
  732. func (s *Scheduler) maybeFindCPURunnerToUnload(req *LlmRequest, ggml *llm.GGML, gpus gpu.GpuInfoList) *runnerRef {
  733. slog.Debug("evaluating if CPU model load will fit in available system memory")
  734. estimate := llm.EstimateGPULayers(gpus, ggml, req.model.ProjectorPaths, req.opts)
  735. if estimate.TotalSize <= gpus[0].FreeMemory {
  736. slog.Debug("cpu inference mode, model fits in available system memory", "model", format.HumanBytes2(estimate.TotalSize), "available", format.HumanBytes2(gpus[0].FreeMemory))
  737. return nil
  738. }
  739. // TODO - optimization: try to find CPU only runners first, or partial offloads with enough in system memory to make room
  740. return s.findRunnerToUnload()
  741. }