Skip to content

Commit

Permalink
WSL1 bugfix (#298)
Browse files Browse the repository at this point in the history
* check for kernel for wsl 1

* update wsl doc

Co-authored-by: Brian Ignacio <brian.ignacio@espressif.com>
  • Loading branch information
brianignacio5 and brianignacio5 authored Jan 19, 2021
1 parent 5826db8 commit a015a52
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 7 deletions.
10 changes: 6 additions & 4 deletions docs/WSL.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Using this extension on Windows Subsystem for Linux (WSL)

We have tested this extension using Windows 10 Build 19041 with WSL 2 with the Microsoft's Ubuntu 20.04 distribution for WSL.
> **NOTE**: On WSL 1 serial ports are available so the behavior doesn't change from regular Linux extension environment.
Currently in WSL 2, we have no access to serial ports. Calling `powershell.exe` from distribution's shell we obtain serial ports and perform flash and monitor tasks.
This extension was tested in Windows 10 Build 19041 with the Microsoft's Ubuntu 20.04 distribution for WSL 2.

Currently in WSL 2, there is no access to serial ports. Calling `powershell.exe` from distribution's shell we obtain serial ports and perform flash and monitor tasks.

## Limitations

- Currently Python is also required in Windows machine.
- Currently Python is also required in Windows machine and available in environment PATH as `python`.
- Based on build 17063, sharing environment variables between WSL and Windows is done with a single environment variable `WSLENV` which translates WSL paths to Windows paths and viceversa. We have tried to include tools like `xtensa-esp32-elf-gcc` in PATH without success. (If you can make it work, please contribute with a pull request). This issue makes certain features not to work in WSL like `xtensa-esp32-elf-addr2line` in ESP-IDF Monitor.

## WSL extension setup
Expand All @@ -19,4 +21,4 @@ sudo apt-get install git wget flex bison gperf python3-pip python3-venv python3-

2. Configure the extension as explained in [SETUP](./SETUP.md).

3. Create a ESP-IDF project and use extension features.
3. Create an ESP-IDF project and use extension features.
16 changes: 14 additions & 2 deletions src/espIdf/serial/serialPort.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@ import * as vscode from "vscode";
import * as idfConf from "../../idfConfiguration";
import { LocDictionary } from "../../localizationDictionary";
import { Logger } from "../../logger/logger";
import { execChildProcess, extensionContext, spawn } from "../../utils";
import {
compareVersion,
execChildProcess,
extensionContext,
spawn,
} from "../../utils";
import { SerialPortDetails } from "./serialPortDetails";

export class SerialPort {
Expand Down Expand Up @@ -51,10 +56,17 @@ export class SerialPort {

try {
const osRelease = release();
const kernelMatch = osRelease.toLowerCase().match(/(.*)-(.*)-(.*)/);
let isWsl2Kernel: number = -1; // WSL 2 is implemented on Microsoft Linux Kernel >=4.19
if (kernelMatch && kernelMatch.length) {
isWsl2Kernel = compareVersion(kernelMatch[1], "4.19");
}
console.log(isWsl2Kernel);
let portList: SerialPortDetails[];
if (
process.platform === "linux" &&
osRelease.toLowerCase().indexOf("microsoft") !== -1
osRelease.toLowerCase().indexOf("microsoft") !== -1 &&
isWsl2Kernel !== -1
) {
portList = await this.wslList();
} else {
Expand Down
8 changes: 7 additions & 1 deletion src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2436,9 +2436,15 @@ function createMonitor(): any {
monitorTerminal.show();
overrideVscodeTerminalWithIdfEnv(monitorTerminal, modifiedEnv);
const osRelease = release();
const kernelMatch = osRelease.toLowerCase().match(/(.*)-(.*)-(.*)/);
let isWsl2Kernel: number = -1; // WSL 2 is implemented on Microsoft Linux Kernel >=4.19
if (kernelMatch && kernelMatch.length) {
isWsl2Kernel = utils.compareVersion(kernelMatch[1], "4.19");
}
if (
process.platform === "linux" &&
osRelease.toLowerCase().indexOf("microsoft") !== -1
osRelease.toLowerCase().indexOf("microsoft") !== -1 &&
isWsl2Kernel !== -1
) {
const wslRoot = utils.extensionContext.extensionPath.replace(/\//g, "\\");
const wslCurrPath = await utils.execChildProcess(
Expand Down
23 changes: 23 additions & 0 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -754,3 +754,26 @@ export function getWebViewFavicon(extensionPath: string): vscode.Uri {
path.join(extensionPath, "media", "espressif_icon.png")
);
}

/**
* Compare two version strings based on semantic versioning.
* @param {string} v1 - String containing dot-separated numbers.
* @param {string} v2 - String containing dot-separated numbers.
* @return {number} v1 > v2 => 1 | v1 < v2 => -1 | v1 = v2 => 0
*/
export function compareVersion(v1: string, v2: string) {
const v1Parts = v1.split(".");
const v2Parts = v2.split(".");
const minParts = Math.min(v1Parts.length, v2Parts.length);
for (let i = 0; i < minParts; i++) {
let v1Ver = parseInt(v1Parts[i], 10);
let v2Ver = parseInt(v2Parts[i], 10);
if (v1Ver > v2Ver) return 1;
if (v1Ver < v2Ver) return -1;
}
return v1Parts.length === v2Parts.length
? 0
: v1Parts.length < v2Parts.length
? -1
: 1;
}

0 comments on commit a015a52

Please sign in to comment.