123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416 |
- package server
- import (
- "bufio"
- "bytes"
- "context"
- "crypto/sha256"
- "encoding/json"
- "errors"
- "fmt"
- "html/template"
- "io"
- "log"
- "net/http"
- "os"
- "path"
- "path/filepath"
- "reflect"
- "strconv"
- "strings"
- "github.com/jmorganca/ollama/api"
- "github.com/jmorganca/ollama/llm"
- "github.com/jmorganca/ollama/parser"
- "github.com/jmorganca/ollama/vector"
- )
- const MaxRetries = 3
- type RegistryOptions struct {
- Insecure bool
- Username string
- Password string
- Token string
- }
- type Model struct {
- Name string `json:"name"`
- ModelPath string
- AdapterPaths []string
- Template string
- System string
- Digest string
- Options map[string]interface{}
- Embeddings []vector.Embedding
- }
- func (m *Model) Prompt(request api.GenerateRequest, embedding string) (string, error) {
- t := m.Template
- if request.Template != "" {
- t = request.Template
- }
- tmpl, err := template.New("").Parse(t)
- if err != nil {
- return "", err
- }
- var vars struct {
- First bool
- System string
- Prompt string
- Embed string
- // deprecated: versions <= 0.0.7 used this to omit the system prompt
- Context []int
- }
- vars.First = len(request.Context) == 0
- vars.System = m.System
- vars.Prompt = request.Prompt
- vars.Context = request.Context
- vars.Embed = embedding
- if request.System != "" {
- vars.System = request.System
- }
- var sb strings.Builder
- if err := tmpl.Execute(&sb, vars); err != nil {
- return "", err
- }
- return sb.String(), nil
- }
- type ManifestV2 struct {
- SchemaVersion int `json:"schemaVersion"`
- MediaType string `json:"mediaType"`
- Config Layer `json:"config"`
- Layers []*Layer `json:"layers"`
- }
- type Layer struct {
- MediaType string `json:"mediaType"`
- Digest string `json:"digest"`
- Size int `json:"size"`
- From string `json:"from,omitempty"`
- }
- type LayerReader struct {
- Layer
- io.Reader
- }
- type ConfigV2 struct {
- ModelFamily llm.ModelFamily `json:"model_family"`
- ModelType string `json:"model_type"`
- FileType string `json:"file_type"`
- RootFS RootFS `json:"rootfs"`
- // required by spec
- Architecture string `json:"architecture"`
- OS string `json:"os"`
- }
- type RootFS struct {
- Type string `json:"type"`
- DiffIDs []string `json:"diff_ids"`
- }
- func (m *ManifestV2) GetTotalSize() int {
- var total int
- for _, layer := range m.Layers {
- total += layer.Size
- }
- total += m.Config.Size
- return total
- }
- func GetManifest(mp ModelPath) (*ManifestV2, error) {
- fp, err := mp.GetManifestPath(false)
- if err != nil {
- return nil, err
- }
- if _, err = os.Stat(fp); err != nil {
- return nil, err
- }
- var manifest *ManifestV2
- bts, err := os.ReadFile(fp)
- if err != nil {
- return nil, fmt.Errorf("couldn't open file '%s'", fp)
- }
- if err := json.Unmarshal(bts, &manifest); err != nil {
- return nil, err
- }
- return manifest, nil
- }
- func GetModel(name string) (*Model, error) {
- mp, err := ParseModelPath(name, false)
- if err != nil {
- return nil, err
- }
- manifest, err := GetManifest(mp)
- if err != nil {
- return nil, err
- }
- model := &Model{
- Name: mp.GetFullTagname(),
- Digest: manifest.Config.Digest,
- }
- for _, layer := range manifest.Layers {
- filename, err := GetBlobsPath(layer.Digest)
- if err != nil {
- return nil, err
- }
- switch layer.MediaType {
- case "application/vnd.ollama.image.model":
- model.ModelPath = filename
- case "application/vnd.ollama.image.embed":
- file, err := os.Open(filename)
- if err != nil {
- return nil, fmt.Errorf("failed to open file: %s", filename)
- }
- defer file.Close()
- if err = json.NewDecoder(file).Decode(&model.Embeddings); err != nil {
- return nil, err
- }
- case "application/vnd.ollama.image.adapter":
- model.AdapterPaths = append(model.AdapterPaths, filename)
- case "application/vnd.ollama.image.template":
- bts, err := os.ReadFile(filename)
- if err != nil {
- return nil, err
- }
- model.Template = string(bts)
- case "application/vnd.ollama.image.system":
- bts, err := os.ReadFile(filename)
- if err != nil {
- return nil, err
- }
- model.System = string(bts)
- case "application/vnd.ollama.image.prompt":
- bts, err := os.ReadFile(filename)
- if err != nil {
- return nil, err
- }
- model.Template = string(bts)
- case "application/vnd.ollama.image.params":
- params, err := os.Open(filename)
- if err != nil {
- return nil, err
- }
- defer params.Close()
- // parse model options parameters into a map so that we can see which fields have been specified explicitly
- if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
- return nil, err
- }
- }
- }
- return model, nil
- }
- func filenameWithPath(path, f string) (string, error) {
- // if filePath starts with ~/, replace it with the user's home directory.
- if strings.HasPrefix(f, "~/") {
- parts := strings.Split(f, "/")
- home, err := os.UserHomeDir()
- if err != nil {
- return "", fmt.Errorf("failed to open file: %v", err)
- }
- f = filepath.Join(home, filepath.Join(parts[1:]...))
- }
- // if filePath is not an absolute path, make it relative to the modelfile path
- if !filepath.IsAbs(f) {
- f = filepath.Join(filepath.Dir(path), f)
- }
- return f, nil
- }
- func CreateModel(ctx context.Context, name string, path string, fn func(resp api.ProgressResponse)) error {
- mf, err := os.Open(path)
- if err != nil {
- fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
- return fmt.Errorf("failed to open file: %w", err)
- }
- defer mf.Close()
- fn(api.ProgressResponse{Status: "parsing modelfile"})
- commands, err := parser.Parse(mf)
- if err != nil {
- return err
- }
- config := ConfigV2{
- Architecture: "amd64",
- OS: "linux",
- }
- var layers []*LayerReader
- params := make(map[string][]string)
- embed := EmbeddingParams{fn: fn}
- for _, c := range commands {
- log.Printf("[%s] - %s\n", c.Name, c.Args)
- switch c.Name {
- case "model":
- fn(api.ProgressResponse{Status: "looking for model"})
- embed.model = c.Args
- mp, err := ParseModelPath(c.Args, false)
- if err != nil {
- return err
- }
- mf, err := GetManifest(mp)
- if err != nil {
- modelFile, err := filenameWithPath(path, c.Args)
- if err != nil {
- return err
- }
- if _, err := os.Stat(modelFile); err != nil {
- // the model file does not exist, try pulling it
- if errors.Is(err, os.ErrNotExist) {
- fn(api.ProgressResponse{Status: "pulling model file"})
- if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
- return err
- }
- mf, err = GetManifest(mp)
- if err != nil {
- return fmt.Errorf("failed to open file after pull: %v", err)
- }
- } else {
- return err
- }
- } else {
- embed.model = modelFile
- // create a model from this specified file
- fn(api.ProgressResponse{Status: "creating model layer"})
- file, err := os.Open(modelFile)
- if err != nil {
- return fmt.Errorf("failed to open file: %v", err)
- }
- defer file.Close()
- ggml, err := llm.DecodeGGML(file, llm.ModelFamilyLlama)
- if err != nil {
- return err
- }
- config.ModelFamily = ggml.ModelFamily()
- config.ModelType = ggml.ModelType().String()
- config.FileType = ggml.FileType().String()
- // reset the file
- file.Seek(0, io.SeekStart)
- l, err := CreateLayer(file)
- if err != nil {
- return fmt.Errorf("failed to create layer: %v", err)
- }
- l.MediaType = "application/vnd.ollama.image.model"
- layers = append(layers, l)
- }
- }
- if mf != nil {
- sourceBlobPath, err := GetBlobsPath(mf.Config.Digest)
- if err != nil {
- return err
- }
- sourceBlob, err := os.Open(sourceBlobPath)
- if err != nil {
- return err
- }
- defer sourceBlob.Close()
- var source ConfigV2
- if err := json.NewDecoder(sourceBlob).Decode(&source); err != nil {
- return err
- }
- // copie the model metadata
- config.ModelFamily = source.ModelFamily
- config.ModelType = source.ModelType
- config.FileType = source.FileType
- for _, l := range mf.Layers {
- newLayer, err := GetLayerWithBufferFromLayer(l)
- if err != nil {
- return err
- }
- newLayer.From = mp.GetNamespaceRepository()
- layers = append(layers, newLayer)
- }
- }
- case "embed":
- embedFilePath, err := filenameWithPath(path, c.Args)
- if err != nil {
- return err
- }
- embed.files = append(embed.files, embedFilePath)
- case "adapter":
- fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
- fp := c.Args
- if strings.HasPrefix(fp, "~/") {
- parts := strings.Split(fp, "/")
- home, err := os.UserHomeDir()
- if err != nil {
- return fmt.Errorf("failed to open file: %v", err)
- }
- fp = filepath.Join(home, filepath.Join(parts[1:]...))
- }
- // If filePath is not an absolute path, make it relative to the modelfile path
- if !filepath.IsAbs(fp) {
- fp = filepath.Join(filepath.Dir(path), fp)
- }
- // create a model from this specified file
- fn(api.ProgressResponse{Status: "creating model layer"})
- file, err := os.Open(fp)
- if err != nil {
- return fmt.Errorf("failed to open file: %v", err)
- }
- defer file.Close()
- l, err := CreateLayer(file)
- if err != nil {
- return fmt.Errorf("failed to create layer: %v", err)
- }
- l.MediaType = "application/vnd.ollama.image.adapter"
- layers = append(layers, l)
- case "license":
- fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
- mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
- layer, err := CreateLayer(strings.NewReader(c.Args))
- if err != nil {
- return err
- }
- layer.MediaType = mediaType
- layers = append(layers, layer)
- case "template", "system", "prompt":
- fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
- // remove the layer if one exists
- mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
- layers = removeLayerFromLayers(layers, mediaType)
- layer, err := CreateLayer(strings.NewReader(c.Args))
- if err != nil {
- return err
- }
- layer.MediaType = mediaType
- layers = append(layers, layer)
- default:
- // runtime parameters, build a list of args for each parameter to allow multiple values to be specified (ex: multiple stop tokens)
- params[c.Name] = append(params[c.Name], c.Args)
- }
- }
- // Create a single layer for the parameters
- if len(params) > 0 {
- fn(api.ProgressResponse{Status: "creating parameter layer"})
- layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
- formattedParams, err := formatParams(params)
- if err != nil {
- return fmt.Errorf("couldn't create params json: %v", err)
- }
- bts, err := json.Marshal(formattedParams)
- if err != nil {
- return err
- }
- l, err := CreateLayer(bytes.NewReader(bts))
- if err != nil {
- return fmt.Errorf("failed to create layer: %v", err)
- }
- l.MediaType = "application/vnd.ollama.image.params"
- layers = append(layers, l)
- // apply these parameters to the embedding options, in case embeddings need to be generated using this model
- embed.opts = formattedParams
- }
- // generate the embedding layers
- embeddingLayers, err := embeddingLayers(embed)
- if err != nil {
- return err
- }
- layers = append(layers, embeddingLayers...)
- digests, err := getLayerDigests(layers)
- if err != nil {
- return err
- }
- var manifestLayers []*Layer
- for _, l := range layers {
- manifestLayers = append(manifestLayers, &l.Layer)
- }
- // Create a layer for the config object
- fn(api.ProgressResponse{Status: "creating config layer"})
- cfg, err := createConfigLayer(config, digests)
- if err != nil {
- return err
- }
- layers = append(layers, cfg)
- if err := SaveLayers(layers, fn, false); err != nil {
- return err
- }
- // Create the manifest
- fn(api.ProgressResponse{Status: "writing manifest"})
- err = CreateManifest(name, cfg, manifestLayers)
- if err != nil {
- return err
- }
- fn(api.ProgressResponse{Status: "success"})
- return nil
- }
- type EmbeddingParams struct {
- model string
- opts map[string]interface{}
- files []string // paths to files to embed
- fn func(resp api.ProgressResponse)
- }
- // embeddingLayers loads the associated LLM and generates the embeddings to be stored from an input file
- func embeddingLayers(e EmbeddingParams) ([]*LayerReader, error) {
- layers := []*LayerReader{}
- if len(e.files) > 0 {
- // check if the model is a file path or a model name
- model, err := GetModel(e.model)
- if err != nil {
- if !strings.Contains(err.Error(), "couldn't open file") {
- return nil, fmt.Errorf("unexpected error opening model to generate embeddings: %v", err)
- }
- // the model may be a file path, create a model from this file
- model = &Model{ModelPath: e.model}
- }
- if err := load(model, e.opts, defaultSessionDuration); err != nil {
- return nil, fmt.Errorf("load model to generate embeddings: %v", err)
- }
- // this will be used to check if we already have embeddings for a file
- modelInfo, err := os.Stat(model.ModelPath)
- if err != nil {
- return nil, fmt.Errorf("failed to get model file info: %v", err)
- }
- addedFiles := make(map[string]bool) // keep track of files that have already been added
- for _, filePattern := range e.files {
- matchingFiles, err := filepath.Glob(filePattern)
- if err != nil {
- return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
- }
- for _, filePath := range matchingFiles {
- if addedFiles[filePath] {
- continue
- }
- addedFiles[filePath] = true
- // check if we already have embeddings for this file path
- layerIdentifier := fmt.Sprintf("%s:%s:%s:%d", filePath, e.model, modelInfo.ModTime().Format("2006-01-02 15:04:05"), modelInfo.Size())
- digest, _ := GetSHA256Digest(strings.NewReader(layerIdentifier))
- existing, err := existingFileEmbeddings(digest)
- if err != nil {
- return nil, fmt.Errorf("failed to check existing embeddings for file %s: %v", filePath, err)
- }
- // TODO: check file type
- f, err := os.Open(filePath)
- if err != nil {
- return nil, fmt.Errorf("could not open embed file: %w", err)
- }
- scanner := bufio.NewScanner(f)
- scanner.Split(bufio.ScanLines)
- data := []string{}
- for scanner.Scan() {
- data = append(data, scanner.Text())
- }
- f.Close()
- // the digest of the file is set here so that the client knows a new operation is in progress
- fileDigest, _ := GetSHA256Digest(bytes.NewReader([]byte(filePath)))
- embeddings := []vector.Embedding{}
- for i, d := range data {
- if strings.TrimSpace(d) == "" {
- continue
- }
- e.fn(api.ProgressResponse{
- Status: fmt.Sprintf("creating embeddings for file %s", filePath),
- Digest: fileDigest,
- Total: len(data) - 1,
- Completed: i,
- })
- if len(existing[d]) > 0 {
- // already have an embedding for this line
- embeddings = append(embeddings, vector.Embedding{Data: d, Vector: existing[d]})
- continue
- }
- embed, err := loaded.llm.Embedding(d)
- if err != nil {
- log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
- continue
- }
- embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
- }
- b, err := json.Marshal(embeddings)
- if err != nil {
- return nil, fmt.Errorf("failed to encode embeddings: %w", err)
- }
- r := bytes.NewReader(b)
- layer := &LayerReader{
- Layer: Layer{
- MediaType: "application/vnd.ollama.image.embed",
- Digest: digest,
- Size: r.Len(),
- },
- Reader: r,
- }
- layers = append(layers, layer)
- }
- }
- }
- return layers, nil
- }
- // existingFileEmbeddings checks if we already have embeddings for a file and loads them into a look-up map
- func existingFileEmbeddings(digest string) (map[string][]float64, error) {
- path, err := GetBlobsPath(digest)
- if err != nil {
- return nil, fmt.Errorf("embeddings blobs path: %w", err)
- }
- existingFileEmbeddings := make(map[string][]float64)
- if _, err := os.Stat(path); err == nil {
- // already have some embeddings for this file, load embeddings previously generated
- file, err := os.Open(path)
- if err != nil {
- return nil, fmt.Errorf("failed to open existing embedding file: %s", err)
- }
- defer file.Close()
- existing := []vector.Embedding{}
- if err = json.NewDecoder(file).Decode(&existing); err != nil {
- return nil, err
- }
- for _, e := range existing {
- existingFileEmbeddings[e.Data] = e.Vector
- }
- }
- return existingFileEmbeddings, nil
- }
- func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
- j := 0
- for _, l := range layers {
- if l.MediaType != mediaType {
- layers[j] = l
- j++
- }
- }
- return layers[:j]
- }
- func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
- // Write each of the layers to disk
- for _, layer := range layers {
- fp, err := GetBlobsPath(layer.Digest)
- if err != nil {
- return err
- }
- _, err = os.Stat(fp)
- // note: embed layers are always written since their digest doesnt indicate anything about the contents
- if os.IsNotExist(err) || force || layer.MediaType == "application/vnd.ollama.image.embed" {
- fn(api.ProgressResponse{Status: fmt.Sprintf("writing layer %s", layer.Digest)})
- out, err := os.Create(fp)
- if err != nil {
- log.Printf("couldn't create %s", fp)
- return err
- }
- defer out.Close()
- if _, err = io.Copy(out, layer.Reader); err != nil {
- return err
- }
- } else {
- fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
- }
- }
- return nil
- }
- func CreateManifest(name string, cfg *LayerReader, layers []*Layer) error {
- mp, err := ParseModelPath(name, false)
- if err != nil {
- return err
- }
- manifest := ManifestV2{
- SchemaVersion: 2,
- MediaType: "application/vnd.docker.distribution.manifest.v2+json",
- Config: Layer{
- MediaType: cfg.MediaType,
- Size: cfg.Size,
- Digest: cfg.Digest,
- },
- Layers: layers,
- }
- manifestJSON, err := json.Marshal(manifest)
- if err != nil {
- return err
- }
- fp, err := mp.GetManifestPath(true)
- if err != nil {
- return err
- }
- return os.WriteFile(fp, manifestJSON, 0o644)
- }
- func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
- fp, err := GetBlobsPath(layer.Digest)
- if err != nil {
- return nil, err
- }
- file, err := os.Open(fp)
- if err != nil {
- return nil, fmt.Errorf("could not open blob: %w", err)
- }
- defer file.Close()
- newLayer, err := CreateLayer(file)
- if err != nil {
- return nil, err
- }
- newLayer.MediaType = layer.MediaType
- return newLayer, nil
- }
- // formatParams converts specified parameter options to their correct types
- func formatParams(params map[string][]string) (map[string]interface{}, error) {
- opts := api.Options{}
- valueOpts := reflect.ValueOf(&opts).Elem() // names of the fields in the options struct
- typeOpts := reflect.TypeOf(opts) // types of the fields in the options struct
- // build map of json struct tags to their types
- jsonOpts := make(map[string]reflect.StructField)
- for _, field := range reflect.VisibleFields(typeOpts) {
- jsonTag := strings.Split(field.Tag.Get("json"), ",")[0]
- if jsonTag != "" {
- jsonOpts[jsonTag] = field
- }
- }
- out := make(map[string]interface{})
- // iterate params and set values based on json struct tags
- for key, vals := range params {
- if opt, ok := jsonOpts[key]; ok {
- field := valueOpts.FieldByName(opt.Name)
- if field.IsValid() && field.CanSet() {
- switch field.Kind() {
- case reflect.Float32:
- floatVal, err := strconv.ParseFloat(vals[0], 32)
- if err != nil {
- return nil, fmt.Errorf("invalid float value %s", vals)
- }
- out[key] = floatVal
- case reflect.Int:
- intVal, err := strconv.ParseInt(vals[0], 10, 0)
- if err != nil {
- return nil, fmt.Errorf("invalid int value %s", vals)
- }
- out[key] = intVal
- case reflect.Bool:
- boolVal, err := strconv.ParseBool(vals[0])
- if err != nil {
- return nil, fmt.Errorf("invalid bool value %s", vals)
- }
- out[key] = boolVal
- case reflect.String:
- out[key] = vals[0]
- case reflect.Slice:
- // TODO: only string slices are supported right now
- out[key] = vals
- default:
- return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
- }
- }
- }
- }
- return out, nil
- }
- func getLayerDigests(layers []*LayerReader) ([]string, error) {
- var digests []string
- for _, l := range layers {
- if l.Digest == "" {
- return nil, fmt.Errorf("layer is missing a digest")
- }
- digests = append(digests, l.Digest)
- }
- return digests, nil
- }
- // CreateLayer creates a Layer object from a given file
- func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
- digest, size := GetSHA256Digest(f)
- f.Seek(0, io.SeekStart)
- layer := &LayerReader{
- Layer: Layer{
- MediaType: "application/vnd.docker.image.rootfs.diff.tar",
- Digest: digest,
- Size: size,
- },
- Reader: f,
- }
- return layer, nil
- }
- func CopyModel(src, dest string) error {
- srcModelPath, err := ParseModelPath(src, false)
- if err != nil {
- return err
- }
- srcPath, err := srcModelPath.GetManifestPath(false)
- if err != nil {
- return err
- }
- destModelPath, err := ParseModelPath(dest, false)
- if err != nil {
- return err
- }
- destPath, err := destModelPath.GetManifestPath(true)
- if err != nil {
- return err
- }
- // copy the file
- input, err := os.ReadFile(srcPath)
- if err != nil {
- fmt.Println("Error reading file:", err)
- return err
- }
- err = os.WriteFile(destPath, input, 0o644)
- if err != nil {
- fmt.Println("Error reading file:", err)
- return err
- }
- return nil
- }
- func DeleteModel(name string) error {
- mp, err := ParseModelPath(name, false)
- if err != nil {
- return err
- }
- manifest, err := GetManifest(mp)
- if err != nil {
- return err
- }
- deleteMap := make(map[string]bool)
- for _, layer := range manifest.Layers {
- deleteMap[layer.Digest] = true
- }
- deleteMap[manifest.Config.Digest] = true
- fp, err := GetManifestPath()
- if err != nil {
- return err
- }
- err = filepath.Walk(fp, func(path string, info os.FileInfo, err error) error {
- if err != nil {
- return err
- }
- if !info.IsDir() {
- path := path[len(fp)+1:]
- slashIndex := strings.LastIndex(path, "/")
- if slashIndex == -1 {
- return nil
- }
- tag := path[:slashIndex] + ":" + path[slashIndex+1:]
- fmp, err := ParseModelPath(tag, false)
- if err != nil {
- return err
- }
- // skip the manifest we're trying to delete
- if mp.GetFullTagname() == fmp.GetFullTagname() {
- return nil
- }
- // save (i.e. delete from the deleteMap) any files used in other manifests
- manifest, err := GetManifest(fmp)
- if err != nil {
- log.Printf("skipping file: %s", fp)
- return nil
- }
- for _, layer := range manifest.Layers {
- delete(deleteMap, layer.Digest)
- }
- delete(deleteMap, manifest.Config.Digest)
- }
- return nil
- })
- if err != nil {
- return err
- }
- // only delete the files which are still in the deleteMap
- for k, v := range deleteMap {
- if v {
- fp, err := GetBlobsPath(k)
- if err != nil {
- log.Printf("couldn't get file path for '%s': %v", k, err)
- continue
- }
- if err := os.Remove(fp); err != nil {
- log.Printf("couldn't remove file '%s': %v", fp, err)
- continue
- }
- }
- }
- fp, err = mp.GetManifestPath(false)
- if err != nil {
- return err
- }
- err = os.Remove(fp)
- if err != nil {
- log.Printf("couldn't remove manifest file '%s': %v", fp, err)
- return err
- }
- return nil
- }
- func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
- mp, err := ParseModelPath(name, regOpts.Insecure)
- if err != nil {
- return err
- }
- fn(api.ProgressResponse{Status: "retrieving manifest"})
- manifest, err := GetManifest(mp)
- if err != nil {
- fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
- return err
- }
- var layers []*Layer
- layers = append(layers, manifest.Layers...)
- layers = append(layers, &manifest.Config)
- for _, layer := range layers {
- exists, err := checkBlobExistence(ctx, mp, layer.Digest, regOpts)
- if err != nil {
- return err
- }
- if exists {
- fn(api.ProgressResponse{
- Status: "using existing layer",
- Digest: layer.Digest,
- Total: layer.Size,
- Completed: layer.Size,
- })
- log.Printf("Layer %s already exists", layer.Digest)
- continue
- }
- fn(api.ProgressResponse{
- Status: "starting upload",
- Digest: layer.Digest,
- Total: layer.Size,
- })
- location, err := startUpload(ctx, mp, layer, regOpts)
- if err != nil {
- log.Printf("couldn't start upload: %v", err)
- return err
- }
- if strings.HasPrefix(path.Base(location), "sha256:") {
- layer.Digest = path.Base(location)
- fn(api.ProgressResponse{
- Status: "using existing layer",
- Digest: layer.Digest,
- Total: layer.Size,
- Completed: layer.Size,
- })
- continue
- }
- if err := uploadBlobChunked(ctx, mp, location, layer, regOpts, fn); err != nil {
- log.Printf("error uploading blob: %v", err)
- return err
- }
- }
- fn(api.ProgressResponse{Status: "pushing manifest"})
- url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
- headers := map[string]string{
- "Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
- }
- manifestJSON, err := json.Marshal(manifest)
- if err != nil {
- return err
- }
- resp, err := makeRequestWithRetry(ctx, "PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
- if err != nil {
- return err
- }
- defer resp.Body.Close()
- fn(api.ProgressResponse{Status: "success"})
- return nil
- }
- func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
- mp, err := ParseModelPath(name, regOpts.Insecure)
- if err != nil {
- return err
- }
- fn(api.ProgressResponse{Status: "pulling manifest"})
- manifest, err := pullModelManifest(ctx, mp, regOpts)
- if err != nil {
- return fmt.Errorf("pull model manifest: %s", err)
- }
- var layers []*Layer
- layers = append(layers, manifest.Layers...)
- layers = append(layers, &manifest.Config)
- for _, layer := range layers {
- if err := downloadBlob(
- ctx,
- downloadOpts{
- mp: mp,
- digest: layer.Digest,
- regOpts: regOpts,
- fn: fn,
- }); err != nil {
- return err
- }
- }
- fn(api.ProgressResponse{Status: "verifying sha256 digest"})
- for _, layer := range layers {
- if err := verifyBlob(layer.Digest); err != nil {
- if errors.Is(err, errDigestMismatch) {
- // something went wrong, delete the blob
- fp, err := GetBlobsPath(layer.Digest)
- if err != nil {
- return err
- }
- if err := os.Remove(fp); err != nil {
- // log this, but return the original error
- log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
- }
- }
- return err
- }
- }
- fn(api.ProgressResponse{Status: "writing manifest"})
- manifestJSON, err := json.Marshal(manifest)
- if err != nil {
- return err
- }
- fp, err := mp.GetManifestPath(true)
- if err != nil {
- return err
- }
- err = os.WriteFile(fp, manifestJSON, 0o644)
- if err != nil {
- log.Printf("couldn't write to %s", fp)
- return err
- }
- fn(api.ProgressResponse{Status: "success"})
- return nil
- }
- func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
- url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
- headers := map[string]string{
- "Accept": "application/vnd.docker.distribution.manifest.v2+json",
- }
- resp, err := makeRequest(ctx, "GET", url, headers, nil, regOpts)
- if err != nil {
- log.Printf("couldn't get manifest: %v", err)
- return nil, err
- }
- defer resp.Body.Close()
- // Check for success: For a successful upload, the Docker registry will respond with a 201 Created
- if resp.StatusCode != http.StatusOK {
- if resp.StatusCode == http.StatusNotFound {
- return nil, fmt.Errorf("model not found")
- }
- body, _ := io.ReadAll(resp.Body)
- return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
- }
- var m *ManifestV2
- if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
- return nil, err
- }
- return m, err
- }
- func createConfigLayer(config ConfigV2, layers []string) (*LayerReader, error) {
- config.RootFS = RootFS{
- Type: "layers",
- DiffIDs: layers,
- }
- configJSON, err := json.Marshal(config)
- if err != nil {
- return nil, err
- }
- digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
- layer := &LayerReader{
- Layer: Layer{
- MediaType: "application/vnd.docker.container.image.v1+json",
- Digest: digest,
- Size: size,
- },
- Reader: bytes.NewBuffer(configJSON),
- }
- return layer, nil
- }
- // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
- func GetSHA256Digest(r io.Reader) (string, int) {
- h := sha256.New()
- n, err := io.Copy(h, r)
- if err != nil {
- log.Fatal(err)
- }
- return fmt.Sprintf("sha256:%x", h.Sum(nil)), int(n)
- }
- type requestContextKey string
- func startUpload(ctx context.Context, mp ModelPath, layer *Layer, regOpts *RegistryOptions) (string, error) {
- url := fmt.Sprintf("%s/v2/%s/blobs/uploads/", mp.Registry, mp.GetNamespaceRepository())
- if layer.From != "" {
- url = fmt.Sprintf("%s/v2/%s/blobs/uploads/?mount=%s&from=%s", mp.Registry, mp.GetNamespaceRepository(), layer.Digest, layer.From)
- }
- resp, err := makeRequestWithRetry(ctx, "POST", url, nil, nil, regOpts)
- if err != nil {
- log.Printf("couldn't start upload: %v", err)
- return "", err
- }
- defer resp.Body.Close()
- // Extract UUID location from header
- location := resp.Header.Get("Location")
- if location == "" {
- return "", fmt.Errorf("location header is missing in response")
- }
- return location, nil
- }
- // Function to check if a blob already exists in the Docker registry
- func checkBlobExistence(ctx context.Context, mp ModelPath, digest string, regOpts *RegistryOptions) (bool, error) {
- url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
- resp, err := makeRequest(ctx, "HEAD", url, nil, nil, regOpts)
- if err != nil {
- log.Printf("couldn't check for blob: %v", err)
- return false, err
- }
- defer resp.Body.Close()
- // Check for success: If the blob exists, the Docker registry will respond with a 200 OK
- return resp.StatusCode == http.StatusOK, nil
- }
- func uploadBlobChunked(ctx context.Context, mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
- // TODO allow resumability
- // TODO allow canceling uploads via DELETE
- fp, err := GetBlobsPath(layer.Digest)
- if err != nil {
- return err
- }
- f, err := os.Open(fp)
- if err != nil {
- return err
- }
- defer f.Close()
- var completed int64
- chunkSize := 10 * 1024 * 1024
- for {
- chunk := int64(layer.Size) - completed
- if chunk > int64(chunkSize) {
- chunk = int64(chunkSize)
- }
- sectionReader := io.NewSectionReader(f, int64(completed), chunk)
- headers := make(map[string]string)
- headers["Content-Type"] = "application/octet-stream"
- headers["Content-Length"] = strconv.Itoa(int(chunk))
- headers["Content-Range"] = fmt.Sprintf("%d-%d", completed, completed+sectionReader.Size()-1)
- resp, err := makeRequestWithRetry(ctx, "PATCH", url, headers, sectionReader, regOpts)
- if err != nil && !errors.Is(err, io.EOF) {
- fn(api.ProgressResponse{
- Status: fmt.Sprintf("error uploading chunk: %v", err),
- Digest: layer.Digest,
- Total: layer.Size,
- Completed: int(completed),
- })
- return err
- }
- defer resp.Body.Close()
- completed += sectionReader.Size()
- fn(api.ProgressResponse{
- Status: fmt.Sprintf("uploading %s", layer.Digest),
- Digest: layer.Digest,
- Total: layer.Size,
- Completed: int(completed),
- })
- url = resp.Header.Get("Location")
- if completed >= int64(layer.Size) {
- break
- }
- }
- url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
- headers := make(map[string]string)
- headers["Content-Type"] = "application/octet-stream"
- headers["Content-Length"] = "0"
- // finish the upload
- resp, err := makeRequest(ctx, "PUT", url, headers, nil, regOpts)
- if err != nil {
- log.Printf("couldn't finish upload: %v", err)
- return err
- }
- defer resp.Body.Close()
- if resp.StatusCode != http.StatusCreated {
- body, _ := io.ReadAll(resp.Body)
- return fmt.Errorf("on finish upload registry responded with code %d: %v", resp.StatusCode, string(body))
- }
- return nil
- }
- func makeRequestWithRetry(ctx context.Context, method, url string, headers map[string]string, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
- var status string
- for try := 0; try < MaxRetries; try++ {
- resp, err := makeRequest(ctx, method, url, headers, body, regOpts)
- if err != nil {
- log.Printf("couldn't start upload: %v", err)
- return nil, err
- }
- status = resp.Status
- switch resp.StatusCode {
- case http.StatusAccepted, http.StatusCreated:
- return resp, nil
- case http.StatusUnauthorized:
- auth := resp.Header.Get("www-authenticate")
- authRedir := ParseAuthRedirectString(auth)
- token, err := getAuthToken(ctx, authRedir, regOpts)
- if err != nil {
- return nil, err
- }
- regOpts.Token = token
- if body != nil {
- if _, err := body.Seek(0, io.SeekStart); err != nil {
- return nil, err
- }
- }
- continue
- default:
- body, _ := io.ReadAll(resp.Body)
- return nil, fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
- }
- }
- return nil, fmt.Errorf("max retry exceeded: %v", status)
- }
- func makeRequest(ctx context.Context, method, url string, headers map[string]string, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
- if !strings.HasPrefix(url, "http") {
- if regOpts.Insecure {
- url = "http://" + url
- } else {
- url = "https://" + url
- }
- }
- req, err := http.NewRequestWithContext(ctx, method, url, body)
- if err != nil {
- return nil, err
- }
- if regOpts.Token != "" {
- req.Header.Set("Authorization", "Bearer "+regOpts.Token)
- } else if regOpts.Username != "" && regOpts.Password != "" {
- req.SetBasicAuth(regOpts.Username, regOpts.Password)
- }
- for k, v := range headers {
- req.Header.Set(k, v)
- }
- client := &http.Client{
- CheckRedirect: func(req *http.Request, via []*http.Request) error {
- if len(via) >= 10 {
- return fmt.Errorf("too many redirects")
- }
- log.Printf("redirected to: %s\n", req.URL)
- return nil
- },
- }
- resp, err := client.Do(req)
- if err != nil {
- return nil, err
- }
- return resp, nil
- }
- func getValue(header, key string) string {
- startIdx := strings.Index(header, key+"=")
- if startIdx == -1 {
- return ""
- }
- // Move the index to the starting quote after the key.
- startIdx += len(key) + 2
- endIdx := startIdx
- for endIdx < len(header) {
- if header[endIdx] == '"' {
- if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
- endIdx++
- continue
- }
- break
- }
- endIdx++
- }
- return header[startIdx:endIdx]
- }
- func ParseAuthRedirectString(authStr string) AuthRedirect {
- authStr = strings.TrimPrefix(authStr, "Bearer ")
- return AuthRedirect{
- Realm: getValue(authStr, "realm"),
- Service: getValue(authStr, "service"),
- Scope: getValue(authStr, "scope"),
- }
- }
- var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")
- func verifyBlob(digest string) error {
- fp, err := GetBlobsPath(digest)
- if err != nil {
- return err
- }
- f, err := os.Open(fp)
- if err != nil {
- return err
- }
- defer f.Close()
- fileDigest, _ := GetSHA256Digest(f)
- if digest != fileDigest {
- return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
- }
- return nil
- }
|