Memory.ts

import {log} from '../console/log';
import {profile} from '../profiler/decorator';
import {Stats} from '../stats/stats';
import {isIVM} from '../utilities/utils';
import {DEFAULT_OPERATION_MODE, DEFAULT_OVERMIND_SIGNATURE, PROFILER_COLONY_LIMIT, USE_PROFILER} from '../~settings';

export enum Autonomy {
	Manual        = 0,
	SemiAutomatic = 1,
	Automatic     = 2,
}

export function getAutonomyLevel(): number {
	switch (Memory.settings.operationMode) {
		case ('manual'):
			return Autonomy.Manual;
		case ('semiautomatic'):
			return Autonomy.SemiAutomatic;
		case ('automatic'):
			return Autonomy.Automatic;
		default:
			log.warning(`ERROR: ${Memory.settings.operationMode} is not a valid operation mode! ` +
						`Defaulting to ${DEFAULT_OPERATION_MODE}; use setMode() to change.`);
			Memory.settings.operationMode = DEFAULT_OPERATION_MODE;
			return getAutonomyLevel();
	}
}

let lastMemory: any;
let lastTime: number = 0;

const MAX_BUCKET = 10000;
const HEAP_CLEAN_FREQUENCY = 200;
const BUCKET_CLEAR_CACHE = 7000;
const BUCKET_CPU_HALT = 4000;

/**
 * This module contains a number of low-level memory clearing and caching functions
 */
@profile
export class Mem {

	static shouldRun(): boolean {
		let shouldRun: boolean = true;
		if (!isIVM()) {
			log.warning(`Overmind requires isolated-VM to run. Change settings at screeps.com/a/#!/account/runtime`);
			shouldRun = false;
		}
		if (USE_PROFILER && Game.time % 10 == 0) {
			log.warning(`Profiling is currently enabled; only ${PROFILER_COLONY_LIMIT} colonies will be run!`);
		}
		if (Game.cpu.bucket < 500) {
			if (_.keys(Game.spawns).length > 1 && !Memory.resetBucket && !Memory.haltTick) {
				// don't run CPU reset routine at very beginning or if it's already triggered
				log.warning(`CPU bucket is critically low (${Game.cpu.bucket})! Starting CPU reset routine.`);
				Memory.resetBucket = true;
				Memory.haltTick = Game.time + 1; // reset global next tick
			} else {
				log.info(`CPU bucket is too low (${Game.cpu.bucket}). Postponing operation until bucket reaches 500.`);
			}
			shouldRun = false;
		}
		if (Memory.resetBucket) {
			if (Game.cpu.bucket < MAX_BUCKET - Game.cpu.limit) {
				log.info(`Operation suspended until bucket recovery. Bucket: ${Game.cpu.bucket}/${MAX_BUCKET}`);
				shouldRun = false;
			} else {
				delete Memory.resetBucket;
			}
		}
		if (Memory.haltTick) {
			if (Memory.haltTick == Game.time) {
				(<any>Game.cpu).halt(); // TODO: remove any typing when typed-screeps updates to include this method
				shouldRun = false;
			} else if (Memory.haltTick < Game.time) {
				delete Memory.haltTick;
			}
		}
		return shouldRun;
	}

	/**
	 * Attempt to load the parsed memory from a previous tick to avoid parsing costs
	 */
	static load() {
		if (lastTime && lastMemory && Game.time == lastTime + 1) {
			delete global.Memory;
			global.Memory = lastMemory;
			RawMemory._parsed = lastMemory;
		} else {
			// noinspection BadExpressionStatementJS
			/* tslint:disable:no-unused-expression */
			Memory.rooms; // forces parsing
			/* tslint:enable:no-unused-expression */
			lastMemory = RawMemory._parsed;
			Memory.stats.persistent.lastMemoryReset = Game.time;
		}
		lastTime = Game.time;
		// Handle global time
		if (!global.age) {
			global.age = 0;
		}
		global.age++;
		Memory.stats.persistent.globalAge = global.age;
	}

	static garbageCollect(quick?: boolean) {
		if (global.gc) { // sometimes garbage collection isn't available
			const start = Game.cpu.getUsed();
			global.gc(quick);
			log.debug(`Running ${quick ? 'quick' : 'FULL'} garbage collection. ` +
					  `Elapsed time: ${Game.cpu.getUsed() - start}.`);
		} else {
			log.debug(`Manual garbage collection is unavailable on this server.`);
		}
	}

	static wrap(memory: any, memName: string, defaults = {}, deep = false) {
		if (!memory[memName]) {
			memory[memName] = _.clone(defaults);
		}
		if (deep) {
			_.defaultsDeep(memory[memName], defaults);
		} else {
			_.defaults(memory[memName], defaults);
		}
		return memory[memName];
	}

	private static _setDeep(object: any, keys: string[], value: any): void {
		const key = _.first(keys);
		keys = _.drop(keys);
		if (keys.length == 0) { // at the end of the recursion
			object[key] = value;
			return;
		} else {
			if (!object[key]) {
				object[key] = {};
			}
			return Mem._setDeep(object[key], keys, value);
		}
	}

	/**
	 * Recursively set a value of an object given a dot-separated key, adding intermediate properties as necessary
	 * Ex: Mem.setDeep(Memory.colonies, 'E1S1.miningSites.siteID.stats.uptime', 0.5)
	 */
	static setDeep(object: any, keyString: string, value: any): void {
		const keys = keyString.split('.');
		return Mem._setDeep(object, keys, value);
	}

	private static formatOvermindMemory() {
		if (!Memory.Overmind) {
			Memory.Overmind = {};
		}
		if (!Memory.colonies) {
			Memory.colonies = {};
		}
	}

