server.go 32.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package llm

import (
	"bufio"
	"bytes"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
	"log/slog"
	"math/rand"
	"net"
	"net/http"
	"os"
	"os/exec"
	"path/filepath"
	"runtime"
	"strconv"
	"strings"
22
	"sync"
23
24
	"time"

Daniel Hiltgen's avatar
Daniel Hiltgen committed
25
26
	"golang.org/x/sync/semaphore"

27
	"github.com/ollama/ollama/api"
28
	"github.com/ollama/ollama/discover"
29
	"github.com/ollama/ollama/envconfig"
30
	"github.com/ollama/ollama/format"
31
	"github.com/ollama/ollama/llama"
32
33
)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
34
35
36
37
type LlamaServer interface {
	Ping(ctx context.Context) error
	WaitUntilRunning(ctx context.Context) error
	Completion(ctx context.Context, req CompletionRequest, fn func(CompletionResponse)) error
38
	Embedding(ctx context.Context, input string) ([]float32, error)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
39
40
41
	Tokenize(ctx context.Context, content string) ([]int, error)
	Detokenize(ctx context.Context, tokens []int) (string, error)
	Close() error
42
	EstimatedVRAM() uint64 // Total VRAM across all GPUs
43
	EstimatedTotal() uint64
Daniel Hiltgen's avatar
Daniel Hiltgen committed
44
	EstimatedVRAMByGPU(gpuID string) uint64
Daniel Hiltgen's avatar
Daniel Hiltgen committed
45
46
47
48
}

// llmServer is an instance of the llama.cpp server
type llmServer struct {
49
50
51
52
53
54
	port        int
	cmd         *exec.Cmd
	done        chan error // Channel to signal when the process exits
	status      *StatusWriter
	options     api.Options
	numParallel int
55
56
57
	modelPath   string
	modelLock   sync.Mutex   // Temporary until we switch fully to Go server
	model       *llama.Model // If non-nil, the runner is a new Go server
Daniel Hiltgen's avatar
Daniel Hiltgen committed
58

59
60
61
	estimate    MemoryEstimate
	totalLayers uint64
	// gpuCount     int
62
63
	gpus         discover.GpuInfoList // Recorded just before the model loaded, free space will be incorrect
	loadDuration time.Duration        // Record how long it took the model to load
64
	loadProgress float32
Daniel Hiltgen's avatar
Daniel Hiltgen committed
65
66

	sem *semaphore.Weighted
67
68
}

69
70
71
72
73
74
// LoadModel will load a model from disk. The model must be in the GGML format.
//
// It collects array values for arrays with a size less than or equal to
// maxArraySize. If maxArraySize is 0, the default value of 1024 is used. If
// the maxArraySize is negative, all arrays are collected.
func LoadModel(model string, maxArraySize int) (*GGML, error) {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
75
76
77
78
	if _, err := os.Stat(model); err != nil {
		return nil, err
	}

79
80
81
82
83
84
	f, err := os.Open(model)
	if err != nil {
		return nil, err
	}
	defer f.Close()

85
	ggml, _, err := DecodeGGML(f, maxArraySize)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
86
87
	return ggml, err
}
88

Daniel Hiltgen's avatar
Daniel Hiltgen committed
89
90
// NewLlamaServer will run a server for the given GPUs
// The gpu list must be a single family.
91
func NewLlamaServer(gpus discover.GpuInfoList, model string, ggml *GGML, adapters, projectors []string, opts api.Options, numParallel int) (LlamaServer, error) {
92
93
	var systemTotalMemory uint64
	var systemFreeMemory uint64
94
	var systemSwapFreeMemory uint64
95

96
	systemInfo := discover.GetSystemInfo()
97
98
99
100
	systemTotalMemory = systemInfo.System.TotalMemory
	systemFreeMemory = systemInfo.System.FreeMemory
	systemSwapFreeMemory = systemInfo.System.FreeSwap
	slog.Info("system memory", "total", format.HumanBytes2(systemTotalMemory), "free", format.HumanBytes2(systemFreeMemory), "free_swap", format.HumanBytes2(systemSwapFreeMemory))
101

102
103
	// If the user wants zero GPU layers, reset the gpu list to be CPU/system ram info
	if opts.NumGPU == 0 {
104
		gpus = discover.GetCPUInfo()
105
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
106

Michael Yang's avatar
Michael Yang committed
107
108
	estimate := EstimateGPULayers(gpus, ggml, projectors, opts)
	if len(gpus) > 1 || gpus[0].Library != "cpu" {
Michael Yang's avatar
Michael Yang committed
109
		switch {
110
		case gpus[0].Library == "metal" && estimate.VRAMSize > systemTotalMemory:
Daniel Hiltgen's avatar
Daniel Hiltgen committed
111
112
113
			// disable partial offloading when model is greater than total system memory as this
			// can lead to locking up the system
			opts.NumGPU = 0
114
		case gpus[0].Library != "metal" && estimate.Layers == 0:
115
			// Don't bother loading into the GPU if no layers can fit
116
			gpus = discover.GetCPUInfo()
117
118
		case opts.NumGPU < 0 && estimate.Layers > 0 && gpus[0].Library != "cpu":
			opts.NumGPU = estimate.Layers
119
120
121
		}
	}

122
123
124
	// On linux and windows, over-allocating CPU memory will almost always result in an error
	// Darwin has fully dynamic swap so has no direct concept of free swap space
	if runtime.GOOS != "darwin" {
125
		systemMemoryRequired := estimate.TotalSize - estimate.VRAMSize
126
		available := systemFreeMemory + systemSwapFreeMemory
127
128
129
		if systemMemoryRequired > available {
			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))
			return nil, fmt.Errorf("model requires more system memory (%s) than is available (%s)", format.HumanBytes2(systemMemoryRequired), format.HumanBytes2(available))
130
131
132
		}
	}

