llama-server.go 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057
  1. package runners
  2. import (
  3. "bufio"
  4. "bytes"
  5. "context"
  6. "encoding/json"
  7. "errors"
  8. "fmt"
  9. "io"
  10. "log"
  11. "log/slog"
  12. "math/rand"
  13. "net"
  14. "net/http"
  15. "os"
  16. "os/exec"
  17. "path/filepath"
  18. "runtime"
  19. "strconv"
  20. "strings"
  21. "sync"
  22. "time"
  23. "golang.org/x/sync/semaphore"
  24. "github.com/ollama/ollama/api"
  25. "github.com/ollama/ollama/build"
  26. "github.com/ollama/ollama/discover"
  27. "github.com/ollama/ollama/envconfig"
  28. "github.com/ollama/ollama/fileutils"
  29. "github.com/ollama/ollama/format"
  30. "github.com/ollama/ollama/llama"
  31. )
  32. // llmServer is an instance of the llama.cpp server
  33. type llmServer struct {
  34. port int
  35. cmd *exec.Cmd
  36. done chan error // Channel to signal when the process exits
  37. status *StatusWriter
  38. options api.Options
  39. numParallel int
  40. modelPath string
  41. modelLock sync.Mutex // Temporary until we switch fully to Go server
  42. model *llama.Model // If non-nil, the runner is a new Go server
  43. estimate fileutils.MemoryEstimate
  44. totalLayers uint64
  45. // gpuCount int
  46. gpus discover.GpuInfoList // Recorded just before the model loaded, free space will be incorrect
  47. loadDuration time.Duration // Record how long it took the model to load
  48. loadProgress float32
  49. sem *semaphore.Weighted
  50. }
  51. // NewLlamaServer will run a server for the given GPUs
  52. // The gpu list must be a single family.
  53. func NewLlamaServer(gpus discover.GpuInfoList, model string, ggml *fileutils.GGML, adapters, projectors []string, opts api.Options, numParallel int) (LLMServer, error) {
  54. var err error
  55. var cpuRunner string
  56. var estimate fileutils.MemoryEstimate
  57. var systemTotalMemory uint64
  58. var systemFreeMemory uint64
  59. var systemSwapFreeMemory uint64
  60. systemInfo := discover.GetSystemInfo()
  61. systemTotalMemory = systemInfo.System.TotalMemory
  62. systemFreeMemory = systemInfo.System.FreeMemory
  63. systemSwapFreeMemory = systemInfo.System.FreeSwap
  64. slog.Info("system memory", "total", format.HumanBytes2(systemTotalMemory), "free", format.HumanBytes2(systemFreeMemory), "free_swap", format.HumanBytes2(systemSwapFreeMemory))
  65. // If the user wants zero GPU layers, reset the gpu list to be CPU/system ram info
  66. if opts.NumGPU == 0 {
  67. gpus = discover.GetCPUInfo()
  68. }
  69. if len(gpus) == 1 && gpus[0].Library == "cpu" {
  70. cpuRunner = ServerForCpu()
  71. estimate = fileutils.EstimateGPULayers(gpus, ggml, projectors, opts)
  72. } else {
  73. estimate = fileutils.EstimateGPULayers(gpus, ggml, projectors, opts)
  74. switch {
  75. case gpus[0].Library == "metal" && estimate.VRAMSize > systemTotalMemory:
  76. // disable partial offloading when model is greater than total system memory as this
  77. // can lead to locking up the system
  78. opts.NumGPU = 0
  79. case gpus[0].Library != "metal" && estimate.Layers == 0:
  80. // Don't bother loading into the GPU if no layers can fit
  81. cpuRunner = ServerForCpu()
  82. gpus = discover.GetCPUInfo()
  83. case opts.NumGPU < 0 && estimate.Layers > 0 && gpus[0].Library != "cpu":
  84. opts.NumGPU = estimate.Layers
  85. }
  86. }
  87. // On linux and windows, over-allocating CPU memory will almost always result in an error
  88. // Darwin has fully dynamic swap so has no direct concept of free swap space
  89. if runtime.GOOS != "darwin" {
  90. systemMemoryRequired := estimate.TotalSize - estimate.VRAMSize
  91. available := systemFreeMemory + systemSwapFreeMemory
  92. if systemMemoryRequired > available {
  93. slog.Warn("model request too large for system", "requested", format.HumanBytes2(systemMemoryRequired), "available", available, "total", format.HumanBytes2(systemTotalMemory), "free", format.HumanBytes2(systemFreeMemory), "swap", format.HumanBytes2(systemSwapFreeMemory))
  94. return nil, fmt.Errorf("model requires more system memory (%s) than is available (%s)", format.HumanBytes2(systemMemoryRequired), format.HumanBytes2(available))
  95. }
  96. }
  97. estimate.Log()
  98. // Loop through potential servers
  99. finalErr := errors.New("no suitable llama servers found")
  100. if len(adapters) > 1 {
  101. return nil, errors.New("ollama supports only one lora adapter, but multiple were provided")
  102. }
  103. rDir, err := Refresh(build.EmbedFS)
  104. if err != nil {
  105. return nil, err
  106. }
  107. availableServers := GetAvailableServers(rDir)
  108. if len(availableServers) == 0 {
  109. return nil, finalErr
  110. }
  111. var servers []string
  112. if cpuRunner != "" {
  113. servers = []string{cpuRunner}
  114. } else {
  115. servers = ServersForGpu(gpus[0]) // All GPUs in the list are matching Library and Variant
  116. }
  117. demandLib := envconfig.LLMLibrary()
  118. if demandLib != "" {
  119. serverPath := availableServers[demandLib]
  120. if serverPath == "" {
  121. slog.Info(fmt.Sprintf("Invalid OLLAMA_LLM_LIBRARY %s - not found", demandLib))
  122. } else {
  123. slog.Info("user override", "OLLAMA_LLM_LIBRARY", demandLib, "path", serverPath)
  124. servers = []string{demandLib}
  125. if strings.HasPrefix(demandLib, "cpu") {
  126. // Omit the GPU flag to silence the warning
  127. opts.NumGPU = -1
  128. }
  129. }
  130. }
  131. if len(servers) == 0 {
  132. return nil, fmt.Errorf("no servers found for %v", gpus)
  133. }
  134. params := []string{
  135. "--model", model,
  136. "--ctx-size", strconv.Itoa(opts.NumCtx),
  137. "--batch-size", strconv.Itoa(opts.NumBatch),
  138. "--embedding",
  139. }
  140. if opts.NumGPU >= 0 {
  141. params = append(params, "--n-gpu-layers", strconv.Itoa(opts.NumGPU))
  142. }
  143. if envconfig.Debug() {
  144. params = append(params, "--verbose")
  145. }
  146. if opts.MainGPU > 0 {
  147. params = append(params, "--main-gpu", strconv.Itoa(opts.MainGPU))
  148. }
  149. if len(adapters) > 0 {
  150. // TODO: applying multiple adapters is not supported by the llama.cpp server yet
  151. params = append(params, "--lora", adapters[0])
  152. }
  153. if len(projectors) > 0 {
  154. // TODO: applying multiple projectors is not supported by the llama.cpp server yet
  155. params = append(params, "--mmproj", projectors[0])
  156. }
  157. defaultThreads := systemInfo.GetOptimalThreadCount()
  158. if opts.NumThread > 0 {
  159. params = append(params, "--threads", strconv.Itoa(opts.NumThread))
  160. } else if defaultThreads > 0 {
  161. params = append(params, "--threads", strconv.Itoa(defaultThreads))
  162. }
  163. if !opts.F16KV {
  164. params = append(params, "--memory-f32")
  165. }
  166. flashAttnEnabled := envconfig.FlashAttention()
  167. for _, g := range gpus {
  168. // only cuda (compute capability 7+) and metal support flash attention
  169. if g.Library != "metal" && (g.Library != "cuda" || g.DriverMajor < 7) {
  170. flashAttnEnabled = false
  171. }
  172. // mmap has issues with partial offloading on metal
  173. if g.Library == "metal" &&
  174. uint64(opts.NumGPU) > 0 &&
  175. uint64(opts.NumGPU) < ggml.KV().BlockCount()+1 {
  176. opts.UseMMap = new(bool)
  177. *opts.UseMMap = false
  178. }
  179. }
  180. if flashAttnEnabled {
  181. params = append(params, "--flash-attn")
  182. }
  183. // Windows CUDA should not use mmap for best performance
  184. // Linux with a model larger than free space, mmap leads to thrashing
  185. // For CPU loads we want the memory to be allocated, not FS cache
  186. if (runtime.GOOS == "windows" && gpus[0].Library == "cuda" && opts.UseMMap == nil) ||
  187. (runtime.GOOS == "linux" && systemFreeMemory < estimate.TotalSize && opts.UseMMap == nil) ||
  188. (gpus[0].Library == "cpu" && opts.UseMMap == nil) ||
  189. (opts.UseMMap != nil && !*opts.UseMMap) {
  190. params = append(params, "--no-mmap")
  191. }
  192. if opts.UseMLock {
  193. params = append(params, "--mlock")
  194. }
  195. // TODO - NUMA support currently doesn't work properly
  196. params = append(params, "--parallel", strconv.Itoa(numParallel))
  197. if estimate.TensorSplit != "" {
  198. params = append(params, "--tensor-split", estimate.TensorSplit)
  199. }
  200. if envconfig.MultiUserCache() {
  201. params = append(params, "--multiuser-cache")
  202. }
  203. for i := range servers {
  204. dir := availableServers[servers[i]]
  205. if dir == "" {
  206. // Shouldn't happen
  207. finalErr = fmt.Errorf("[%d] server %s not listed in available servers %v", i, servers[i], availableServers)
  208. slog.Error("server list inconsistent", "error", finalErr)
  209. continue
  210. }
  211. if strings.HasPrefix(servers[i], "cpu") {
  212. gpus = discover.GetCPUInfo()
  213. }
  214. // Find an availableServers port, retry on each iteration in case the failure was a port conflict race
  215. port := 0
  216. if a, err := net.ResolveTCPAddr("tcp", "localhost:0"); err == nil {
  217. var l *net.TCPListener
  218. if l, err = net.ListenTCP("tcp", a); err == nil {
  219. port = l.Addr().(*net.TCPAddr).Port
  220. l.Close()
  221. }
  222. }
  223. if port == 0 {
  224. slog.Debug("ResolveTCPAddr failed ", "error", err)
  225. port = rand.Intn(65535-49152) + 49152 // get a random port in the ephemeral range
  226. }
  227. finalParams := append(params, "--port", strconv.Itoa(port))
  228. pathEnv := "LD_LIBRARY_PATH"
  229. if runtime.GOOS == "windows" {
  230. pathEnv = "PATH"
  231. }
  232. // Start with the server directory for the LD_LIBRARY_PATH/PATH
  233. libraryPaths := []string{dir}
  234. if libraryPath, ok := os.LookupEnv(pathEnv); ok {
  235. // favor our bundled library dependencies over system libraries
  236. libraryPaths = append(libraryPaths, filepath.SplitList(libraryPath)...)
  237. }
  238. // Note: we always put the dependency path first
  239. // since this was the exact version we compiled/linked against
  240. if gpus[0].DependencyPath != "" {
  241. // assume gpus from the same library have the same dependency path
  242. libraryPaths = append([]string{gpus[0].DependencyPath}, libraryPaths...)
  243. }
  244. server := filepath.Join(dir, "ollama_llama_server")
  245. if runtime.GOOS == "windows" {
  246. server += ".exe"
  247. }
  248. // Detect tmp cleaners wiping out the file
  249. _, err := os.Stat(server)
  250. if errors.Is(err, os.ErrNotExist) {
  251. slog.Warn("llama server disappeared, reinitializing payloads", "path", server, "error", err)
  252. _, err = Refresh(build.EmbedFS)
  253. if err != nil {
  254. slog.Warn("failed to reinitialize payloads", "error", err)
  255. return nil, err
  256. }
  257. }
  258. // TODO - once fully switched to the Go runner, load the model here for tokenize/detokenize cgo access
  259. s := &llmServer{
  260. port: port,
  261. cmd: exec.Command(server, finalParams...),
  262. status: NewStatusWriter(os.Stderr),
  263. options: opts,
  264. modelPath: model,
  265. estimate: estimate,
  266. numParallel: numParallel,
  267. sem: semaphore.NewWeighted(int64(numParallel)),
  268. totalLayers: ggml.KV().BlockCount() + 1,
  269. gpus: gpus,
  270. done: make(chan error, 1),
  271. }
  272. s.cmd.Env = os.Environ()
  273. s.cmd.Stdout = os.Stdout
  274. s.cmd.Stderr = s.status
  275. s.cmd.SysProcAttr = LlamaServerSysProcAttr
  276. envWorkarounds := [][2]string{}
  277. for _, gpu := range gpus {
  278. envWorkarounds = append(envWorkarounds, gpu.EnvWorkarounds...)
  279. }
  280. visibleDevicesEnv, visibleDevicesEnvVal := gpus.GetVisibleDevicesEnv()
  281. pathEnvVal := strings.Join(libraryPaths, string(filepath.ListSeparator))
  282. // Update or add the path and visible devices variable with our adjusted version
  283. pathNeeded := true
  284. devicesNeeded := visibleDevicesEnv != ""
  285. for i := range s.cmd.Env {
  286. cmp := strings.SplitN(s.cmd.Env[i], "=", 2)
  287. if strings.EqualFold(cmp[0], pathEnv) {
  288. s.cmd.Env[i] = pathEnv + "=" + pathEnvVal
  289. pathNeeded = false
  290. } else if devicesNeeded && strings.EqualFold(cmp[0], visibleDevicesEnv) {
  291. s.cmd.Env[i] = visibleDevicesEnv + "=" + visibleDevicesEnvVal
  292. devicesNeeded = false
  293. } else if len(envWorkarounds) != 0 {
  294. for _, kv := range envWorkarounds {
  295. if strings.EqualFold(cmp[0], kv[0]) {
  296. s.cmd.Env[i] = kv[0] + "=" + kv[1]
  297. }
  298. }
  299. }
  300. }
  301. if pathNeeded {
  302. s.cmd.Env = append(s.cmd.Env, pathEnv+"="+pathEnvVal)
  303. }
  304. if devicesNeeded {
  305. s.cmd.Env = append(s.cmd.Env, visibleDevicesEnv+"="+visibleDevicesEnvVal)
  306. }
  307. slog.Info("starting llama server", "cmd", s.cmd.String())
  308. if envconfig.Debug() {
  309. filteredEnv := []string{}
  310. for _, ev := range s.cmd.Env {
  311. if strings.HasPrefix(ev, "CUDA_") ||
  312. strings.HasPrefix(ev, "ROCR_") ||
  313. strings.HasPrefix(ev, "ROCM_") ||
  314. strings.HasPrefix(ev, "HIP_") ||
  315. strings.HasPrefix(ev, "GPU_") ||
  316. strings.HasPrefix(ev, "HSA_") ||
  317. strings.HasPrefix(ev, "GGML_") ||
  318. strings.HasPrefix(ev, "PATH=") ||
  319. strings.HasPrefix(ev, "LD_LIBRARY_PATH=") {
  320. filteredEnv = append(filteredEnv, ev)
  321. }
  322. }
  323. // Log at debug as the environment is inherited and might contain sensitive information
  324. slog.Debug("subprocess", "environment", filteredEnv)
  325. }
  326. if err = s.cmd.Start(); err != nil {
  327. // Detect permission denied and augment the message about noexec
  328. if errors.Is(err, os.ErrPermission) {
  329. finalErr = fmt.Errorf("unable to start server %w. %s may have noexec set. Set OLLAMA_TMPDIR for server to a writable executable directory", err, dir)
  330. continue
  331. }
  332. msg := ""
  333. if s.status != nil && s.status.LastErrMsg != "" {
  334. msg = s.status.LastErrMsg
  335. }
  336. err = fmt.Errorf("error starting the external llama server: %v %s", err, msg)
  337. finalErr = err
  338. continue
  339. }
  340. // reap subprocess when it exits
  341. go func() {
  342. err := s.cmd.Wait()
  343. // Favor a more detailed message over the process exit status
  344. if err != nil && s.status != nil && s.status.LastErrMsg != "" {
  345. slog.Debug("llama runner terminated", "error", err)
  346. if strings.Contains(s.status.LastErrMsg, "unknown model") {
  347. s.status.LastErrMsg = "this model is not supported by your version of Ollama. You may need to upgrade"
  348. }
  349. s.done <- errors.New(s.status.LastErrMsg)
  350. } else {
  351. s.done <- err
  352. }
  353. }()
  354. return s, nil
  355. }
  356. slog.Error("unable to load any llama server", "error", finalErr)
  357. return nil, finalErr
  358. }
  359. type ServerStatus int
  360. const ( // iota is reset to 0
  361. ServerStatusReady ServerStatus = iota
  362. ServerStatusNoSlotsAvailable
  363. ServerStatusLoadingModel
  364. ServerStatusNotResponding
  365. ServerStatusError
  366. )
  367. func (s ServerStatus) ToString() string {
  368. switch s {
  369. case ServerStatusReady:
  370. return "llm server ready"
  371. case ServerStatusNoSlotsAvailable:
  372. return "llm busy - no slots available"
  373. case ServerStatusLoadingModel:
  374. return "llm server loading model"
  375. case ServerStatusNotResponding:
  376. return "llm server not responding"
  377. default:
  378. return "llm server error"
  379. }
  380. }
  381. type ServerStatusResp struct {
  382. Status string `json:"status"`
  383. SlotsIdle int `json:"slots_idle"`
  384. SlotsProcessing int `json:"slots_processing"`
  385. Error string `json:"error"`
  386. Progress float32 `json:"progress"`
  387. }
  388. func (s *llmServer) getServerStatus(ctx context.Context) (ServerStatus, error) {
  389. // Fail fast if its exited
  390. if s.cmd.ProcessState != nil {
  391. msg := ""
  392. if s.status != nil && s.status.LastErrMsg != "" {
  393. msg = s.status.LastErrMsg
  394. }
  395. if s.cmd.ProcessState.ExitCode() == -1 {
  396. // Most likely a signal killed it, log some more details to try to help troubleshoot
  397. slog.Warn("llama runner process no longer running", "sys", s.cmd.ProcessState.Sys(), "string", s.cmd.ProcessState.String())
  398. }
  399. return ServerStatusError, fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
  400. }
  401. req, err := http.NewRequestWithContext(ctx, http.MethodGet, fmt.Sprintf("http://127.0.0.1:%d/health", s.port), nil)
  402. if err != nil {
  403. return ServerStatusError, fmt.Errorf("error creating GET request: %v", err)
  404. }
  405. req.Header.Set("Content-Type", "application/json")
  406. resp, err := http.DefaultClient.Do(req)
  407. if err != nil {
  408. if errors.Is(err, context.DeadlineExceeded) {
  409. return ServerStatusNotResponding, errors.New("server not responding")
  410. }
  411. return ServerStatusError, fmt.Errorf("health resp: %w", err)
  412. }
  413. defer resp.Body.Close()
  414. body, err := io.ReadAll(resp.Body)
  415. if err != nil {
  416. return ServerStatusError, fmt.Errorf("read health request: %w", err)
  417. }
  418. var status ServerStatusResp
  419. if err := json.Unmarshal(body, &status); err != nil {
  420. return ServerStatusError, fmt.Errorf("health unmarshal encode response: %w", err)
  421. }
  422. switch status.Status {
  423. case "ok":
  424. return ServerStatusReady, nil
  425. case "no slot available":
  426. return ServerStatusNoSlotsAvailable, nil
  427. case "loading model":
  428. s.loadProgress = status.Progress
  429. return ServerStatusLoadingModel, nil
  430. default:
  431. return ServerStatusError, fmt.Errorf("server error: %+v", status)
  432. }
  433. }
  434. // getServerStatusRetry will retry if ServerStatusNoSlotsAvailable is received
  435. func (s *llmServer) getServerStatusRetry(ctx context.Context) (ServerStatus, error) {
  436. var retries int
  437. for {
  438. status, err := s.getServerStatus(ctx)
  439. if err != nil {
  440. return status, err
  441. }
  442. if status == ServerStatusNoSlotsAvailable {
  443. if retries >= 10 {
  444. return status, fmt.Errorf("no slots available after %d retries", retries)
  445. }
  446. time.Sleep(5 * time.Millisecond)
  447. retries++
  448. continue
  449. }
  450. return status, nil
  451. }
  452. }
  453. func (s *llmServer) Ping(ctx context.Context) error {
  454. _, err := s.getServerStatus(ctx)
  455. if err != nil {
  456. slog.Debug("server unhealthy", "error", err)
  457. return err
  458. }
  459. return nil
  460. }
  461. func (s *llmServer) WaitUntilRunning(ctx context.Context) error {
  462. start := time.Now()
  463. stallDuration := envconfig.LoadTimeout() // If no progress happens
  464. stallTimer := time.Now().Add(stallDuration) // give up if we stall
  465. slog.Info("waiting for llama runner to start responding")
  466. var lastStatus ServerStatus = -1
  467. fullyLoaded := false
  468. for {
  469. select {
  470. case <-ctx.Done():
  471. slog.Warn("client connection closed before server finished loading, aborting load")
  472. return fmt.Errorf("timed out waiting for llama runner to start: %w", ctx.Err())
  473. case err := <-s.done:
  474. return fmt.Errorf("llama runner process has terminated: %w", err)
  475. default:
  476. }
  477. if time.Now().After(stallTimer) {
  478. // timeout
  479. msg := ""
  480. if s.status != nil && s.status.LastErrMsg != "" {
  481. msg = s.status.LastErrMsg
  482. }
  483. return fmt.Errorf("timed out waiting for llama runner to start - progress %0.2f - %s", s.loadProgress, msg)
  484. }
  485. if s.cmd.ProcessState != nil {
  486. msg := ""
  487. if s.status != nil && s.status.LastErrMsg != "" {
  488. msg = s.status.LastErrMsg
  489. }
  490. return fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
  491. }
  492. ctx, cancel := context.WithTimeout(ctx, 200*time.Millisecond)
  493. defer cancel()
  494. priorProgress := s.loadProgress
  495. status, _ := s.getServerStatus(ctx)
  496. if lastStatus != status && status != ServerStatusReady {
  497. // Only log on status changes
  498. slog.Info("waiting for server to become available", "status", status.ToString())
  499. }
  500. switch status {
  501. case ServerStatusReady:
  502. s.loadDuration = time.Since(start)
  503. slog.Info(fmt.Sprintf("llama runner started in %0.2f seconds", s.loadDuration.Seconds()))
  504. return nil
  505. default:
  506. lastStatus = status
  507. // Reset the timer as long as we're making forward progress on the load
  508. if priorProgress != s.loadProgress {
  509. slog.Debug(fmt.Sprintf("model load progress %0.2f", s.loadProgress))
  510. stallTimer = time.Now().Add(stallDuration)
  511. } else if !fullyLoaded && int(s.loadProgress*100.0) >= 100 {
  512. slog.Debug("model load completed, waiting for server to become available", "status", status.ToString())
  513. stallTimer = time.Now().Add(stallDuration)
  514. fullyLoaded = true
  515. }
  516. time.Sleep(time.Millisecond * 250)
  517. continue
  518. }
  519. }
  520. }
  521. const jsonGrammar = `
  522. root ::= object
  523. value ::= object | array | string | number | ("true" | "false" | "null") ws
  524. object ::=
  525. "{" ws (
  526. string ":" ws value
  527. ("," ws string ":" ws value)*
  528. )? "}" ws
  529. array ::=
  530. "[" ws (
  531. value
  532. ("," ws value)*
  533. )? "]" ws
  534. string ::=
  535. "\"" (
  536. [^"\\\x7F\x00-\x1F] |
  537. "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F]) # escapes
  538. )* "\"" ws
  539. number ::= ("-"? ([0-9] | [1-9] [0-9]*)) ("." [0-9]+)? ([eE] [-+]? [0-9]+)? ws
  540. # Optional space: by convention, applied in this grammar after literal chars when allowed
  541. ws ::= ([ \t\n] ws)?
  542. `
  543. const maxBufferSize = 512 * format.KiloByte
  544. type ImageData struct {
  545. Data []byte `json:"data"`
  546. ID int `json:"id"`
  547. AspectRatioID int `json:"aspect_ratio_id"`
  548. }
  549. type completion struct {
  550. Content string `json:"content"`
  551. Model string `json:"model"`
  552. Prompt string `json:"prompt"`
  553. Stop bool `json:"stop"`
  554. StoppedLimit bool `json:"stopped_limit"`
  555. Timings struct {
  556. PredictedN int `json:"predicted_n"`
  557. PredictedMS float64 `json:"predicted_ms"`
  558. PromptN int `json:"prompt_n"`
  559. PromptMS float64 `json:"prompt_ms"`
  560. }
  561. }
  562. func (s *llmServer) Completion(ctx context.Context, req CompletionRequest, fn func(CompletionResponse)) error {
  563. if err := s.sem.Acquire(ctx, 1); err != nil {
  564. slog.Error("Failed to acquire semaphore", "error", err)
  565. return err
  566. }
  567. defer s.sem.Release(1)
  568. // put an upper limit on num_predict to avoid the model running on forever
  569. if req.Options.NumPredict < 0 || req.Options.NumPredict > 10*s.options.NumCtx {
  570. req.Options.NumPredict = 10 * s.options.NumCtx
  571. }
  572. request := map[string]any{
  573. "prompt": req.Prompt,
  574. "stream": true,
  575. "n_predict": req.Options.NumPredict,
  576. "n_keep": req.Options.NumKeep,
  577. "main_gpu": req.Options.MainGPU,
  578. "temperature": req.Options.Temperature,
  579. "top_k": req.Options.TopK,
  580. "top_p": req.Options.TopP,
  581. "min_p": req.Options.MinP,
  582. "tfs_z": req.Options.TFSZ,
  583. "typical_p": req.Options.TypicalP,
  584. "repeat_last_n": req.Options.RepeatLastN,
  585. "repeat_penalty": req.Options.RepeatPenalty,
  586. "presence_penalty": req.Options.PresencePenalty,
  587. "frequency_penalty": req.Options.FrequencyPenalty,
  588. "mirostat": req.Options.Mirostat,
  589. "mirostat_tau": req.Options.MirostatTau,
  590. "mirostat_eta": req.Options.MirostatEta,
  591. "penalize_nl": req.Options.PenalizeNewline,
  592. "seed": req.Options.Seed,
  593. "stop": req.Options.Stop,
  594. "image_data": req.Images,
  595. "cache_prompt": true,
  596. }
  597. // Make sure the server is ready
  598. status, err := s.getServerStatusRetry(ctx)
  599. if err != nil {
  600. return err
  601. } else if status != ServerStatusReady {
  602. return fmt.Errorf("unexpected server status: %s", status.ToString())
  603. }
  604. if req.Format == "json" {
  605. request["grammar"] = jsonGrammar
  606. if !strings.Contains(strings.ToLower(req.Prompt), "json") {
  607. slog.Warn("Prompt does not specify that the LLM should response in JSON, but JSON format is expected. For best results specify that JSON is expected in the system prompt.")
  608. }
  609. }
  610. // Handling JSON marshaling with special characters unescaped.
  611. buffer := &bytes.Buffer{}
  612. enc := json.NewEncoder(buffer)
  613. enc.SetEscapeHTML(false)
  614. if err := enc.Encode(request); err != nil {
  615. return fmt.Errorf("failed to marshal data: %v", err)
  616. }
  617. endpoint := fmt.Sprintf("http://127.0.0.1:%d/completion", s.port)
  618. serverReq, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, buffer)
  619. if err != nil {
  620. return fmt.Errorf("error creating POST request: %v", err)
  621. }
  622. serverReq.Header.Set("Content-Type", "application/json")
  623. res, err := http.DefaultClient.Do(serverReq)
  624. if err != nil {
  625. return fmt.Errorf("POST predict: %v", err)
  626. }
  627. defer res.Body.Close()
  628. if res.StatusCode >= 400 {
  629. bodyBytes, err := io.ReadAll(res.Body)
  630. if err != nil {
  631. return fmt.Errorf("failed reading llm error response: %w", err)
  632. }
  633. log.Printf("llm predict error: %s", bodyBytes)
  634. return fmt.Errorf("%s", bodyBytes)
  635. }
  636. scanner := bufio.NewScanner(res.Body)
  637. buf := make([]byte, 0, maxBufferSize)
  638. scanner.Buffer(buf, maxBufferSize)
  639. // keep track of the last token generated, this is used to abort if the model starts looping
  640. var lastToken string
  641. var tokenRepeat int
  642. for scanner.Scan() {
  643. select {
  644. case <-ctx.Done():
  645. // This handles the request cancellation
  646. return ctx.Err()
  647. default:
  648. line := scanner.Bytes()
  649. if len(line) == 0 {
  650. continue
  651. }
  652. // slog.Debug("got line", "line", string(line))
  653. evt, ok := bytes.CutPrefix(line, []byte("data: "))
  654. if !ok {
  655. evt = line
  656. }
  657. var c completion
  658. if err := json.Unmarshal(evt, &c); err != nil {
  659. return fmt.Errorf("error unmarshalling llm prediction response: %v", err)
  660. }
  661. switch {
  662. case strings.TrimSpace(c.Content) == lastToken:
  663. tokenRepeat++
  664. default:
  665. lastToken = strings.TrimSpace(c.Content)
  666. tokenRepeat = 0
  667. }
  668. // 30 picked as an arbitrary max token repeat limit, modify as needed
  669. if tokenRepeat > 30 {
  670. slog.Debug("prediction aborted, token repeat limit reached")
  671. return ctx.Err()
  672. }
  673. if c.Content != "" {
  674. fn(CompletionResponse{
  675. Content: c.Content,
  676. })
  677. }
  678. if c.Stop {
  679. doneReason := "stop"
  680. if c.StoppedLimit {
  681. doneReason = "length"
  682. }
  683. fn(CompletionResponse{
  684. Done: true,
  685. DoneReason: doneReason,
  686. PromptEvalCount: c.Timings.PromptN,
  687. PromptEvalDuration: parseDurationMs(c.Timings.PromptMS),
  688. EvalCount: c.Timings.PredictedN,
  689. EvalDuration: parseDurationMs(c.Timings.PredictedMS),
  690. })
  691. return nil
  692. }
  693. }
  694. }
  695. if err := scanner.Err(); err != nil {
  696. if strings.Contains(err.Error(), "unexpected EOF") {
  697. s.Close()
  698. msg := ""
  699. if s.status != nil && s.status.LastErrMsg != "" {
  700. msg = s.status.LastErrMsg
  701. }
  702. return fmt.Errorf("an unknown error was encountered while running the model %s", msg)
  703. }
  704. return fmt.Errorf("error reading llm response: %v", err)
  705. }
  706. return nil
  707. }
  708. type EmbeddingRequest struct {
  709. Content string `json:"content"`
  710. }
  711. type EmbeddingResponse struct {
  712. Embedding []float32 `json:"embedding"`
  713. }
  714. func (s *llmServer) Embedding(ctx context.Context, input string) ([]float32, error) {
  715. if err := s.sem.Acquire(ctx, 1); err != nil {
  716. slog.Error("Failed to acquire semaphore", "error", err)
  717. return nil, err
  718. }
  719. defer s.sem.Release(1)
  720. // Make sure the server is ready
  721. status, err := s.getServerStatusRetry(ctx)
  722. if err != nil {
  723. return nil, err
  724. } else if status != ServerStatusReady {
  725. return nil, fmt.Errorf("unexpected server status: %s", status.ToString())
  726. }
  727. data, err := json.Marshal(EmbeddingRequest{Content: input})
  728. if err != nil {
  729. return nil, fmt.Errorf("error marshaling embed data: %w", err)
  730. }
  731. r, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/embedding", s.port), bytes.NewBuffer(data))
  732. if err != nil {
  733. return nil, fmt.Errorf("error creating embed request: %w", err)
  734. }
  735. r.Header.Set("Content-Type", "application/json")
  736. resp, err := http.DefaultClient.Do(r)
  737. if err != nil {
  738. return nil, fmt.Errorf("do embedding request: %w", err)
  739. }
  740. defer resp.Body.Close()
  741. body, err := io.ReadAll(resp.Body)
  742. if err != nil {
  743. return nil, fmt.Errorf("error reading embed response: %w", err)
  744. }
  745. if resp.StatusCode >= 400 {
  746. log.Printf("llm embedding error: %s", body)
  747. return nil, fmt.Errorf("%s", body)
  748. }
  749. var e EmbeddingResponse
  750. if err := json.Unmarshal(body, &e); err != nil {
  751. return nil, fmt.Errorf("unmarshal tokenize response: %w", err)
  752. }
  753. return e.Embedding, nil
  754. }
  755. type TokenizeRequest struct {
  756. Content string `json:"content"`
  757. }
  758. type TokenizeResponse struct {
  759. Tokens []int `json:"tokens"`
  760. }
  761. func (s *llmServer) Tokenize(ctx context.Context, content string) ([]int, error) {
  762. s.modelLock.Lock()
  763. defer s.modelLock.Unlock()
  764. if s.model != nil {
  765. return s.model.Tokenize(content, false, true)
  766. }
  767. // Make sure the server is ready
  768. status, err := s.getServerStatus(ctx)
  769. if err != nil {
  770. return nil, err
  771. } else if status != ServerStatusReady && status != ServerStatusNoSlotsAvailable {
  772. return nil, fmt.Errorf("unexpected server status: %s", status.ToString())
  773. }
  774. data, err := json.Marshal(TokenizeRequest{Content: content})
  775. if err != nil {
  776. return nil, fmt.Errorf("marshaling encode data: %w", err)
  777. }
  778. req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/tokenize", s.port), bytes.NewBuffer(data))
  779. if err != nil {
  780. return nil, fmt.Errorf("encode request: %w", err)
  781. }
  782. req.Header.Set("Content-Type", "application/json")
  783. resp, err := http.DefaultClient.Do(req)
  784. if err != nil {
  785. return nil, fmt.Errorf("do encode request: %w", err)
  786. }
  787. defer resp.Body.Close()
  788. if resp.StatusCode == http.StatusNotFound {
  789. if s.model == nil {
  790. slog.Debug("new runner detected, loading model for cgo tokenization")
  791. m := llama.LoadModelFromFile(s.modelPath, llama.ModelParams{VocabOnly: true})
  792. s.model = m
  793. }
  794. return s.model.Tokenize(content, false, true)
  795. }
  796. body, err := io.ReadAll(resp.Body)
  797. if err != nil {
  798. return nil, fmt.Errorf("read encode request: %w", err)
  799. }
  800. if resp.StatusCode >= 400 {
  801. log.Printf("llm encode error: %s", body)
  802. return nil, fmt.Errorf("%s", body)
  803. }
  804. var encoded TokenizeResponse
  805. if err := json.Unmarshal(body, &encoded); err != nil {
  806. return nil, fmt.Errorf("unmarshal encode response: %w", err)
  807. }
  808. return encoded.Tokens, nil
  809. }
  810. type DetokenizeRequest struct {
  811. Tokens []int `json:"tokens"`
  812. }
  813. type DetokenizeResponse struct {
  814. Content string `json:"content"`
  815. }
  816. func (s *llmServer) Detokenize(ctx context.Context, tokens []int) (string, error) {
  817. s.modelLock.Lock()
  818. defer s.modelLock.Unlock()
  819. if s.model != nil {
  820. var resp string
  821. for _, token := range tokens {
  822. resp += s.model.TokenToPiece(token)
  823. }
  824. return resp, nil
  825. }
  826. // Make sure the server is ready
  827. status, err := s.getServerStatus(ctx)
  828. if err != nil {
  829. return "", err
  830. } else if status != ServerStatusReady && status != ServerStatusNoSlotsAvailable {
  831. return "", fmt.Errorf("unexpected server status: %s", status.ToString())
  832. }
  833. data, err := json.Marshal(DetokenizeRequest{Tokens: tokens})
  834. if err != nil {
  835. return "", fmt.Errorf("marshaling decode data: %w", err)
  836. }
  837. req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/detokenize", s.port), bytes.NewBuffer(data))
  838. if err != nil {
  839. return "", fmt.Errorf("decode request: %w", err)
  840. }
  841. req.Header.Set("Content-Type", "application/json")
  842. resp, err := http.DefaultClient.Do(req)
  843. if err != nil {
  844. return "", fmt.Errorf("do decode request: %w", err)
  845. }
  846. defer resp.Body.Close()
  847. if resp.StatusCode == http.StatusNotFound {
  848. if s.model == nil {
  849. slog.Debug("new runner detected, loading model for cgo tokenization")
  850. m := llama.LoadModelFromFile(s.modelPath, llama.ModelParams{VocabOnly: true})
  851. s.model = m
  852. }
  853. var resp string
  854. for _, token := range tokens {
  855. resp += s.model.TokenToPiece(token)
  856. }
  857. return resp, nil
  858. }
  859. body, err := io.ReadAll(resp.Body)
  860. if err != nil {
  861. return "", fmt.Errorf("read decode request: %w", err)
  862. }
  863. if resp.StatusCode >= 400 {
  864. log.Printf("llm decode error: %s", body)
  865. return "", fmt.Errorf("%s", body)
  866. }
  867. var decoded DetokenizeResponse
  868. if err := json.Unmarshal(body, &decoded); err != nil {
  869. return "", fmt.Errorf("unmarshal encode response: %w", err)
  870. }
  871. return decoded.Content, nil
  872. }
  873. func (s *llmServer) Close() error {
  874. s.modelLock.Lock()
  875. if s.model != nil {
  876. llama.FreeModel(s.model)
  877. s.model = nil
  878. }
  879. s.modelLock.Unlock()
  880. if s.cmd != nil {
  881. slog.Debug("stopping llama server")
  882. if err := s.cmd.Process.Kill(); err != nil {
  883. return err
  884. }
  885. // if ProcessState is already populated, Wait already completed, no need to wait again
  886. if s.cmd.ProcessState == nil {
  887. slog.Debug("waiting for llama server to exit")
  888. <-s.done
  889. }
  890. slog.Debug("llama server stopped")
  891. }
  892. return nil
  893. }
  894. func (s *llmServer) EstimatedVRAM() uint64 {
  895. return s.estimate.VRAMSize
  896. }
  897. func (s *llmServer) EstimatedTotal() uint64 {
  898. return s.estimate.TotalSize
  899. }
  900. func (s *llmServer) EstimatedVRAMByGPU(gpuID string) uint64 {
  901. for i, gpu := range s.gpus {
  902. if gpu.ID == gpuID {
  903. return s.estimate.GPUSizes[i]
  904. }
  905. }
  906. return 0
  907. }
  908. func parseDurationMs(ms float64) time.Duration {
  909. dur, err := time.ParseDuration(fmt.Sprintf("%fms", ms))
  910. if err != nil {
  911. panic(err)
  912. }
  913. return dur
  914. }