	private static formatPathingMemory() {
		if (!Memory.pathing) {
			Memory.pathing = {} as PathingMemory; // Hacky workaround
		}
		_.defaults(Memory.pathing, {
			paths            : {},
			distances        : {},
			weightedDistances: {},
		});
	}

	private static formatDefaultMemory() {
		if (!Memory.rooms) {
			Memory.rooms = {};
		}
		if (!Memory.creeps) {
			Memory.creeps = {};
		}
		if (!Memory.flags) {
			Memory.flags = {};
		}
	}

	static format() {
		// Format the memory as needed, done once every global reset
		this.formatDefaultMemory();
		this.formatOvermindMemory();
		this.formatPathingMemory();
		// Rest of memory formatting
		if (!Memory.settings) {
			Memory.settings = {} as any;
		}
		if (!USE_PROFILER) {
			delete Memory.profiler;
		}
		_.defaults(Memory.settings, {
			signature    : DEFAULT_OVERMIND_SIGNATURE,
			operationMode: DEFAULT_OPERATION_MODE,
			log          : {},
			enableVisuals: true,
		});
		if (!Memory.stats) {
			Memory.stats = {};
		}
		if (!Memory.stats.persistent) {
			Memory.stats.persistent = {};
		}
		if (!Memory.constructionSites) {
			Memory.constructionSites = {};
		}
		// Make global memory
		this.initGlobalMemory();
	}

	private static initGlobalMemory() {
		global._cache = <IGlobalCache>{
			accessed     : {},
			expiration   : {},
			structures   : {},
			numbers      : {},
			lists        : {},
			costMatrices : {},
			roomPositions: {},
			things       : {},
		};
	}

	static clean() {
		// Clean the memory of non-existent objects every tick
		this.cleanHeap();
		this.cleanCreeps();
		this.cleanFlags();
		this.cleanColonies();
		this.cleanPathingMemory();
		this.cleanConstructionSites();
		Stats.clean();
	}

	/**
	 * Attempt to clear some things out of the global heap to prevent increasing CPU usage
	 */
	private static cleanHeap(): void {
		if (Game.time % HEAP_CLEAN_FREQUENCY == HEAP_CLEAN_FREQUENCY - 3) {
			if (Game.cpu.bucket < BUCKET_CPU_HALT) {
				(<any>Game.cpu).halt();
			} else if (Game.cpu.bucket < BUCKET_CLEAR_CACHE) {
				delete global._cache;
				this.initGlobalMemory();
			}
		}
	}

	private static cleanCreeps() {
		// Clear memory for non-existent creeps
		for (const name in Memory.creeps) {
			if (!Game.creeps[name]) {
				delete Memory.creeps[name];
				delete global[name];
			}
		}
	}

	private static cleanFlags() {
		// Clear memory for non-existent flags
		for (const name in Memory.flags) {
			if (!Game.flags[name]) {
				delete Memory.flags[name];
				delete global[name];
			}
		}
	}

	private static cleanColonies() {
		// Clear memory of dead colonies
		for (const name in Memory.colonies) {
			const room = Game.rooms[name];
			if (!(room && room.my)) {
				// Delete only if "persistent" is not set - use case: praise rooms
				if (!Memory.colonies[name].persistent) {
					delete Memory.colonies[name];
					delete global[name];
				}
			}
		}
	}

	private static cleanConstructionSites() {
		// Remove ancient construction sites
		if (Game.time % 10 == 0) {
			const CONSTRUCTION_SITE_TIMEOUT = 50000;
			// Add constructionSites to memory and remove really old ones
			for (const id in Game.constructionSites) {
				const site = Game.constructionSites[id];
				if (!Memory.constructionSites[id]) {
					Memory.constructionSites[id] = Game.time;
				} else if (Game.time - Memory.constructionSites[id] > CONSTRUCTION_SITE_TIMEOUT) {
					site.remove();
				}
				// Remove duplicate construction sites that get placed on top of existing structures due to caching
				if (site && site.pos.isVisible && site.pos.lookForStructure(site.structureType)) {
					site.remove();
				}
			}
			// Remove dead constructionSites from memory
			for (const id in Memory.constructionSites) {
				if (!Game.constructionSites[id]) {
					delete Memory.constructionSites[id];
				}
			}
		}
	}

	private static cleanPathingMemory() {
		const CLEAN_FREQUENCY = 5;
		if (Game.time % CLEAN_FREQUENCY == 0) {
			const distanceCleanProbability = 0.001 * CLEAN_FREQUENCY;
			const weightedDistanceCleanProbability = 0.01 * CLEAN_FREQUENCY;

			// Randomly clear some cached path lengths
			for (const pos1Name in Memory.pathing.distances) {
				if (_.isEmpty(Memory.pathing.distances[pos1Name])) {
					delete Memory.pathing.distances[pos1Name];
				} else {
					for (const pos2Name in Memory.pathing.distances[pos1Name]) {
						if (Math.random() < distanceCleanProbability) {
							delete Memory.pathing.distances[pos1Name][pos2Name];
						}
					}
				}
			}

			// Randomly clear weighted distances
			for (const pos1Name in Memory.pathing.weightedDistances) {
				if (_.isEmpty(Memory.pathing.weightedDistances[pos1Name])) {
					delete Memory.pathing.weightedDistances[pos1Name];
				} else {
					for (const pos2Name in Memory.pathing.weightedDistances[pos1Name]) {
						if (Math.random() < weightedDistanceCleanProbability) {
							delete Memory.pathing.weightedDistances[pos1Name][pos2Name];
						}
					}
				}
			}
		}
	}

}