Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-23 22:52:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

BUGFIX: Memory Leak in NetscriptPorts (#399)

Browse Source 
Co-authored-by: Snarling <84951833+Snarling@users.noreply.github.com>
This commit is contained in:
T.J. Eckman 2023-02-27 19:54:04 -05:00 committed by GitHub
parent 9d504b0dfb
commit 33f0150d25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 169 additions and 190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/netscript/netscriptmisc.rst
View File

@ -15,9 +15,7 @@ the element that is read is removed from the port.
The :js:func:`read`, :js:func:`write`, :js:func:`tryWrite`, :js:func:`clear`, and :js:func:`peek`
Netscript functions can be used to interact with ports.
Right now, there are only 20 ports for Netscript, denoted by the number 1
through 20. When using the functions above, the ports are specified
by passing the number as the first argument and the value as the second.
When using the functions above, the ports are specified by passing the number as the first argument and the value as the second.
The default maximum capacity of a port is 50, but this can be changed in Options > System. Setting this too high can cause the game to use a lot of memory.
.. important:: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports!

2
markdown/bitburner.netscriptport.md
View File

@ -9,7 +9,7 @@ Object representing a port. A port is a serialized queue.
**Signature:**
```typescript
interface NetscriptPort
export interface NetscriptPort
```
## Methods

4
markdown/bitburner.ns.getporthandle.md
View File

@ -9,14 +9,14 @@ Get all data on a port.
**Signature:**
```typescript
getPortHandle(port: number): NetscriptPort;
getPortHandle(portNumber: number): NetscriptPort;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | Port number. Must be an integer between 1 and 20. |
| portNumber | number | Port number. Must be an integer between 1 and 20. |
**Returns:**

10
markdown/bitburner.ns.md
View File

@ -90,7 +90,7 @@ export async function main(ns) {
| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. |
| [getMoneySources()](./bitburner.ns.getmoneysources.md) | Get information about the sources of income for this run. |
| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. |
| [getPortHandle(port)](./bitburner.ns.getporthandle.md) | Get all data on a port. |
| [getPortHandle(portNumber)](./bitburner.ns.getporthandle.md) | Get all data on a port. |
| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Get cost of purchasing a server. |
| [getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) | Returns the maximum number of servers you can purchase. |
| [getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) | Returns the maximum RAM that a purchased server can have. |
@ -140,14 +140,14 @@ export async function main(ns) {
| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. |
| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number using the numeral library. This function is deprecated and will be removed in 2.3. |
| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. |
| [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. |
| [peek(portNumber)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. |
| [print(args)](./bitburner.ns.print.md) | Prints one or more values or variables to the script’s logs. |
| [printf(format, args)](./bitburner.ns.printf.md) | Prints a formatted string to the script’s logs. |
| [prompt(txt, options)](./bitburner.ns.prompt.md) | Prompt the player with an input modal. |
| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. |
| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. |
| [read(filename)](./bitburner.ns.read.md) | Read content of a file. |
| [readPort(port)](./bitburner.ns.readport.md) | Read data from a port. |
| [readPort(portNumber)](./bitburner.ns.readport.md) | Read data from a port. |
| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. |
| [renamePurchasedServer(hostname, newName)](./bitburner.ns.renamepurchasedserver.md) | Rename a purchased server. |
| [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window. |
@ -168,12 +168,12 @@ export async function main(ns) {
| [toast(msg, variant, duration)](./bitburner.ns.toast.md) | Queue a toast (bottom-right notification). |
| [tprint(args)](./bitburner.ns.tprint.md) | Prints one or more values or variables to the Terminal. |
| [tprintf(format, values)](./bitburner.ns.tprintf.md) | Prints a raw value or a variable to the Terminal. |
| [tryWritePort(port, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. |
| [tryWritePort(portNumber, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. |
| [upgradePurchasedServer(hostname, ram)](./bitburner.ns.upgradepurchasedserver.md) | Upgrade a purchased server's RAM. |
| [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Format a string with an array of arguments. |
| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server's security level. |
| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. |
| [wget(url, target, host)](./bitburner.ns.wget.md) | Download a file from the internet. |
| [write(filename, data, mode)](./bitburner.ns.write.md) | Write data to a file. |
| [writePort(port, data)](./bitburner.ns.writeport.md) | Write data to a port. |
| [writePort(portNumber, data)](./bitburner.ns.writeport.md) | Write data to a port. |

4
markdown/bitburner.ns.peek.md
View File

@ -9,14 +9,14 @@ Get a copy of the data from a port without popping it.
**Signature:**
```typescript
peek(port: number): PortData;
peek(portNumber: number): PortData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | Port to peek. Must be an integer between 1 and 20. |
| portNumber | number | Port to peek. Must be an integer between 1 and 20. |
**Returns:**

4
markdown/bitburner.ns.readport.md
View File

@ -9,14 +9,14 @@ Read data from a port.
**Signature:**
```typescript
readPort(port: number): PortData;
readPort(portNumber: number): PortData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | |
| portNumber | number | |
**Returns:**

4
markdown/bitburner.ns.trywriteport.md
View File

@ -9,14 +9,14 @@ Attempt to write to a port.
**Signature:**
```typescript
tryWritePort(port: number, data: string | number): boolean;
tryWritePort(portNumber: number, data: string | number): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | Port or text file that will be written to. |
| portNumber | number | Port or text file that will be written to. |
| data | string \| number | Data to write. |
**Returns:**

4
markdown/bitburner.ns.writeport.md
View File

@ -9,14 +9,14 @@ Write data to a port.
**Signature:**
```typescript
writePort(port: number, data: string | number): PortData | null;
writePort(portNumber: number, data: string | number): PortData | null;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | |
| portNumber | number | |
| data | string \| number | |
**Returns:**

2
markdown/bitburner.tix.getposition.md
View File

@ -28,7 +28,7 @@ Array of four elements that represents the player’s position in a stock.
RAM cost: 2 GB Returns an array of four elements that represents the player’s position in a stock.
The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position.
The first element in the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position.
The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position.

26
src/Netscript/NetscriptHelpers.ts
View File

@ -19,8 +19,7 @@ import { convertTimeMsToTimeElapsedString } from "../utils/StringHelperFunctions
import { BitNodeMultipliers } from "../BitNode/BitNodeMultipliers";
import { CONSTANTS } from "../Constants";
import { influenceStockThroughServerHack } from "../StockMarket/PlayerInfluencing";
import { IPort, NetscriptPort } from "../NetscriptPort";
import { NetscriptPorts } from "../NetscriptWorker";
import { PortNumber } from "../NetscriptPort";
import { FormulaGang } from "../Gang/formulas/formulas";
import { GangMember } from "../Gang/GangMember";
import { GangMemberTask } from "../Gang/GangMemberTask";
@ -52,7 +51,7 @@ export const helpers = {
getServer,
scriptIdentifier,
hack,
getValidPort,
portNumber,
person,
server,
gang,
@ -538,26 +537,15 @@ function hack(
});
}
function getValidPort(ctx: NetscriptContext, port: number): IPort {
if (isNaN(port)) {
function portNumber(ctx: NetscriptContext, _n: unknown): PortNumber {
const n = positiveInteger(ctx, "portNumber", _n);
if (n > CONSTANTS.NumNetscriptPorts) {
throw makeRuntimeErrorMsg(
ctx,
`Invalid argument. Must be a port number between 1 and ${CONSTANTS.NumNetscriptPorts}, is ${port}`,
`Trying to use an invalid port: ${n}. Must be less or equal to ${CONSTANTS.NumNetscriptPorts}.`,
);
}
port = Math.round(port);
if (port < 1 || port > CONSTANTS.NumNetscriptPorts) {
throw makeRuntimeErrorMsg(
ctx,
`Trying to use an invalid port: ${port}. Only ports 1-${CONSTANTS.NumNetscriptPorts} are valid.`,
);
}
let iport = NetscriptPorts.get(port);
if (!iport) {
iport = NetscriptPort();
NetscriptPorts.set(port, iport);
}
return iport;
return n as PortNumber;
}
function person(ctx: NetscriptContext, p: unknown): IPerson {

51
src/NetscriptFunctions.ts
View File

@ -90,6 +90,7 @@ import { CityName, JobName, CrimeType, GymType, LocationName, UniversityClassTyp
import { cloneDeep } from "lodash";
import { FactionWorkType } from "./Enums";
import numeral from "numeral";
import { clearPort, peekPort, portHandle, readPort, tryWritePort, writePort } from "./NetscriptPort";
export const enums: NSEnums = {
CityName,
@ -1399,18 +1400,15 @@ export const ns: InternalAPI<NSFull> = {
});
return res;
},
writePort:
(ctx) =>
(_port, data): string | number | null => {
const port = helpers.number(ctx, "port", _port);
writePort: (ctx) => (_portNumber, data) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
if (typeof data !== "string" && typeof data !== "number") {
throw helpers.makeRuntimeErrorMsg(
ctx,
`Trying to write invalid data to a port: only strings and numbers are valid.`,
);
}
const iport = helpers.getValidPort(ctx, port);
return iport.write(data);
return writePort(portNumber, data);
},
write:
(ctx) =>
@ -1451,25 +1449,19 @@ export const ns: InternalAPI<NSFull> = {
}
return;
},
tryWritePort:
(ctx) =>
(_port, data = "") => {
const port = helpers.number(ctx, "port", _port);
tryWritePort: (ctx) => (_portNumber, data) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
if (typeof data !== "string" && typeof data !== "number") {
throw helpers.makeRuntimeErrorMsg(
ctx,
`Trying to write invalid data to a port: only strings and numbers are valid.`,
);
}
const iport = helpers.getValidPort(ctx, port);
return iport.tryWrite(data);
return tryWritePort(portNumber, data);
},
readPort: (ctx) => (_port) => {
const port = helpers.number(ctx, "port", _port);
// Read from port
const iport = helpers.getValidPort(ctx, port);
const x = iport.read();
return x;
readPort: (ctx) => (_portNumber) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
return readPort(portNumber);
},
read: (ctx) => (_filename) => {
const fn = helpers.string(ctx, "filename", _filename);
@ -1494,11 +1486,9 @@ export const ns: InternalAPI<NSFull> = {
}
}
},
peek: (ctx) => (_port) => {
const port = helpers.number(ctx, "port", _port);
const iport = helpers.getValidPort(ctx, port);
const x = iport.peek();
return x;
peek: (ctx) => (_portNumber) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
return peekPort(portNumber);
},
clear: (ctx) => (_file) => {
const file = helpers.string(ctx, "file", _file);
@ -1517,16 +1507,13 @@ export const ns: InternalAPI<NSFull> = {
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid argument: ${file}`);
}
},
clearPort: (ctx) => (_port) => {
const port = helpers.number(ctx, "port", _port);
// Clear port
const iport = helpers.getValidPort(ctx, port);
iport.clear();
clearPort: (ctx) => (_portNumber) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
return clearPort(portNumber);
},
getPortHandle: (ctx) => (_port) => {
const port = helpers.number(ctx, "port", _port);
const iport = helpers.getValidPort(ctx, port);
return iport;
getPortHandle: (ctx) => (_portNumber) => {
const portNumber = helpers.portNumber(ctx, _portNumber);
return portHandle(portNumber);
},
rm:
(ctx) =>

29
src/NetscriptFunctions/Extra.ts
View File

@ -23,17 +23,10 @@ export type INetscriptExtra = {
export function NetscriptExtra(): InternalAPI<INetscriptExtra> {
return {
heart: {
// Easter egg function
break: () => () => {
return Player.karma;
},
},
openDevMenu: () => () => {
devMenu.emit();
},
exploit: () => () => {
Player.giveExploit(Exploit.UndocumentedFunctionCall);
break: () => () => Player.karma,
},
openDevMenu: () => () => devMenu.emit(),
exploit: () => () => Player.giveExploit(Exploit.UndocumentedFunctionCall),
bypass: (ctx) => (doc) => {
// reset both fields first
type temporary = { completely_unused_field: unknown };
@ -64,20 +57,12 @@ export function NetscriptExtra(): InternalAPI<INetscriptExtra> {
Player.giveExploit(Exploit.RealityAlteration);
}
},
rainbow: (ctx) => (guess) => {
function tryGuess(): boolean {
// eslint-disable-next-line no-sync
const verified = bcrypt.compareSync(
helpers.string(ctx, "guess", guess),
"$2a$10$aertxDEkgor8baVtQDZsLuMwwGYmkRM/ohcA6FjmmzIHQeTCsrCcO",
);
if (verified) {
rainbow: (ctx) => (_guess) => {
const guess = helpers.string(ctx, "guess", _guess);
const verified = bcrypt.compareSync(guess, "$2a$10$aertxDEkgor8baVtQDZsLuMwwGYmkRM/ohcA6FjmmzIHQeTCsrCcO");
if (!verified) return false;
Player.giveExploit(Exploit.INeedARainbow);
return true;
}
return false;
}
return tryGuess();
},
iKnowWhatImDoing: (ctx) => () => {
helpers.log(ctx, () => "Unlocking unsupported feature: window.tprintRaw");

133
src/NetscriptPort.ts
View File

@ -1,79 +1,100 @@
import { Settings } from "./Settings/Settings";
import { NetscriptPort } from "@nsdefs";
import { NetscriptPorts } from "./NetscriptWorker";
type PortData = string | number;
type Resolver = () => void;
export interface IPort {
write: (value: unknown) => PortData | null;
tryWrite: (value: unknown) => boolean;
read: () => PortData;
peek: () => PortData;
nextWrite: () => Promise<void>;
full: () => boolean;
empty: () => boolean;
clear: () => void;
const emptyPortData = "NULL PORT DATA";
/** The object property is for typechecking and is not present at runtime */
export type PortNumber = number & { __PortNumber: true };
/** Gets the numbered port, initializing it if it doesn't already exist.
* Only using for functions that write data/resolvers. Use NetscriptPorts.get(n) for */
export function getPort(n: PortNumber) {
let port = NetscriptPorts.get(n);
if (port) return port;
port = new Port();
NetscriptPorts.set(n, port);
return port;
}
export function NetscriptPort(): IPort {
const data: PortData[] = [];
const resolvers: Resolver[] = [];
export class Port {
data: PortData[] = [];
resolvers: Resolver[] = [];
}
export function portHandle(n: PortNumber): NetscriptPort {
return {
write: (value) => {
write: (value: unknown) => writePort(n, value),
tryWrite: (value: unknown) => tryWritePort(n, value),
read: () => readPort(n),
peek: () => peekPort(n),
nextWrite: () => nextWritePort(n),
full: () => isFullPort(n),
empty: () => isEmptyPort(n),
clear: () => clearPort(n),
};
}
export function writePort(n: PortNumber, value: unknown): PortData | null {
if (typeof value !== "number" && typeof value !== "string") {
throw new Error(
`port.write: Tried to write type ${typeof value}. Only string and number types may be written to ports.`,
);
}
const { data, resolvers } = getPort(n);
data.push(value);
while (resolvers.length > 0) {
(resolvers.pop() as Resolver)();
}
if (data.length > Settings.MaxPortCapacity) {
return data.shift() as PortData;
}
while (resolvers.length > 0) (resolvers.pop() as Resolver)();
if (data.length > Settings.MaxPortCapacity) return data.shift() as PortData;
return null;
},
}
tryWrite: (value) => {
export function tryWritePort(n: PortNumber, value: unknown): boolean {
if (typeof value != "number" && typeof value != "string") {
throw new Error(
`port.write: Tried to write type ${typeof value}. Only string and number types may be written to ports.`,
);
}
if (data.length >= Settings.MaxPortCapacity) {
return false;
}
const { data, resolvers } = getPort(n);
if (data.length >= Settings.MaxPortCapacity) return false;
data.push(value);
while (resolvers.length > 0) {
(resolvers.pop() as Resolver)();
}
while (resolvers.length > 0) (resolvers.pop() as Resolver)();
return true;
},
read: () => {
if (data.length === 0) return "NULL PORT DATA";
return data.shift() as PortData;
},
peek: () => {
if (data.length === 0) return "NULL PORT DATA";
return data[0];
},
nextWrite: () => {
return new Promise((res) => resolvers.push(res));
},
full: () => {
return data.length == Settings.MaxPortCapacity;
},
empty: () => {
return data.length === 0;
},
clear: () => {
data.length = 0;
},
};
}
export function readPort(n: PortNumber): PortData {
const port = NetscriptPorts.get(n);
if (!port || !port.data.length) return emptyPortData;
const returnVal = port.data.shift() as PortData;
if (!port.data.length && !port.resolvers.length) NetscriptPorts.delete(n);
return returnVal;
}
export function peekPort(n: PortNumber): PortData {
const port = NetscriptPorts.get(n);
if (!port || !port.data.length) return emptyPortData;
return port.data[0];
}
function nextWritePort(n: PortNumber) {
const { resolvers } = getPort(n);
return new Promise<void>((res) => resolvers.push(res as Resolver));
}
function isFullPort(n: PortNumber) {
const port = NetscriptPorts.get(n);
if (!port) return false;
return port.data.length >= Settings.MaxPortCapacity;
}
function isEmptyPort(n: PortNumber) {
const port = NetscriptPorts.get(n);
if (!port) return true;
return port.data.length === 0;
}
export function clearPort(n: PortNumber) {
const port = NetscriptPorts.get(n);
if (!port) return;
if (!port.resolvers.length) NetscriptPorts.delete(n);
port.data.length = 0;
}

4
src/NetscriptWorker.ts
View File

@ -13,7 +13,7 @@ import { CONSTANTS } from "./Constants";
import { Interpreter } from "./ThirdParty/JSInterpreter";
import { NetscriptFunctions } from "./NetscriptFunctions";
import { compile, Node } from "./NetscriptJSEvaluator";
import { IPort } from "./NetscriptPort";
import { Port, PortNumber } from "./NetscriptPort";
import { RunningScript } from "./Script/RunningScript";
import { getRamUsageFromRunningScript } from "./Script/RunningScriptHelpers";
import { scriptCalculateOfflineProduction } from "./Script/ScriptHelpers";
@ -35,7 +35,7 @@ import { Terminal } from "./Terminal";
import { ScriptArg } from "./Netscript/ScriptArg";
import { handleUnknownError } from "./Netscript/NetscriptHelpers";
export const NetscriptPorts: Map<number, IPort> = new Map();
export const NetscriptPorts: Map<PortNumber, Port> = new Map();
export function prestigeWorkerScripts(): void {
for (const ws of workerScripts.values()) {

18
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -927,7 +927,7 @@ export type SleeveTask =
/** Object representing a port. A port is a serialized queue.
* @public */
interface NetscriptPort {
export interface NetscriptPort {
/** Write data to a port.
* @remarks
* RAM cost: 0 GB
@ -6117,11 +6117,11 @@ export interface NS {
* If the port is full, the data will not be written.
* Otherwise, the data will be written normally.
*
* @param port - Port or text file that will be written to.
* @param portNumber - Port or text file that will be written to.
* @param data - Data to write.
* @returns True if the data is successfully written to the port, and false otherwise.
*/
tryWritePort(port: number, data: string | number): boolean;
tryWritePort(portNumber: number, data: string | number): boolean;
/**
* Read content of a file.
@ -6147,10 +6147,10 @@ export interface NS {
* first element in the specified port without removing that element. If
* the port is empty, the string “NULL PORT DATA” will be returned.
*
* @param port - Port to peek. Must be an integer between 1 and 20.
* @param portNumber - Port to peek. Must be an integer between 1 and 20.
* @returns Data in the specified port.
*/
peek(port: number): PortData;
peek(portNumber: number): PortData;
/**
* Clear data from a file.
@ -6182,7 +6182,7 @@ export interface NS {
* Write data to the given Netscript port.
* @returns The data popped off the queue if it was full, or null if it was not full.
*/
writePort(port: number, data: string | number): PortData | null;
writePort(portNumber: number, data: string | number): PortData | null;
/**
* Read data from a port.
* @remarks
@ -6193,7 +6193,7 @@ export interface NS {
* If the queue is empty, then the string “NULL PORT DATA” will be returned.
* @returns The data read.
*/
readPort(port: number): PortData;
readPort(portNumber: number): PortData;
/**
* Get all data on a port.
@ -6205,9 +6205,9 @@ export interface NS {
* WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.
*
* @see https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports
* @param port - Port number. Must be an integer between 1 and 20.
* @param portNumber - Port number. Must be an integer between 1 and 20.
*/
getPortHandle(port: number): NetscriptPort;
getPortHandle(portNumber: number): NetscriptPort;
/**
* Delete a file.