server.go 28 KB

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