feat(backends): add system backend, refactor (#6059)

- Add a system backend path
- Refactor and consolidate system information in system state
- Use system state in all the components to figure out the system paths
  to used whenever needed
- Refactor BackendConfig -> ModelConfig. This was otherway misleading as
  now we do have a backend configuration which is not the model config.

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

core/startup/backend_preload.go

@@ -12,11 +12,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-func InstallExternalBackends(galleries []config.Gallery, backendPath string, downloadStatus func(string, string, string, float64), backend, name, alias string) error {
-	systemState, err := system.GetSystemState()
-	if err != nil {
-		return fmt.Errorf("failed to get system state: %w", err)
-	}
+func InstallExternalBackends(galleries []config.Gallery, systemState *system.SystemState, downloadStatus func(string, string, string, float64), backend, name, alias string) error {
 	uri := downloader.URI(backend)
 	switch {
 	case uri.LooksLikeDir():
@@ -24,7 +20,7 @@ func InstallExternalBackends(galleries []config.Gallery, backendPath string, dow
 			name = filepath.Base(backend)
 		}
 		log.Info().Str("backend", backend).Str("name", name).Msg("Installing backend from path")
-		if err := gallery.InstallBackend(backendPath, &gallery.GalleryBackend{
+		if err := gallery.InstallBackend(systemState, &gallery.GalleryBackend{
 			Metadata: gallery.Metadata{
 				Name: name,
 			},
@@ -38,7 +34,7 @@ func InstallExternalBackends(galleries []config.Gallery, backendPath string, dow
 			return fmt.Errorf("specifying a name is required for OCI images")
 		}
 		log.Info().Str("backend", backend).Str("name", name).Msg("Installing backend from OCI image")
-		if err := gallery.InstallBackend(backendPath, &gallery.GalleryBackend{
+		if err := gallery.InstallBackend(systemState, &gallery.GalleryBackend{
 			Metadata: gallery.Metadata{
 				Name: name,
 			},
@@ -56,7 +52,7 @@ func InstallExternalBackends(galleries []config.Gallery, backendPath string, dow
 		name = strings.TrimSuffix(name, filepath.Ext(name))
 
 		log.Info().Str("backend", backend).Str("name", name).Msg("Installing backend from OCI image")
-		if err := gallery.InstallBackend(backendPath, &gallery.GalleryBackend{
+		if err := gallery.InstallBackend(systemState, &gallery.GalleryBackend{
 			Metadata: gallery.Metadata{
 				Name: name,
 			},
@@ -69,7 +65,7 @@ func InstallExternalBackends(galleries []config.Gallery, backendPath string, dow
 		if name != "" || alias != "" {
 			return fmt.Errorf("specifying a name or alias is not supported for this backend")
 		}
-		err := gallery.InstallBackendFromGallery(galleries, systemState, backend, backendPath, downloadStatus, true)
+		err := gallery.InstallBackendFromGallery(galleries, systemState, backend, downloadStatus, true)
 		if err != nil {
 			return fmt.Errorf("error installing backend %s: %w", backend, err)
 		}

core/startup/model_preload.go

@@ -24,7 +24,7 @@ const (
 // InstallModels will preload models from the given list of URLs and galleries
 // It will download the model if it is not already present in the model path
 // It will also try to resolve if the model is an embedded model YAML configuration
-func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, backendBasePath string, enforceScan, autoloadBackendGalleries bool, downloadStatus func(string, string, string, float64), models ...string) error {
+func InstallModels(galleries, backendGalleries []config.Gallery, systemState *system.SystemState, enforceScan, autoloadBackendGalleries bool, downloadStatus func(string, string, string, float64), models ...string) error {
 	// create an error that groups all errors
 	var err error
 
@@ -36,7 +36,7 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 			return e
 		}
 
-		var model config.BackendConfig
+		var model config.ModelConfig
 		if e := yaml.Unmarshal(modelYAML, &model); e != nil {
 			log.Error().Err(e).Str("filepath", modelPath).Msg("error unmarshalling model definition")
 			return e
@@ -47,12 +47,7 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 			return nil
 		}
 
-		systemState, err := system.GetSystemState()
-		if err != nil {
-			return err
-		}
-
-		if err := gallery.InstallBackendFromGallery(backendGalleries, systemState, model.Backend, backendBasePath, downloadStatus, false); err != nil {
+		if err := gallery.InstallBackendFromGallery(backendGalleries, systemState, model.Backend, downloadStatus, false); err != nil {
 			log.Error().Err(err).Str("backend", model.Backend).Msg("error installing backend")
 			return err
 		}
@@ -77,8 +72,8 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 			ociName = strings.ReplaceAll(ociName, ":", "__")
 
 			// check if file exists
-			if _, e := os.Stat(filepath.Join(modelPath, ociName)); errors.Is(e, os.ErrNotExist) {
-				modelDefinitionFilePath := filepath.Join(modelPath, ociName)
+			if _, e := os.Stat(filepath.Join(systemState.Model.ModelsPath, ociName)); errors.Is(e, os.ErrNotExist) {
+				modelDefinitionFilePath := filepath.Join(systemState.Model.ModelsPath, ociName)
 				e := uri.DownloadFile(modelDefinitionFilePath, "", 0, 0, func(fileName, current, total string, percent float64) {
 					utils.DisplayDownloadFunction(fileName, current, total, percent)
 				})
@@ -100,7 +95,7 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 				continue
 			}
 
-			modelPath := filepath.Join(modelPath, fileName)
+			modelPath := filepath.Join(systemState.Model.ModelsPath, fileName)
 
 			if e := utils.VerifyPath(fileName, modelPath); e != nil {
 				log.Error().Err(e).Str("filepath", modelPath).Msg("error verifying path")
@@ -138,7 +133,7 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 					continue
 				}
 
-				modelDefinitionFilePath := filepath.Join(modelPath, md5Name) + YAML_EXTENSION
+				modelDefinitionFilePath := filepath.Join(systemState.Model.ModelsPath, md5Name) + YAML_EXTENSION
 				if e := os.WriteFile(modelDefinitionFilePath, modelYAML, 0600); e != nil {
 					log.Error().Err(err).Str("filepath", modelDefinitionFilePath).Msg("error loading model: %s")
 					err = errors.Join(err, e)
@@ -152,7 +147,7 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 				}
 			} else {
 				// Check if it's a model gallery, or print a warning
-				e, found := installModel(galleries, backendGalleries, url, modelPath, backendBasePath, downloadStatus, enforceScan, autoloadBackendGalleries)
+				e, found := installModel(galleries, backendGalleries, url, systemState, downloadStatus, enforceScan, autoloadBackendGalleries)
 				if e != nil && found {
 					log.Error().Err(err).Msgf("[startup] failed installing model '%s'", url)
 					err = errors.Join(err, e)
@@ -166,13 +161,13 @@ func InstallModels(galleries, backendGalleries []config.Gallery, modelPath, back
 	return err
 }
 
-func installModel(galleries, backendGalleries []config.Gallery, modelName, modelPath, backendBasePath string, downloadStatus func(string, string, string, float64), enforceScan, autoloadBackendGalleries bool) (error, bool) {
-	models, err := gallery.AvailableGalleryModels(galleries, modelPath)
+func installModel(galleries, backendGalleries []config.Gallery, modelName string, systemState *system.SystemState, downloadStatus func(string, string, string, float64), enforceScan, autoloadBackendGalleries bool) (error, bool) {
+	models, err := gallery.AvailableGalleryModels(galleries, systemState)
 	if err != nil {
 		return err, false
 	}
 
-	model := gallery.FindGalleryElement(models, modelName, modelPath)
+	model := gallery.FindGalleryElement(models, modelName)
 	if model == nil {
 		return err, false
 	}
@@ -182,7 +177,7 @@ func installModel(galleries, backendGalleries []config.Gallery, modelName, model
 	}
 
 	log.Info().Str("model", modelName).Str("license", model.License).Msg("installing model")
-	err = gallery.InstallModelFromGallery(galleries, backendGalleries, modelName, modelPath, backendBasePath, gallery.GalleryModel{}, downloadStatus, enforceScan, autoloadBackendGalleries)
+	err = gallery.InstallModelFromGallery(galleries, backendGalleries, systemState, modelName, gallery.GalleryModel{}, downloadStatus, enforceScan, autoloadBackendGalleries)
 	if err != nil {
 		return err, true
 	}

core/startup/model_preload_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/mudler/LocalAI/core/config"
 	. "github.com/mudler/LocalAI/core/startup"
+	"github.com/mudler/LocalAI/pkg/system"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -21,7 +22,10 @@ var _ = Describe("Preload test", func() {
 			url := "https://raw.githubusercontent.com/mudler/LocalAI-examples/main/configurations/phi-2.yaml"
 			fileName := fmt.Sprintf("%s.yaml", "phi-2")
 
-			InstallModels([]config.Gallery{}, []config.Gallery{}, tmpdir, "", true, true, nil, url)
+			systemState, err := system.GetSystemState(system.WithModelPath(tmpdir))
+			Expect(err).ToNot(HaveOccurred())
+
+			InstallModels([]config.Gallery{}, []config.Gallery{}, systemState, true, true, nil, url)
 
 			resultFile := filepath.Join(tmpdir, fileName)
 
@@ -36,7 +40,10 @@ var _ = Describe("Preload test", func() {
 			url := "huggingface://TheBloke/TinyLlama-1.1B-Chat-v0.3-GGUF/tinyllama-1.1b-chat-v0.3.Q2_K.gguf"
 			fileName := fmt.Sprintf("%s.gguf", "tinyllama-1.1b-chat-v0.3.Q2_K")
 
-			err = InstallModels([]config.Gallery{}, []config.Gallery{}, tmpdir, "", false, true, nil, url)
+			systemState, err := system.GetSystemState(system.WithModelPath(tmpdir))
+			Expect(err).ToNot(HaveOccurred())
+
+			err = InstallModels([]config.Gallery{}, []config.Gallery{}, systemState, true, true, nil, url)
 			Expect(err).ToNot(HaveOccurred())
 
 			resultFile := filepath.Join(tmpdir, fileName)