133
134
	estimate.log()

135
136
	params := []string{
		"--model", model,
Michael Yang's avatar
lint  
Michael Yang committed
137
138
		"--ctx-size", strconv.Itoa(opts.NumCtx),
		"--batch-size", strconv.Itoa(opts.NumBatch),
139
	}
Michael Yang's avatar
Michael Yang committed
140

Michael Yang's avatar
Michael Yang committed
141
	if opts.NumGPU >= 0 {
Michael Yang's avatar
lint  
Michael Yang committed
142
		params = append(params, "--n-gpu-layers", strconv.Itoa(opts.NumGPU))
143
144
	}

Michael Yang's avatar
Michael Yang committed
145
	if envconfig.Debug() {
146
147
148
149
		params = append(params, "--verbose")
	}

	if opts.MainGPU > 0 {
Michael Yang's avatar
lint  
Michael Yang committed
150
		params = append(params, "--main-gpu", strconv.Itoa(opts.MainGPU))
151
152
153
	}

	if len(adapters) > 0 {
154
155
156
		for _, adapter := range adapters {
			params = append(params, "--lora", adapter)
		}
157
158
159
160
161
162
163
	}

	if len(projectors) > 0 {
		// TODO: applying multiple projectors is not supported by the llama.cpp server yet
		params = append(params, "--mmproj", projectors[0])
	}

164
	defaultThreads := systemInfo.GetOptimalThreadCount()
165
	if opts.NumThread > 0 {
Michael Yang's avatar
lint  
Michael Yang committed
166
		params = append(params, "--threads", strconv.Itoa(opts.NumThread))
167
168
	} else if defaultThreads > 0 {
		params = append(params, "--threads", strconv.Itoa(defaultThreads))
169
170
	}

171
172
173
174
175
	fa := envconfig.FlashAttention()
	if fa && !gpus.FlashAttentionSupported() {
		slog.Warn("flash attention enabled but not supported by gpu")
		fa = false
	}
Sam's avatar
Sam committed
176

177
178
179
180
181
	if fa && !ggml.SupportsFlashAttention() {
		slog.Warn("flash attention enabled but not supported by model")
		fa = false
	}

182
	kvct := strings.ToLower(envconfig.KvCacheType())
183
184
185
186
187
188
189
190
191
192
193

	if fa {
		slog.Info("enabling flash attention")
		params = append(params, "--flash-attn")

		// Flash Attention also supports kv cache quantization
		// Enable if the requested and kv cache type is supported by the model
		if kvct != "" && ggml.SupportsKVCacheType(kvct) {
			params = append(params, "--kv-cache-type", kvct)
		} else {
			slog.Warn("kv cache type not supported by model", "type", kvct)
Sam's avatar
Sam committed
194
		}
195
196
197
	} else if kvct != "" && kvct != "f16" {
		slog.Warn("quantized kv cache requested but flash attention disabled", "type", kvct)
	}
198

199
200
	// mmap has issues with partial offloading on metal
	for _, g := range gpus {
201
202
203
		if g.Library == "metal" &&
			uint64(opts.NumGPU) > 0 &&
			uint64(opts.NumGPU) < ggml.KV().BlockCount()+1 {
204
205
			opts.UseMMap = new(bool)
			*opts.UseMMap = false
206
		}
Sam's avatar
Sam committed
207
	}
208

209
	// Windows CUDA should not use mmap for best performance
210
	// Linux  with a model larger than free space, mmap leads to thrashing
Daniel Hiltgen's avatar
Daniel Hiltgen committed
211
	// For CPU loads we want the memory to be allocated, not FS cache
212
213
214
215
	if (runtime.GOOS == "windows" && gpus[0].Library == "cuda" && opts.UseMMap == nil) ||
		(runtime.GOOS == "linux" && systemFreeMemory < estimate.TotalSize && opts.UseMMap == nil) ||
		(gpus[0].Library == "cpu" && opts.UseMMap == nil) ||
		(opts.UseMMap != nil && !*opts.UseMMap) {
216
217
218
219
220
221
222
		params = append(params, "--no-mmap")
	}

	if opts.UseMLock {
		params = append(params, "--mlock")
	}

223
	// TODO - NUMA support currently doesn't work properly
224

Michael Yang's avatar
lint  
Michael Yang committed
225
	params = append(params, "--parallel", strconv.Itoa(numParallel))
Daniel Hiltgen's avatar
Daniel Hiltgen committed
226

227
228
229
230
	if estimate.TensorSplit != "" {
		params = append(params, "--tensor-split", estimate.TensorSplit)
	}

231
232
233
234
	if envconfig.MultiUserCache() {
		params = append(params, "--multiuser-cache")
	}

Michael Yang's avatar
Michael Yang committed
235
	libs := make(map[string]string)
236
237
	if entries, err := os.ReadDir(discover.LibOllamaPath); err == nil {
		for _, entry := range entries {
Michael Yang's avatar
Michael Yang committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
			libs[entry.Name()] = filepath.Join(discover.LibOllamaPath, entry.Name())
		}
	}

	lib := gpus[0].RunnerName()
	requested := envconfig.LLMLibrary()
	if libs[requested] != "" {
		slog.Info("using requested gpu library", "requested", requested)
		lib = requested
	}

	var compatible []string
	for k := range libs {
		// exact match first
		if k == lib {
			compatible = append([]string{k}, compatible...)
254
255
			continue
		}
256

Michael Yang's avatar
Michael Yang committed
257
258
259
		// then match the family (e.g. 'cuda')
		if strings.Split(k, "_")[0] == strings.Split(lib, "_")[0] {
			compatible = append(compatible, k)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
260
		}
Michael Yang's avatar
Michael Yang committed
261
262
	}
	slog.Debug("compatible gpu libraries", "compatible", compatible)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
