server.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932
  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. *llamaModel
  54. sem *semaphore.Weighted
  55. }
  56. func LoadModel(model string) (*GGML, error) {
  57. if _, err := os.Stat(model); err != nil {
  58. return nil, err
  59. }
  60. f, err := os.Open(model)
  61. if err != nil {
  62. return nil, err
  63. }
  64. defer f.Close()
  65. ggml, _, err := DecodeGGML(f)
  66. return ggml, err
  67. }
  68. // NewLlamaServer will run a server for the given GPUs
  69. // The gpu list must be a single family.
  70. func NewLlamaServer(gpus gpu.GpuInfoList, model string, ggml *GGML, adapters, projectors []string, opts api.Options) (LlamaServer, error) {
  71. var err error
  72. var cpuRunner string
  73. var estimatedVRAM uint64
  74. var estimatedTotal uint64
  75. var systemMemory uint64
  76. gpuCount := len(gpus)
  77. if (len(gpus) == 1 && gpus[0].Library == "cpu") || opts.NumGPU == 0 {
  78. // TODO evaluate system memory to see if we should block the load, or force an unload of another CPU runner
  79. cpuRunner = serverForCpu()
  80. gpuCount = 0
  81. _, _, estimatedTotal = EstimateGPULayers(gpus, ggml, projectors, opts)
  82. } else {
  83. if gpus[0].Library == "metal" {
  84. memInfo, err := gpu.GetCPUMem()
  85. if err != nil {
  86. slog.Error("failed to lookup system memory", "error", err)
  87. } else {
  88. systemMemory = memInfo.TotalMemory
  89. slog.Debug("system memory", "total", format.HumanBytes2(systemMemory))
  90. }
  91. }
  92. var layers int
  93. layers, estimatedVRAM, estimatedTotal = EstimateGPULayers(gpus, ggml, projectors, opts)
  94. if 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. } else if 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. } else if opts.NumGPU < 0 && layers > 0 && gpus[0].Library != "cpu" {
  103. opts.NumGPU = layers
  104. }
  105. }
  106. // Loop through potential servers
  107. finalErr := fmt.Errorf("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 := 0; i < len(servers); i++ {
  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 = 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. llamaModel: newLlamaModel(model),
  268. }
  269. s.cmd.Env = os.Environ()
  270. s.cmd.Stdout = os.Stdout
  271. s.cmd.Stderr = s.status
  272. visibleDevicesEnv, visibleDevicesEnvVal := gpu.GpuInfoList(gpus).GetVisibleDevicesEnv()
  273. pathEnvVal := strings.Join(libraryPaths, string(filepath.ListSeparator))
  274. // Update or add the path and visible devices variable with our adjusted version
  275. pathNeeded := true
  276. devicesNeeded := visibleDevicesEnv != ""
  277. for i := range s.cmd.Env {
  278. cmp := strings.SplitN(s.cmd.Env[i], "=", 2)
  279. if strings.EqualFold(cmp[0], pathEnv) {
  280. s.cmd.Env[i] = pathEnv + "=" + pathEnvVal
  281. pathNeeded = false
  282. } else if devicesNeeded && strings.EqualFold(cmp[0], visibleDevicesEnv) {
  283. s.cmd.Env[i] = visibleDevicesEnv + "=" + visibleDevicesEnvVal
  284. devicesNeeded = false
  285. }
  286. }
  287. if pathNeeded {
  288. s.cmd.Env = append(s.cmd.Env, pathEnv+"="+pathEnvVal)
  289. }
  290. if devicesNeeded {
  291. s.cmd.Env = append(s.cmd.Env, visibleDevicesEnv+"="+visibleDevicesEnvVal)
  292. }
  293. slog.Info("starting llama server", "cmd", s.cmd.String())
  294. if envconfig.Debug {
  295. filteredEnv := []string{}
  296. for _, ev := range s.cmd.Env {
  297. if strings.HasPrefix(ev, "CUDA_") ||
  298. strings.HasPrefix(ev, "ROCM_") ||
  299. strings.HasPrefix(ev, "HIP_") ||
  300. strings.HasPrefix(ev, "HSA_") ||
  301. strings.HasPrefix(ev, "GGML_") ||
  302. strings.HasPrefix(ev, "PATH=") ||
  303. strings.HasPrefix(ev, "LD_LIBRARY_PATH=") {
  304. filteredEnv = append(filteredEnv, ev)
  305. }
  306. }
  307. // Log at debug as the environment is inherited and might contain sensitive information
  308. slog.Debug("subprocess", "environment", filteredEnv)
  309. }
  310. if err = s.cmd.Start(); err != nil {
  311. // Detect permission denied and augment them essage about noexec
  312. if errors.Is(err, os.ErrPermission) {
  313. 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)
  314. continue
  315. }
  316. msg := ""
  317. if s.status != nil && s.status.LastErrMsg != "" {
  318. msg = s.status.LastErrMsg
  319. }
  320. err = fmt.Errorf("error starting the external llama server: %v %s", err, msg)
  321. finalErr = err
  322. continue
  323. }
  324. // reap subprocess when it exits
  325. go func() {
  326. s.done <- s.cmd.Wait()
  327. }()
  328. return s, nil
  329. }
  330. slog.Error("unable to load any llama server", "error", finalErr)
  331. return nil, finalErr
  332. }
  333. func projectorMemoryRequirements(filename string) uint64 {
  334. file, err := os.Open(filename)
  335. if err != nil {
  336. return 0
  337. }
  338. defer file.Close()
  339. ggml, _, err := DecodeGGML(file)
  340. if err != nil {
  341. return 0
  342. }
  343. var mem uint64
  344. for _, layer := range ggml.Tensors().Layers() {
  345. mem += layer.size()
  346. }
  347. return mem
  348. }
  349. type ServerStatus int
  350. const ( // iota is reset to 0
  351. ServerStatusReady ServerStatus = iota
  352. ServerStatusNoSlotsAvailable
  353. ServerStatusLoadingModel
  354. ServerStatusNotResponding
  355. ServerStatusError
  356. )
  357. func (s ServerStatus) ToString() string {
  358. switch s {
  359. case ServerStatusReady:
  360. return "llm server ready"
  361. case ServerStatusNoSlotsAvailable:
  362. return "llm busy - no slots available"
  363. case ServerStatusLoadingModel:
  364. return "llm server loading model"
  365. case ServerStatusNotResponding:
  366. return "llm server not responding"
  367. default:
  368. return "llm server error"
  369. }
  370. }
  371. type ServerStatusResp struct {
  372. Status string `json:"status"`
  373. SlotsIdle int `json:"slots_idle"`
  374. SlotsProcessing int `json:"slots_processing"`
  375. Error string `json:"error"`
  376. Progress float32 `json:"progress"`
  377. }
  378. func (s *llmServer) getServerStatus(ctx context.Context) (ServerStatus, error) {
  379. // Fail fast if its exited
  380. if s.cmd.ProcessState != nil {
  381. msg := ""
  382. if s.status != nil && s.status.LastErrMsg != "" {
  383. msg = s.status.LastErrMsg
  384. }
  385. if s.cmd.ProcessState.ExitCode() == -1 {
  386. // Most likely a signal killed it, log some more details to try to help troubleshoot
  387. slog.Warn("llama runner process no longer running", "sys", s.cmd.ProcessState.Sys(), "string", s.cmd.ProcessState.String())
  388. }
  389. return ServerStatusError, fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
  390. }
  391. req, err := http.NewRequestWithContext(ctx, http.MethodGet, fmt.Sprintf("http://127.0.0.1:%d/health", s.port), nil)
  392. if err != nil {
  393. return ServerStatusError, fmt.Errorf("error creating GET request: %v", err)
  394. }
  395. req.Header.Set("Content-Type", "application/json")
  396. resp, err := http.DefaultClient.Do(req)
  397. if err != nil {
  398. if errors.Is(err, context.DeadlineExceeded) {
  399. return ServerStatusNotResponding, fmt.Errorf("server not responding")
  400. }
  401. return ServerStatusError, fmt.Errorf("health resp: %w", err)
  402. }
  403. defer resp.Body.Close()
  404. body, err := io.ReadAll(resp.Body)
  405. if err != nil {
  406. return ServerStatusError, fmt.Errorf("read health request: %w", err)
  407. }
  408. var status ServerStatusResp
  409. if err := json.Unmarshal(body, &status); err != nil {
  410. return ServerStatusError, fmt.Errorf("health unmarshal encode response: %w", err)
  411. }
  412. switch status.Status {
  413. case "ok":
  414. return ServerStatusReady, nil
  415. case "no slot available":
  416. return ServerStatusNoSlotsAvailable, nil
  417. case "loading model":
  418. s.loadProgress = status.Progress
  419. return ServerStatusLoadingModel, nil
  420. default:
  421. return ServerStatusError, fmt.Errorf("server error: %+v", status)
  422. }
  423. }
  424. // getServerStatusRetry will retry if ServerStatusNoSlotsAvailable is received
  425. func (s *llmServer) getServerStatusRetry(ctx context.Context) (ServerStatus, error) {
  426. var retries int
  427. for {
  428. status, err := s.getServerStatus(ctx)
  429. if err != nil {
  430. return status, err
  431. }
  432. if status == ServerStatusNoSlotsAvailable {
  433. if retries >= 10 {
  434. return status, fmt.Errorf("no slots available after %d retries", retries)
  435. }
  436. time.Sleep(5 * time.Millisecond)
  437. retries++
  438. continue
  439. }
  440. return status, nil
  441. }
  442. }
  443. func (s *llmServer) Ping(ctx context.Context) error {
  444. _, err := s.getServerStatus(ctx)
  445. if err != nil {
  446. slog.Debug("server unhealthy", "error", err)
  447. return err
  448. }
  449. return nil
  450. }
  451. func (s *llmServer) WaitUntilRunning(ctx context.Context) error {
  452. start := time.Now()
  453. stallDuration := 5 * time.Minute // If no progress happens
  454. finalLoadDuration := 5 * time.Minute // After we hit 100%, give the runner more time to come online
  455. stallTimer := time.Now().Add(stallDuration) // give up if we stall
  456. slog.Info("waiting for llama runner to start responding")
  457. var lastStatus ServerStatus = -1
  458. fullyLoaded := false
  459. for {
  460. select {
  461. case <-ctx.Done():
  462. slog.Warn("client connection closed before server finished loading, aborting load")
  463. return fmt.Errorf("timed out waiting for llama runner to start: %w", ctx.Err())
  464. case err := <-s.done:
  465. msg := ""
  466. if s.status != nil && s.status.LastErrMsg != "" {
  467. msg = s.status.LastErrMsg
  468. }
  469. return fmt.Errorf("llama runner process has terminated: %v %s", err, msg)
  470. default:
  471. }
  472. if time.Now().After(stallTimer) {
  473. // timeout
  474. msg := ""
  475. if s.status != nil && s.status.LastErrMsg != "" {
  476. msg = s.status.LastErrMsg
  477. }
  478. return fmt.Errorf("timed out waiting for llama runner to start - progress %0.2f - %s", s.loadProgress, msg)
  479. }
  480. if s.cmd.ProcessState != nil {
  481. msg := ""
  482. if s.status != nil && s.status.LastErrMsg != "" {
  483. msg = s.status.LastErrMsg
  484. }
  485. return fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
  486. }
  487. ctx, cancel := context.WithTimeout(ctx, 200*time.Millisecond)
  488. defer cancel()
  489. priorProgress := s.loadProgress
  490. status, _ := s.getServerStatus(ctx)
  491. if lastStatus != status && status != ServerStatusReady {
  492. // Only log on status changes
  493. slog.Info("waiting for server to become available", "status", status.ToString())
  494. }
  495. switch status {
  496. case ServerStatusReady:
  497. s.loadDuration = time.Since(start)
  498. slog.Info(fmt.Sprintf("llama runner started in %0.2f seconds", s.loadDuration.Seconds()))
  499. return nil
  500. default:
  501. lastStatus = status
  502. // Reset the timer as long as we're making forward progress on the load
  503. if priorProgress != s.loadProgress {
  504. slog.Debug(fmt.Sprintf("model load progress %0.2f", s.loadProgress))
  505. stallTimer = time.Now().Add(stallDuration)
  506. } else if !fullyLoaded && int(s.loadProgress*100.0) >= 100 {
  507. slog.Debug("model load completed, waiting for server to become available", "status", status.ToString())
  508. stallTimer = time.Now().Add(finalLoadDuration)
  509. fullyLoaded = true
  510. }
  511. time.Sleep(time.Millisecond * 250)
  512. continue
  513. }
  514. }
  515. }
  516. const jsonGrammar = `
  517. root ::= object
  518. value ::= object | array | string | number | ("true" | "false" | "null") ws
  519. object ::=
  520. "{" ws (
  521. string ":" ws value
  522. ("," ws string ":" ws value)*
  523. )? "}" ws
  524. array ::=
  525. "[" ws (
  526. value
  527. ("," ws value)*
  528. )? "]" ws
  529. string ::=
  530. "\"" (
  531. [^"\\] |
  532. "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F]) # escapes
  533. )* "\"" ws
  534. number ::= ("-"? ([0-9] | [1-9] [0-9]*)) ("." [0-9]+)? ([eE] [-+]? [0-9]+)? ws
  535. # Optional space: by convention, applied in this grammar after literal chars when allowed
  536. ws ::= ([ \t\n] ws)?
  537. `
  538. const maxBufferSize = 512 * format.KiloByte
  539. type ImageData struct {
  540. Data []byte `json:"data"`
  541. ID int `json:"id"`
  542. }
  543. type completion struct {
  544. Content string `json:"content"`
  545. Model string `json:"model"`
  546. Prompt string `json:"prompt"`
  547. Stop bool `json:"stop"`
  548. StoppedLimit bool `json:"stopped_limit"`
  549. Timings struct {
  550. PredictedN int `json:"predicted_n"`
  551. PredictedMS float64 `json:"predicted_ms"`
  552. PromptN int `json:"prompt_n"`
  553. PromptMS float64 `json:"prompt_ms"`
  554. }
  555. }
  556. type CompletionRequest struct {
  557. Prompt string
  558. Format string
  559. Images []ImageData
  560. Options api.Options
  561. }
  562. type CompletionResponse struct {
  563. Content string
  564. DoneReason string
  565. Done bool
  566. PromptEvalCount int
  567. PromptEvalDuration time.Duration
  568. EvalCount int
  569. EvalDuration time.Duration
  570. }
  571. func (s *llmServer) Completion(ctx context.Context, req CompletionRequest, fn func(CompletionResponse)) error {
  572. if err := s.sem.Acquire(ctx, 1); err != nil {
  573. slog.Error("Failed to acquire semaphore", "error", err)
  574. return err
  575. }
  576. defer s.sem.Release(1)
  577. // only allow maximum 10 "context shifts" to avoid infinite generation
  578. if req.Options.NumPredict < 0 || req.Options.NumPredict > 10*s.options.NumCtx {
  579. req.Options.NumPredict = 10 * s.options.NumCtx
  580. slog.Debug("setting token limit to 10x num_ctx", "num_ctx", s.options.NumCtx, "num_predict", req.Options.NumPredict)
  581. }
  582. request := map[string]any{
  583. "prompt": req.Prompt,
  584. "stream": true,
  585. "n_predict": req.Options.NumPredict,
  586. "n_keep": req.Options.NumKeep,
  587. "main_gpu": req.Options.MainGPU,
  588. "temperature": req.Options.Temperature,
  589. "top_k": req.Options.TopK,
  590. "top_p": req.Options.TopP,
  591. "tfs_z": req.Options.TFSZ,
  592. "typical_p": req.Options.TypicalP,
  593. "repeat_last_n": req.Options.RepeatLastN,
  594. "repeat_penalty": req.Options.RepeatPenalty,
  595. "presence_penalty": req.Options.PresencePenalty,
  596. "frequency_penalty": req.Options.FrequencyPenalty,
  597. "mirostat": req.Options.Mirostat,
  598. "mirostat_tau": req.Options.MirostatTau,
  599. "mirostat_eta": req.Options.MirostatEta,
  600. "penalize_nl": req.Options.PenalizeNewline,
  601. "seed": req.Options.Seed,
  602. "stop": req.Options.Stop,
  603. "image_data": req.Images,
  604. "cache_prompt": true,
  605. }
  606. // Make sure the server is ready
  607. status, err := s.getServerStatusRetry(ctx)
  608. if err != nil {
  609. return err
  610. } else if status != ServerStatusReady {
  611. return fmt.Errorf("unexpected server status: %s", status.ToString())
  612. }
  613. if req.Format == "json" {
  614. request["grammar"] = jsonGrammar
  615. if !strings.Contains(strings.ToLower(req.Prompt), "json") {
  616. 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.")
  617. }
  618. }
  619. // Handling JSON marshaling with special characters unescaped.
  620. buffer := &bytes.Buffer{}
  621. enc := json.NewEncoder(buffer)
  622. enc.SetEscapeHTML(false)
  623. if err := enc.Encode(request); err != nil {
  624. return fmt.Errorf("failed to marshal data: %v", err)
  625. }
  626. endpoint := fmt.Sprintf("http://127.0.0.1:%d/completion", s.port)
  627. serverReq, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, buffer)
  628. if err != nil {
  629. return fmt.Errorf("error creating POST request: %v", err)
  630. }
  631. serverReq.Header.Set("Content-Type", "application/json")
  632. res, err := http.DefaultClient.Do(serverReq)
  633. if err != nil {
  634. return fmt.Errorf("POST predict: %v", err)
  635. }
  636. defer res.Body.Close()
  637. if res.StatusCode >= 400 {
  638. bodyBytes, err := io.ReadAll(res.Body)
  639. if err != nil {
  640. return fmt.Errorf("failed reading llm error response: %w", err)
  641. }
  642. log.Printf("llm predict error: %s", bodyBytes)
  643. return fmt.Errorf("%s", bodyBytes)
  644. }
  645. scanner := bufio.NewScanner(res.Body)
  646. buf := make([]byte, 0, maxBufferSize)
  647. scanner.Buffer(buf, maxBufferSize)
  648. // keep track of the last token generated, this is used to abort if the model starts looping
  649. var lastToken string
  650. var tokenRepeat int
  651. for scanner.Scan() {
  652. select {
  653. case <-ctx.Done():
  654. // This handles the request cancellation
  655. return ctx.Err()
  656. default:
  657. line := scanner.Bytes()
  658. if len(line) == 0 {
  659. continue
  660. }
  661. evt, ok := bytes.CutPrefix(line, []byte("data: "))
  662. if !ok {
  663. return fmt.Errorf("error parsing llm response stream: %s", line)
  664. }
  665. var c completion
  666. if err := json.Unmarshal(evt, &c); err != nil {
  667. return fmt.Errorf("error unmarshalling llm prediction response: %v", err)
  668. }
  669. switch {
  670. case strings.TrimSpace(c.Content) == lastToken:
  671. tokenRepeat++
  672. default:
  673. lastToken = strings.TrimSpace(c.Content)
  674. tokenRepeat = 0
  675. }
  676. // 30 picked as an arbitrary max token repeat limit, modify as needed
  677. if tokenRepeat > 30 {
  678. slog.Debug("prediction aborted, token repeat limit reached")
  679. return ctx.Err()
  680. }
  681. if c.Content != "" {
  682. fn(CompletionResponse{
  683. Content: c.Content,
  684. })
  685. }
  686. if c.Stop {
  687. doneReason := "stop"
  688. if c.StoppedLimit {
  689. doneReason = "length"
  690. }
  691. fn(CompletionResponse{
  692. Done: true,
  693. DoneReason: doneReason,
  694. PromptEvalCount: c.Timings.PromptN,
  695. PromptEvalDuration: parseDurationMs(c.Timings.PromptMS),
  696. EvalCount: c.Timings.PredictedN,
  697. EvalDuration: parseDurationMs(c.Timings.PredictedMS),
  698. })
  699. return nil
  700. }
  701. }
  702. }
  703. if err := scanner.Err(); err != nil {
  704. if strings.Contains(err.Error(), "unexpected EOF") {
  705. s.Close()
  706. msg := ""
  707. if s.status != nil && s.status.LastErrMsg != "" {
  708. msg = s.status.LastErrMsg
  709. }
  710. return fmt.Errorf("an unknown error was encountered while running the model %s", msg)
  711. }
  712. return fmt.Errorf("error reading llm response: %v", err)
  713. }
  714. return nil
  715. }
  716. type EmbeddingRequest struct {
  717. Content string `json:"content"`
  718. }
  719. type EmbeddingResponse struct {
  720. Embedding []float64 `json:"embedding"`
  721. }
  722. func (s *llmServer) Embedding(ctx context.Context, prompt string) ([]float64, error) {
  723. if err := s.sem.Acquire(ctx, 1); err != nil {
  724. slog.Error("Failed to acquire semaphore", "error", err)
  725. return nil, err
  726. }
  727. defer s.sem.Release(1)
  728. // Make sure the server is ready
  729. status, err := s.getServerStatusRetry(ctx)
  730. if err != nil {
  731. return nil, err
  732. } else if status != ServerStatusReady {
  733. return nil, fmt.Errorf("unexpected server status: %s", status.ToString())
  734. }
  735. var b bytes.Buffer
  736. if err := json.NewEncoder(&b).Encode(EmbeddingRequest{Content: prompt}); err != nil {
  737. return nil, fmt.Errorf("error marshaling embed data: %w", err)
  738. }
  739. req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/embedding", s.port), &b)
  740. if err != nil {
  741. return nil, fmt.Errorf("error creating embed request: %w", err)
  742. }
  743. req.Header.Set("Content-Type", "application/json")
  744. resp, err := http.DefaultClient.Do(req)
  745. if err != nil {
  746. return nil, fmt.Errorf("do embedding request: %w", err)
  747. }
  748. defer resp.Body.Close()
  749. body, err := io.ReadAll(resp.Body)
  750. if err != nil {
  751. return nil, fmt.Errorf("error reading embed response: %w", err)
  752. }
  753. if resp.StatusCode >= 400 {
  754. log.Printf("llm encode error: %s", body)
  755. return nil, fmt.Errorf("%s", body)
  756. }
  757. var embedding EmbeddingResponse
  758. if err := json.Unmarshal(body, &embedding); err != nil {
  759. return nil, fmt.Errorf("unmarshal tokenize response: %w", err)
  760. }
  761. return embedding.Embedding, nil
  762. }
  763. func (s *llmServer) Tokenize(ctx context.Context, content string) ([]int, error) {
  764. return s.llamaModel.Tokenize(content), nil
  765. }
  766. func (s *llmServer) Detokenize(ctx context.Context, tokens []int) (string, error) {
  767. return s.llamaModel.Detokenize(tokens), nil
  768. }
  769. func (s *llmServer) Close() error {
  770. if s.cmd != nil {
  771. slog.Debug("stopping llama server")
  772. if err := s.cmd.Process.Kill(); err != nil {
  773. return err
  774. }
  775. // if ProcessState is already populated, Wait already completed, no need to wait again
  776. if s.cmd.ProcessState == nil {
  777. slog.Debug("waiting for llama server to exit")
  778. <-s.done
  779. }
  780. slog.Debug("llama server stopped")
  781. }
  782. if s.llamaModel != nil {
  783. s.llamaModel.Close()
  784. }
  785. return nil
  786. }
  787. func (s *llmServer) EstimatedVRAM() uint64 {
  788. return s.estimatedVRAM
  789. }
  790. func (s *llmServer) EstimatedTotal() uint64 {
  791. return s.estimatedTotal
  792. }
  793. func parseDurationMs(ms float64) time.Duration {
  794. dur, err := time.ParseDuration(fmt.Sprintf("%fms", ms))
  795. if err != nil {
  796. panic(err)
  797. }
  798. return dur
  799. }