263

Michael Yang's avatar
Michael Yang committed
264
265
266
267
	// iterate through compatible GPU libraries such as 'cuda_v12', 'cuda_v11', 'rocm', etc.
	// adding each library's respective path to the LD_LIBRARY_PATH, until finally running
	// without any LD_LIBRARY_PATH flags
	for {
268
269
270
271
272
273
274
275
276
		port := 0
		if a, err := net.ResolveTCPAddr("tcp", "localhost:0"); err == nil {
			var l *net.TCPListener
			if l, err = net.ListenTCP("tcp", a); err == nil {
				port = l.Addr().(*net.TCPAddr).Port
				l.Close()
			}
		}
		if port == 0 {
277
			slog.Debug("ResolveTCPAddr failed, using random port")
278
279
			port = rand.Intn(65535-49152) + 49152 // get a random port in the ephemeral range
		}
280
281
282
		finalParams := []string{"runner"}
		finalParams = append(finalParams, params...)
		finalParams = append(finalParams, "--port", strconv.Itoa(port))
283
284
285
286
287

		pathEnv := "LD_LIBRARY_PATH"
		if runtime.GOOS == "windows" {
			pathEnv = "PATH"
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
288

Michael Yang's avatar
Michael Yang committed
289
		var libraryPaths []string
290
		if libraryPath, ok := os.LookupEnv(pathEnv); ok {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
291
			libraryPaths = append(libraryPaths, filepath.SplitList(libraryPath)...)
292
293
		}

Michael Yang's avatar
Michael Yang committed
294
295
296
297
298
299
300
301
		if len(compatible) > 0 {
			c := compatible[0]
			if libpath, ok := libs[c]; ok {
				slog.Debug("adding gpu library", "path", libpath)
				libraryPaths = append(libraryPaths, libpath)
			}
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
302
		// Note: we always put the dependency path first
Daniel Hiltgen's avatar
Daniel Hiltgen committed
303
		// since this was the exact version we compiled/linked against
304
		if gpus[0].DependencyPath != nil {
Michael Yang's avatar
Michael Yang committed
305
			slog.Debug("adding gpu dependency paths", "paths", gpus[0].DependencyPath)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
306
			// assume gpus from the same library have the same dependency path
307
			libraryPaths = append(gpus[0].DependencyPath, libraryPaths...)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
308
309
		}

Michael Yang's avatar
Michael Yang committed
310
311
312
313
314
315
316
317
318
319
320
321
322
		// finally, add the root library path
		libraryPaths = append(libraryPaths, discover.LibOllamaPath)

		exe, err := os.Executable()
		if err != nil {
			return nil, fmt.Errorf("unable to lookup executable path: %w", err)
		}

		exe, err = filepath.EvalSymlinks(exe)
		if err != nil {
			return nil, fmt.Errorf("unable to evaluate symlinks for executable path: %w", err)
		}

323
		// TODO - once fully switched to the Go runner, load the model here for tokenize/detokenize cgo access
Daniel Hiltgen's avatar
Daniel Hiltgen committed
324
		s := &llmServer{
325
			port:        port,
Michael Yang's avatar
Michael Yang committed
326
			cmd:         exec.Command(exe, finalParams...),
327
328
			status:      NewStatusWriter(os.Stderr),
			options:     opts,
329
			modelPath:   model,
330
			estimate:    estimate,
331
			numParallel: numParallel,
332
333
			sem:         semaphore.NewWeighted(int64(numParallel)),
			totalLayers: ggml.KV().BlockCount() + 1,
334
			gpus:        gpus,
335
			done:        make(chan error, 1),
336
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
337

338
		s.cmd.Env = os.Environ()
339
340
		s.cmd.Stdout = os.Stdout
		s.cmd.Stderr = s.status
341
		s.cmd.SysProcAttr = LlamaServerSysProcAttr
342

Daniel Hiltgen's avatar
Daniel Hiltgen committed
343
344
345
346
		envWorkarounds := [][2]string{}
		for _, gpu := range gpus {
			envWorkarounds = append(envWorkarounds, gpu.EnvWorkarounds...)
		}
Michael Yang's avatar
lint  
Michael Yang committed
347
		visibleDevicesEnv, visibleDevicesEnvVal := gpus.GetVisibleDevicesEnv()
348
349
350
351
352
353
354
355
356
357
358
359
360
		pathEnvVal := strings.Join(libraryPaths, string(filepath.ListSeparator))

		// Update or add the path and visible devices variable with our adjusted version
		pathNeeded := true
		devicesNeeded := visibleDevicesEnv != ""
		for i := range s.cmd.Env {
			cmp := strings.SplitN(s.cmd.Env[i], "=", 2)
			if strings.EqualFold(cmp[0], pathEnv) {
				s.cmd.Env[i] = pathEnv + "=" + pathEnvVal
				pathNeeded = false
			} else if devicesNeeded && strings.EqualFold(cmp[0], visibleDevicesEnv) {
				s.cmd.Env[i] = visibleDevicesEnv + "=" + visibleDevicesEnvVal
				devicesNeeded = false
Daniel Hiltgen's avatar
Daniel Hiltgen committed
361
362
363
364
365
366
			} else if len(envWorkarounds) != 0 {
				for _, kv := range envWorkarounds {
					if strings.EqualFold(cmp[0], kv[0]) {
						s.cmd.Env[i] = kv[0] + "=" + kv[1]
					}
				}
367
			}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
368
		}
369
370
		if pathNeeded {
			s.cmd.Env = append(s.cmd.Env, pathEnv+"="+pathEnvVal)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
371
		}
372
373
		if devicesNeeded {
			s.cmd.Env = append(s.cmd.Env, visibleDevicesEnv+"="+visibleDevicesEnvVal)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
374
375
		}

376
		slog.Info("starting llama server", "cmd", s.cmd.String())
Michael Yang's avatar
Michael Yang committed
377
		if envconfig.Debug() {
378
379
380
			filteredEnv := []string{}
			for _, ev := range s.cmd.Env {
				if strings.HasPrefix(ev, "CUDA_") ||
Daniel Hiltgen's avatar
Daniel Hiltgen committed
381
					strings.HasPrefix(ev, "ROCR_") ||
382
383
					strings.HasPrefix(ev, "ROCM_") ||
					strings.HasPrefix(ev, "HIP_") ||
Daniel Hiltgen's avatar
Daniel Hiltgen committed
384
					strings.HasPrefix(ev, "GPU_") ||
385
386
387
388
389
390
391
392
393
394
					strings.HasPrefix(ev, "HSA_") ||
					strings.HasPrefix(ev, "GGML_") ||
					strings.HasPrefix(ev, "PATH=") ||
					strings.HasPrefix(ev, "LD_LIBRARY_PATH=") {
					filteredEnv = append(filteredEnv, ev)
				}
			}
			// Log at debug as the environment is inherited and might contain sensitive information
			slog.Debug("subprocess", "environment", filteredEnv)
		}
395
396

		if err = s.cmd.Start(); err != nil {
Michael Yang's avatar
Michael Yang committed
397
			var msg string
398
399
400
			if s.status != nil && s.status.LastErrMsg != "" {
				msg = s.status.LastErrMsg
			}
Michael Yang's avatar
Michael Yang committed
401
402
403
404
405
406
407
			err := fmt.Errorf("error starting runner: %v %s", err, msg)
			if len(compatible) == 0 {
				return nil, err
			}

			slog.Warn("unable to start runner with compatible gpu", "error", err, "compatible", compatible)
			compatible = compatible[1:]
408
409
410
			continue
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
411
412
		// reap subprocess when it exits
		go func() {
413
414
415
			err := s.cmd.Wait()
			// Favor a more detailed message over the process exit status
			if err != nil && s.status != nil && s.status.LastErrMsg != "" {
Michael Yang's avatar
Michael Yang committed
416
				slog.Error("llama runner terminated", "error", err)
417
418
419
				if strings.Contains(s.status.LastErrMsg, "unknown model") {
					s.status.LastErrMsg = "this model is not supported by your version of Ollama. You may need to upgrade"
				}
Michael Yang's avatar
lint  
Michael Yang committed
420
				s.done <- errors.New(s.status.LastErrMsg)
421
422
423
			} else {
				s.done <- err
			}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
424
425
		}()

426
427
428
429
430
431
432
433
		return s, nil
	}
}

type ServerStatus int

const ( // iota is reset to 0
	ServerStatusReady ServerStatus = iota
434
	ServerStatusNoSlotsAvailable
435
436
437
438
439
	ServerStatusLoadingModel
	ServerStatusNotResponding
	ServerStatusError
)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
440
441
442
443
func (s ServerStatus) ToString() string {
	switch s {
	case ServerStatusReady:
		return "llm server ready"
444
	case ServerStatusNoSlotsAvailable:
Daniel Hiltgen's avatar
Daniel Hiltgen committed
445
446
447
448
449
450
451
452
453
454
		return "llm busy - no slots available"
	case ServerStatusLoadingModel:
		return "llm server loading model"
	case ServerStatusNotResponding:
		return "llm server not responding"
	default:
		return "llm server error"
	}
}

455
type ServerStatusResp struct {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
456
457
458
459
460
	Status          string  `json:"status"`
	SlotsIdle       int     `json:"slots_idle"`
	SlotsProcessing int     `json:"slots_processing"`
	Error           string  `json:"error"`
	Progress        float32 `json:"progress"`
461
462
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
463
func (s *llmServer) getServerStatus(ctx context.Context) (ServerStatus, error) {
464
465
466
467
468
469
	// Fail fast if its exited
	if s.cmd.ProcessState != nil {
		msg := ""
		if s.status != nil && s.status.LastErrMsg != "" {
			msg = s.status.LastErrMsg
		}
470
471
472
473
		if s.cmd.ProcessState.ExitCode() == -1 {
			// Most likely a signal killed it, log some more details to try to help troubleshoot
			slog.Warn("llama runner process no longer running", "sys", s.cmd.ProcessState.Sys(), "string", s.cmd.ProcessState.String())
		}
474
475
476
477
478
479
480
481
482
483
484
485
		return ServerStatusError, fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodGet, fmt.Sprintf("http://127.0.0.1:%d/health", s.port), nil)
	if err != nil {
		return ServerStatusError, fmt.Errorf("error creating GET request: %v", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		if errors.Is(err, context.DeadlineExceeded) {
Michael Yang's avatar
Michael Yang committed
486
			return ServerStatusNotResponding, errors.New("server not responding")
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
		}
		return ServerStatusError, fmt.Errorf("health resp: %w", err)
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return ServerStatusError, fmt.Errorf("read health request: %w", err)
	}

	var status ServerStatusResp
	if err := json.Unmarshal(body, &status); err != nil {
		return ServerStatusError, fmt.Errorf("health unmarshal encode response: %w", err)
	}

	switch status.Status {
	case "ok":
		return ServerStatusReady, nil
	case "no slot available":
506
		return ServerStatusNoSlotsAvailable, nil
507
	case "loading model":
Daniel Hiltgen's avatar
Daniel Hiltgen committed
508
		s.loadProgress = status.Progress
509
510
511
512
513
514
		return ServerStatusLoadingModel, nil
	default:
		return ServerStatusError, fmt.Errorf("server error: %+v", status)
	}
}

515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
// getServerStatusRetry will retry if ServerStatusNoSlotsAvailable is received
func (s *llmServer) getServerStatusRetry(ctx context.Context) (ServerStatus, error) {
	var retries int
	for {
		status, err := s.getServerStatus(ctx)
		if err != nil {
			return status, err
		}

		if status == ServerStatusNoSlotsAvailable {
			if retries >= 10 {
				return status, fmt.Errorf("no slots available after %d retries", retries)
			}

			time.Sleep(5 * time.Millisecond)
			retries++
			continue
		}

		return status, nil
	}
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
538
func (s *llmServer) Ping(ctx context.Context) error {
539
540
541
542
543
544
545
546
	_, err := s.getServerStatus(ctx)
	if err != nil {
		slog.Debug("server unhealthy", "error", err)
		return err
	}
	return nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
547
func (s *llmServer) WaitUntilRunning(ctx context.Context) error {
548
	start := time.Now()
549
	stallDuration := envconfig.LoadTimeout()    // If no progress happens
550
	stallTimer := time.Now().Add(stallDuration) // give up if we stall
551
552
553

	slog.Info("waiting for llama runner to start responding")
	var lastStatus ServerStatus = -1
554
	fullyLoaded := false
ManniX-ITA's avatar
ManniX-ITA committed
555

556
557
	for {
		select {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
558
		case <-ctx.Done():
559
			slog.Warn("client connection closed before server finished loading, aborting load")
560
			return fmt.Errorf("timed out waiting for llama runner to start: %w", ctx.Err())
561
		case err := <-s.done:
562
			return fmt.Errorf("llama runner process has terminated: %w", err)
563
564
		default:
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
565
		if time.Now().After(stallTimer) {
ManniX-ITA's avatar
ManniX-ITA committed
566
			// timeout
567
568
569
570
			msg := ""
			if s.status != nil && s.status.LastErrMsg != "" {
				msg = s.status.LastErrMsg
			}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
571
			return fmt.Errorf("timed out waiting for llama runner to start - progress %0.2f - %s", s.loadProgress, msg)
ManniX-ITA's avatar
ManniX-ITA committed
572
573
574
575
576
		}
		if s.cmd.ProcessState != nil {
			msg := ""
			if s.status != nil && s.status.LastErrMsg != "" {
				msg = s.status.LastErrMsg
577
			}
ManniX-ITA's avatar
ManniX-ITA committed
578
579
			return fmt.Errorf("llama runner process no longer running: %d %s", s.cmd.ProcessState.ExitCode(), msg)
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
580
581
		ctx, cancel := context.WithTimeout(ctx, 200*time.Millisecond)
		defer cancel()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
582
		priorProgress := s.loadProgress
Daniel Hiltgen's avatar
Daniel Hiltgen committed
583
584
585
586
587
		status, _ := s.getServerStatus(ctx)
		if lastStatus != status && status != ServerStatusReady {
			// Only log on status changes
			slog.Info("waiting for server to become available", "status", status.ToString())
		}
ManniX-ITA's avatar
ManniX-ITA committed
588
589
		switch status {
		case ServerStatusReady:
Daniel Hiltgen's avatar
Daniel Hiltgen committed
590
591
			s.loadDuration = time.Since(start)
			slog.Info(fmt.Sprintf("llama runner started in %0.2f seconds", s.loadDuration.Seconds()))
ManniX-ITA's avatar
ManniX-ITA committed
592
593
			return nil
		default:
Daniel Hiltgen's avatar
Daniel Hiltgen committed
594
			lastStatus = status
Daniel Hiltgen's avatar
Daniel Hiltgen committed
595
596
597
598
			// Reset the timer as long as we're making forward progress on the load
			if priorProgress != s.loadProgress {
				slog.Debug(fmt.Sprintf("model load progress %0.2f", s.loadProgress))
				stallTimer = time.Now().Add(stallDuration)
599
600
			} else if !fullyLoaded && int(s.loadProgress*100.0) >= 100 {
				slog.Debug("model load completed, waiting for server to become available", "status", status.ToString())
601
				stallTimer = time.Now().Add(stallDuration)
602
				fullyLoaded = true
Daniel Hiltgen's avatar
Daniel Hiltgen committed
603
			}
ManniX-ITA's avatar
ManniX-ITA committed
604
605
			time.Sleep(time.Millisecond * 250)
			continue
606
607
608
609
		}
	}
}

610
var grammarJSON = `
611
612
613
614
615
616
617
618
619
620
621
622
623
624
root   ::= object
value  ::= object | array | string | number | ("true" | "false" | "null") ws
object ::=
  "{" ws (
            string ":" ws value
    ("," ws string ":" ws value)*
  )? "}" ws
array  ::=
  "[" ws (
            value
    ("," ws value)*
  )? "]" ws
string ::=
  "\"" (
625
    [^"\\\x7F\x00-\x1F] |
626
627
628
629
630
631
632
633
634
635
    "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F]) # escapes
  )* "\"" ws
number ::= ("-"? ([0-9] | [1-9] [0-9]*)) ("." [0-9]+)? ([eE] [-+]? [0-9]+)? ws
# Optional space: by convention, applied in this grammar after literal chars when allowed
ws ::= ([ \t\n] ws)?
`

const maxBufferSize = 512 * format.KiloByte

type ImageData struct {
636
637
638
	Data          []byte `json:"data"`
	ID            int    `json:"id"`
	AspectRatioID int    `json:"aspect_ratio_id"`
639
640
641
}

type completion struct {
642
643
644
645
646
	Content      string `json:"content"`
	Model        string `json:"model"`
	Prompt       string `json:"prompt"`
	Stop         bool   `json:"stop"`
	StoppedLimit bool   `json:"stopped_limit"`
647
648
649
650
651
652
653
654
655
656
657

	Timings struct {
		PredictedN  int     `json:"predicted_n"`
		PredictedMS float64 `json:"predicted_ms"`
		PromptN     int     `json:"prompt_n"`
		PromptMS    float64 `json:"prompt_ms"`
	}
}

type CompletionRequest struct {
	Prompt  string
658
	Format  json.RawMessage
659
	Images  []ImageData
Michael Yang's avatar
Michael Yang committed
660
	Options *api.Options
661
662
663
664
}

type CompletionResponse struct {
	Content            string
665
	DoneReason         string
666
667
668
669
670
671
672
	Done               bool
	PromptEvalCount    int
	PromptEvalDuration time.Duration
	EvalCount          int
	EvalDuration       time.Duration
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
673
func (s *llmServer) Completion(ctx context.Context, req CompletionRequest, fn func(CompletionResponse)) error {
674
675
676
677
678
679
680
681
682
	request := map[string]any{
		"prompt":            req.Prompt,
		"stream":            true,
		"n_predict":         req.Options.NumPredict,
		"n_keep":            req.Options.NumKeep,
		"main_gpu":          req.Options.MainGPU,
		"temperature":       req.Options.Temperature,
		"top_k":             req.Options.TopK,
		"top_p":             req.Options.TopP,
683
		"min_p":             req.Options.MinP,
684
685
686
687
688
689
690
691
692
693
694
695
696
697
		"typical_p":         req.Options.TypicalP,
		"repeat_last_n":     req.Options.RepeatLastN,
		"repeat_penalty":    req.Options.RepeatPenalty,
		"presence_penalty":  req.Options.PresencePenalty,
		"frequency_penalty": req.Options.FrequencyPenalty,
		"mirostat":          req.Options.Mirostat,
		"mirostat_tau":      req.Options.MirostatTau,
		"mirostat_eta":      req.Options.MirostatEta,
		"seed":              req.Options.Seed,
		"stop":              req.Options.Stop,
		"image_data":        req.Images,
		"cache_prompt":      true,
	}

698
	if len(req.Format) > 0 {
699
700
701
702
703
704
		switch string(req.Format) {
		case `null`, `""`:
			// Field was set, but "missing" a value. We accept
			// these as "not set".
			break
		case `"json"`:
705
			request["grammar"] = grammarJSON
706
707
708
709
710
		default:
			if req.Format[0] != '{' {
				return fmt.Errorf("invalid format: %q; expected \"json\" or a valid JSON Schema object", req.Format)
			}

711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
			// User provided a JSON schema
			g := llama.SchemaToGrammar(req.Format)
			if g == nil {
				return fmt.Errorf("invalid JSON schema in format")
			}
			request["grammar"] = string(g)
		}
	}

	if err := s.sem.Acquire(ctx, 1); err != nil {
		if errors.Is(err, context.Canceled) {
			slog.Info("aborting completion request due to client closing the connection")
		} else {
			slog.Error("Failed to acquire semaphore", "error", err)
		}
		return err
	}
	defer s.sem.Release(1)

	// put an upper limit on num_predict to avoid the model running on forever
	if req.Options.NumPredict < 0 || req.Options.NumPredict > 10*s.options.NumCtx {
		req.Options.NumPredict = 10 * s.options.NumCtx
	}

735
	// Make sure the server is ready
736
	status, err := s.getServerStatusRetry(ctx)
737
738
739
	if err != nil {
		return err
	} else if status != ServerStatusReady {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
740
		return fmt.Errorf("unexpected server status: %s", status.ToString())
741
742
	}

743
744
745
746
	// Handling JSON marshaling with special characters unescaped.
	buffer := &bytes.Buffer{}
	enc := json.NewEncoder(buffer)
	enc.SetEscapeHTML(false)
747

748
749
750
	if err := enc.Encode(request); err != nil {
		return fmt.Errorf("failed to marshal data: %v", err)
	}
751

752
753
754
755
756
757
	endpoint := fmt.Sprintf("http://127.0.0.1:%d/completion", s.port)
	serverReq, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, buffer)
	if err != nil {
		return fmt.Errorf("error creating POST request: %v", err)
	}
	serverReq.Header.Set("Content-Type", "application/json")
758

759
760
761
762
763
	res, err := http.DefaultClient.Do(serverReq)
	if err != nil {
		return fmt.Errorf("POST predict: %v", err)
	}
	defer res.Body.Close()
764

765
766
	if res.StatusCode >= 400 {
		bodyBytes, err := io.ReadAll(res.Body)
767
		if err != nil {
768
			return fmt.Errorf("failed reading llm error response: %w", err)
769
		}
770
771
772
		log.Printf("llm predict error: %s", bodyBytes)
		return fmt.Errorf("%s", bodyBytes)
	}
773

774
775
776
	scanner := bufio.NewScanner(res.Body)
	buf := make([]byte, 0, maxBufferSize)
	scanner.Buffer(buf, maxBufferSize)
777

778
779
780
	// keep track of the last token generated, this is used to abort if the model starts looping
	var lastToken string
	var tokenRepeat int
781

782
783
784
785
786
787
788
789
790
791
	for scanner.Scan() {
		select {
		case <-ctx.Done():
			// This handles the request cancellation
			return ctx.Err()
		default:
			line := scanner.Bytes()
			if len(line) == 0 {
				continue
			}
792

793
			// slog.Debug("got line", "line", string(line))
794
795
			evt, ok := bytes.CutPrefix(line, []byte("data: "))
			if !ok {
796
				evt = line
797
			}
798

799
800
			var c completion
			if err := json.Unmarshal(evt, &c); err != nil {
801
				return fmt.Errorf("error unmarshalling llm prediction response: %v", err)
802
803
804
805
806
807
808
809
			}
			switch {
			case strings.TrimSpace(c.Content) == lastToken:
				tokenRepeat++
			default:
				lastToken = strings.TrimSpace(c.Content)
				tokenRepeat = 0
			}
810

811
812
813
814
815
			// 30 picked as an arbitrary max token repeat limit, modify as needed
			if tokenRepeat > 30 {
				slog.Debug("prediction aborted, token repeat limit reached")
				return ctx.Err()
			}
816

817
818
819
820
821
			if c.Content != "" {
				fn(CompletionResponse{
					Content: c.Content,
				})
			}
822

823
			if c.Stop {
824
825
826
827
828
				doneReason := "stop"
				if c.StoppedLimit {
					doneReason = "length"
				}

829
830
				fn(CompletionResponse{
					Done:               true,
831
					DoneReason:         doneReason,
832
833
834
835
836
837
					PromptEvalCount:    c.Timings.PromptN,
					PromptEvalDuration: parseDurationMs(c.Timings.PromptMS),
					EvalCount:          c.Timings.PredictedN,
					EvalDuration:       parseDurationMs(c.Timings.PredictedMS),
				})
				return nil
838
839
			}
		}
840
	}
841

842
	if err := scanner.Err(); err != nil {
843
		if strings.Contains(err.Error(), "unexpected EOF") || strings.Contains(err.Error(), "forcibly closed") {
844
			s.Close()
845
			var msg string
846
847
			if s.status != nil && s.status.LastErrMsg != "" {
				msg = s.status.LastErrMsg
848
849
			} else {
				msg = err.Error()
850
			}
851
			return fmt.Errorf("an error was encountered while running the model: %s", msg)
852
853
		}

854
		return fmt.Errorf("error reading llm response: %v", err)
855
856
	}

857
	return nil
858
859
}

860
861
type EmbeddingRequest struct {
	Content string `json:"content"`
862
863
}

864
865
type EmbeddingResponse struct {
	Embedding []float32 `json:"embedding"`
866
867
}

868
869
func (s *llmServer) Embedding(ctx context.Context, input string) ([]float32, error) {
	if err := s.sem.Acquire(ctx, 1); err != nil {
870
871
872
873
874
		if errors.Is(err, context.Canceled) {
			slog.Info("aborting embedding request due to client closing the connection")
		} else {
			slog.Error("Failed to acquire semaphore", "error", err)
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
875
876
		return nil, err
	}
877
	defer s.sem.Release(1)
878

879
	// Make sure the server is ready
880
	status, err := s.getServerStatusRetry(ctx)
881
882
883
	if err != nil {
		return nil, err
	} else if status != ServerStatusReady {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
884
		return nil, fmt.Errorf("unexpected server status: %s", status.ToString())
885
886
	}

887
	data, err := json.Marshal(EmbeddingRequest{Content: input})
Michael Yang's avatar
Michael Yang committed
888
	if err != nil {
889
890
891
		return nil, fmt.Errorf("error marshaling embed data: %w", err)
	}

892
	r, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/embedding", s.port), bytes.NewBuffer(data))
893
894
895
	if err != nil {
		return nil, fmt.Errorf("error creating embed request: %w", err)
	}
896
	r.Header.Set("Content-Type", "application/json")
897

898
	resp, err := http.DefaultClient.Do(r)
899
900
901
902
903
904
905
906
907
908
909
	if err != nil {
		return nil, fmt.Errorf("do embedding request: %w", err)
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return nil, fmt.Errorf("error reading embed response: %w", err)
	}

	if resp.StatusCode >= 400 {
910
		log.Printf("llm embedding error: %s", body)
911
912
913
		return nil, fmt.Errorf("%s", body)
	}

914
	var e EmbeddingResponse
915
	if err := json.Unmarshal(body, &e); err != nil {
916
917
918
		return nil, fmt.Errorf("unmarshal tokenize response: %w", err)
	}

919
	return e.Embedding, nil
920
921
}

Michael Yang's avatar
Michael Yang committed
922
923
924
925
926
927
928
929
type TokenizeRequest struct {
	Content string `json:"content"`
}

type TokenizeResponse struct {
	Tokens []int `json:"tokens"`
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
930
func (s *llmServer) Tokenize(ctx context.Context, content string) ([]int, error) {
931
932
933
934
935
936
	s.modelLock.Lock()
	defer s.modelLock.Unlock()
	if s.model != nil {
		return s.model.Tokenize(content, false, true)
	}

Michael Yang's avatar
Michael Yang committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
	// Make sure the server is ready
	status, err := s.getServerStatus(ctx)
	if err != nil {
		return nil, err
	} else if status != ServerStatusReady && status != ServerStatusNoSlotsAvailable {
		return nil, fmt.Errorf("unexpected server status: %s", status.ToString())
	}

	data, err := json.Marshal(TokenizeRequest{Content: content})
	if err != nil {
		return nil, fmt.Errorf("marshaling encode data: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/tokenize", s.port), bytes.NewBuffer(data))
	if err != nil {
		return nil, fmt.Errorf("encode request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return nil, fmt.Errorf("do encode request: %w", err)
	}
	defer resp.Body.Close()
961
962
963
	if resp.StatusCode == http.StatusNotFound {
		if s.model == nil {
			slog.Debug("new runner detected, loading model for cgo tokenization")
964
965
966
967
			m, err := llama.LoadModelFromFile(s.modelPath, llama.ModelParams{VocabOnly: true})
			if err != nil {
				return nil, err
			}
968
969
970
971
			s.model = m
		}
		return s.model.Tokenize(content, false, true)
	}
Michael Yang's avatar
Michael Yang committed
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return nil, fmt.Errorf("read encode request: %w", err)
	}

	if resp.StatusCode >= 400 {
		log.Printf("llm encode error: %s", body)
		return nil, fmt.Errorf("%s", body)
	}

	var encoded TokenizeResponse
	if err := json.Unmarshal(body, &encoded); err != nil {
		return nil, fmt.Errorf("unmarshal encode response: %w", err)
	}

	return encoded.Tokens, nil
}

type DetokenizeRequest struct {
	Tokens []int `json:"tokens"`
}

type DetokenizeResponse struct {
	Content string `json:"content"`
997
998
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
999
func (s *llmServer) Detokenize(ctx context.Context, tokens []int) (string, error) {
1000
1001
1002
1003
1004
1005
1006
1007
1008
	s.modelLock.Lock()
	defer s.modelLock.Unlock()
	if s.model != nil {
		var resp string
		for _, token := range tokens {
			resp += s.model.TokenToPiece(token)
		}
		return resp, nil
	}
Michael Yang's avatar
Michael Yang committed
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
	// Make sure the server is ready
	status, err := s.getServerStatus(ctx)
	if err != nil {
		return "", err
	} else if status != ServerStatusReady && status != ServerStatusNoSlotsAvailable {
		return "", fmt.Errorf("unexpected server status: %s", status.ToString())
	}

	data, err := json.Marshal(DetokenizeRequest{Tokens: tokens})
	if err != nil {
		return "", fmt.Errorf("marshaling decode data: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://127.0.0.1:%d/detokenize", s.port), bytes.NewBuffer(data))
	if err != nil {
		return "", fmt.Errorf("decode request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return "", fmt.Errorf("do decode request: %w", err)
	}
	defer resp.Body.Close()
1033
1034
1035
	if resp.StatusCode == http.StatusNotFound {
		if s.model == nil {
			slog.Debug("new runner detected, loading model for cgo tokenization")
1036
1037
1038
1039
			m, err := llama.LoadModelFromFile(s.modelPath, llama.ModelParams{VocabOnly: true})
			if err != nil {
				return "", err
			}
1040
1041
1042
1043
1044
1045
1046
1047
			s.model = m
		}
		var resp string
		for _, token := range tokens {
			resp += s.model.TokenToPiece(token)
		}
		return resp, nil
	}
Michael Yang's avatar
Michael Yang committed
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return "", fmt.Errorf("read decode request: %w", err)
	}

	if resp.StatusCode >= 400 {
		log.Printf("llm decode error: %s", body)
		return "", fmt.Errorf("%s", body)
	}

	var decoded DetokenizeResponse
	if err := json.Unmarshal(body, &decoded); err != nil {
		return "", fmt.Errorf("unmarshal encode response: %w", err)
	}

	return decoded.Content, nil
1065
1066
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1067
func (s *llmServer) Close() error {
1068
	s.modelLock.Lock()
1069
1070
1071
1072
	if s.model != nil {
		llama.FreeModel(s.model)
		s.model = nil
	}
1073
1074
	s.modelLock.Unlock()

1075
1076
	if s.cmd != nil {
		slog.Debug("stopping llama server")
1077
1078
1079
		if err := s.cmd.Process.Kill(); err != nil {
			return err
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1080
1081
1082
1083
1084
		// if ProcessState is already populated, Wait already completed, no need to wait again
		if s.cmd.ProcessState == nil {
			slog.Debug("waiting for llama server to exit")
			<-s.done
		}
1085
1086

		slog.Debug("llama server stopped")
1087
1088
1089
1090
1091
	}

	return nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1092
func (s *llmServer) EstimatedVRAM() uint64 {
1093
	return s.estimate.VRAMSize
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1094
1095
}

1096
func (s *llmServer) EstimatedTotal() uint64 {
1097
	return s.estimate.TotalSize
1098
1099
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1100
func (s *llmServer) EstimatedVRAMByGPU(gpuID string) uint64 {
1101
1102
	for i, gpu := range s.gpus {
		if gpu.ID == gpuID {
1103
1104
1105
			if i < len(s.estimate.GPUSizes) {
				return s.estimate.GPUSizes[i]
			}
1106
1107
1108
1109
1110
		}
	}
	return 0
}

1111
1112
1113
1114
1115
1116
1117
1118
func parseDurationMs(ms float64) time.Duration {
	dur, err := time.ParseDuration(fmt.Sprintf("%fms", ms))
	if err != nil {
		panic(err)
	}

	return dur
}