Add Scala Native Examples #3657

c0d33ngr · 2024-10-03T09:15:36Z

This is a PR to close issue #3647

c0d33ngr · 2024-10-03T09:18:34Z

Hi @lihaoyi something like this or I have to use scalatags and mainargs?

lihaoyi · 2024-10-03T09:28:43Z

Let's use the same scalatags/mainargs example as we did in scalalib/basic/1-simple/.

You can get rid of most of the docs that are already part of scalalib/basic/1-simple/. The point of this page is to show what's unique about scala native, so the docs should highlight the differences and unique features of it: e.g. the compile to binary, the different optimization levels, etc.

c0d33ngr · 2024-10-03T09:47:08Z

Alright, it's noted

c0d33ngr · 2024-10-04T08:53:31Z

//build.mill
package build
import mill._, scalalib._, scalanativelib._

object `package` extends RootModule with ScalaNativeModule {
  def scalaVersion = "2.13.11"
  def scalaNativeVersion = "0.5.5"
  def nativeLinkingOptions = pathToWhereTheTargetWasSaved

  object test extends ScalaNativeTests {
    def ivyDeps = Agg(ivy"com.lihaoyi::utest:0.8.4")
    def testFramework = "utest.runner.Framework"
  }
}

#makefile
all : 
	gcc -m64 -shared -c native-src/HelloWorld.c -o target/libstub.so

@lihaoyi good day, I've some few questions to ask

Is it possible for me to run the commands in makefile from build.mill config?
Also how get the full file path of where am currently working in?

When I replace the def nativeLinkingOptions with the full path to the choice location to store the .so file, it worked. But before that I had to run make from terminal to generate the .so file in the location

That's why I asked whether it's possible to run the comments in makefile from build.mill

Lastly, is this what you want for the 2-interop code example?

lihaoyi · 2024-10-04T11:29:39Z

Is it possible for me to run the commands in makefile from build.mill config?

Sure, os.call(("make, "blah")). Though I suggest if you know what you want to call, you can os.call gcc directly rather than going through make

Also how get the full file path of where am currently working in?

T.dest or millSourcePath depending on what where am currently working in means

When I replace the def nativeLinkingOptions with the full path to the choice location to store the .so file, it worked. But before that I had to run make from terminal to generate the .so file in the location

Make an upstream task generate the SO file and return a PathRef for the downstream task to consume

Lastly, is this what you want for the 2-interop code example?

Yes the 2-interop example looks great. Perhaps let's make it return a value as well, so rather than printString we make it reverseString or something, just so people can see how that works? Other than that it looks great: a tiny C program, a tiny Scala facade, and a tiny Scala program all interacting. You just need to wire up gcc to compile the thing as part of Mill so we can avoid having to run make manually

c0d33ngr · 2024-10-29T08:51:12Z

@lihaoyi what you think

lihaoyi

Took another pass at reviewing this. I think we're getting there! There's still some changes necessary, but it's already in a much better state than it was before

example/scalalib/native/1-simple/build.mill

example/scalalib/native/2-interop/build.mill

example/scalalib/native/4-common-config/build.mill

example/scalalib/native/3-multi-module/build.mill

example/scalalib/native/2-interop/build.mill

example/scalalib/native/1-simple/build.mill

c0d33ngr · 2024-10-29T20:55:38Z

@lihaoyi I've done the changes

lihaoyi · 2024-10-29T21:04:52Z

@lolgab could you take a pass at reviewing this? Since you have much more experience with scala native than I do

example/scalalib/native/1-simple/build.mill

example/scalalib/native/3-multi-module/build.mill

lolgab

Gave a quick look and found some possible improvements

example/scalalib/native/4-common-config/build.mill

lolgab · 2024-10-30T10:05:22Z

example/scalalib/native/4-common-config/src/Foo.scala

+  def generateHtml(text: String): CString = {
+    val colored = Console.RED + "<h1>" + text + "</h1>" + Console.RESET
+
+    implicit val z: Zone = Zone.open
+    val cResult = toCString(colored)
+    z.close()
+    cResult
+  }


What is the point of this code?
it seems just scala code converted to C and also used after free. You can't use the CString after closing the Zone.
A better example would be using an open source html templating c library and then convert the C result to a Scala string

It was meant to be a strawman hello-world Scala-Native application, so intentionally overly simple. Is it easy to integrate open source C libraries into scala native? I've never done it before

lihaoyi · 2024-10-30T19:37:27Z

Thanks @lolgab!

@c0d33ngr if we can just pass in the C sources via resources/scala-native, do we still need def nativeSources to reference them explicitly? Or would it suffice just to let scala-native pick them up from the resource path?

I think for the suggestion to add a third-party C library to use in the example, let's leave that to a follow-up bounty/PR, since it's a bit out of scope of the original ticket that was intentionally pretty minimal #3647

c0d33ngr · 2024-10-30T20:25:49Z

Thanks @lolgab!

@c0d33ngr if we can just pass in the C sources via resources/scala-native, do we still need def nativeSources to reference them explicitly? Or would it suffice just to let scala-native pick them up from the resource path?

I think for the suggestion to add a third-party C library to use in the example, let's leave that to a follow-up bounty/PR, since it's a bit out of scope of the original ticket that was intentionally pretty minimal #3647

@lolgab is so right!! As long as the C codes are in resources/scala-native, Scala Native will detect them so there's no need for compiling them within a task. I resolved most of the changes he suggested

c0d33ngr · 2024-10-31T09:24:28Z

Any more changes needed @lihaoyi ?

example/scalalib/native/1-simple/build.mill

lihaoyi

One nit and then I think we're good, @c0d33ngr once you fix the merge conflicts and we get a green CI run I'll merge this and close out the bounty

c0d33ngr · 2024-10-31T21:04:08Z

One nit and then I think we're good, @c0d33ngr once you fix the merge conflicts and we get a green CI run I'll merge this and close out the bounty

Alright.. It's all greeny

At first, it wasn't but all of a sudden it restarted and ran successfully. Thought, the errors doesn't seem to be about scala-native examples

lihaoyi · 2024-10-31T21:14:02Z

@c0d33ngr just a flaky test, not related to your PR. Thanks again for your efforts!

Email me your international bank transfer details and I will close out the bounty

sideeffffect · 2024-11-01T19:57:10Z

example/scalalib/native/1-simple/src/Foo.scala

+
+    implicit val z: Zone = Zone.open()
+    val cResult = toCString(html)
+    cResult


Doesn't cResult escape here the Zone where it was allocated?

Alright... Noted

I'm into it

1-simple/src/Foo.scala

object Foo { def generateHtml(text: String) (using Zone) = { val html = "<h1>" + text + "</h1>\n" val cResult = toCString(html) cResult } @main def main(text: String) = Zone { stdio.printf(generateHtml(text)) } ...

3-multi-module/foo/src/Foo.scala

... object Foo { @main def main(@arg(name = "foo-text") fooText: String, @arg(name = "bar-text") barText: String): Unit = Zone { val cFooText = toCString(fooText) val cBarText = toCString(barText) ...

3-multi-module/bar/src/Bar.scala

... object Bar { def main(args: Array[String]): Unit = Zone { println("Running HelloWorld function") val result = toCString(args(0)) val barValue = HelloWorldBar.stringLength(result) ...

4-common-config/src/Foo.scala

... object Foo { def generateHtml(text: String) (using Zone) = { val colored = Console.RED + "<h1>" + text + "</h1>" + Console.RESET val cResult = toCString(colored) cResult } def main(args: Array[String]): Unit = Zone { val value = generateHtml("hello") stdio.printf(c"Foo.value: %s\n", value) } }

Hello @sideeffffect Here's is the updated code. Are they good to go?
Also please do a review on the scala-native codes I wrote just in case there are some changes needed to be made. It came to my notice that doc should be as good it can be cause future readers would depend on it

@c0d33ngr please open a new PR with these changes, it's easier to discuss individual code changes on the PR, and when we're done we can just click the merge button :)

c0d33ngr added 2 commits October 3, 2024 09:53

Create Foo.scala

3346097

Add files via upload

52a38c4

c0d33ngr marked this pull request as draft October 3, 2024 09:16

import scala native lib properly

367bcb0

c0d33ngr and others added 7 commits October 3, 2024 11:18

Update Foo.scala

a48faac

Create FooTests.scala

7df4367

Update build.mill

cee766e

Create Hello world.c

ef802d3

Create HelloWorld.scala

11a6e75

Rename Hello world.c to HelloWorld.c

2783005

update interop example

24b9543

c0d33ngr changed the title ~~Add scalanative doc for 1-simple~~ Draft to add scalanative doc Oct 3, 2024

c0d33ngr added 3 commits October 3, 2024 17:15

Create build.mill

b1015e7

Create Makefile

8740b01

Update build.mill of interop example

19ed282

c0d33ngr changed the title ~~Draft to add scalanative doc~~ Add Scala Native Examples Oct 4, 2024

c0d33ngr and others added 9 commits October 4, 2024 16:04

add some example files

2c9d4ec

add changes to 2-interop example

61f53b7

update scala-native examples code

9dc9053

update scala=native example code

4f3a61b

Create draft build.mill for multi-module example

dfb0e5e

Create MyResource.txt

bd1f756

Create MyOtherResource.txt

e41d609

add common-config code

69ffd7d

add doc file for scala-native examples

7cada73

remove cause of failing CI tests

7e312b2

c0d33ngr marked this pull request as ready for review October 29, 2024 08:51

c0d33ngr changed the title ~~[WIP] Add Scala Native Examples~~ Add Scala Native Examples Oct 29, 2024

lihaoyi reviewed Oct 29, 2024

View reviewed changes

update build.mill for native examples

8d3e300

lihaoyi requested a review from lolgab October 29, 2024 22:27

update build.mill for 2-interop and 3-multi-module example

495c44f

lolgab reviewed Oct 30, 2024

View reviewed changes

example/scalalib/native/1-simple/build.mill Outdated Show resolved Hide resolved

lolgab reviewed Oct 30, 2024

View reviewed changes

example/scalalib/native/1-simple/build.mill Outdated Show resolved Hide resolved

lolgab reviewed Oct 30, 2024

View reviewed changes

example/scalalib/native/3-multi-module/build.mill Outdated Show resolved Hide resolved

lolgab reviewed Oct 30, 2024

View reviewed changes

Update 1-simple build.mill

4501c2e

update code

9242768

lihaoyi reviewed Oct 31, 2024

View reviewed changes

example/scalalib/native/1-simple/build.mill Show resolved Hide resolved

lihaoyi approved these changes Oct 31, 2024

View reviewed changes

c0d33ngr and others added 4 commits October 31, 2024 20:20

update 1-simple build file

76bb361

fix merge conflict

a599da6

Merge branch 'main' into add-scalanative-doc

9ac2cc1

add some changes

084dfb4

lihaoyi merged commit cddb8f0 into com-lihaoyi:main Oct 31, 2024
24 checks passed

lefou added this to the 0.12.2 milestone Oct 31, 2024

sideeffffect reviewed Nov 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Scala Native Examples #3657

Add Scala Native Examples #3657

c0d33ngr commented Oct 3, 2024 •

edited

Loading

c0d33ngr commented Oct 3, 2024 •

edited

Loading

lihaoyi commented Oct 3, 2024

c0d33ngr commented Oct 3, 2024

c0d33ngr commented Oct 4, 2024

lihaoyi commented Oct 4, 2024

c0d33ngr commented Oct 29, 2024

lihaoyi left a comment

c0d33ngr commented Oct 29, 2024

lihaoyi commented Oct 29, 2024

lolgab left a comment

lolgab Oct 30, 2024

lihaoyi Oct 30, 2024

lihaoyi commented Oct 30, 2024 •

edited

Loading

c0d33ngr commented Oct 30, 2024 •

edited

Loading

c0d33ngr commented Oct 31, 2024

lihaoyi left a comment

c0d33ngr commented Oct 31, 2024

lihaoyi commented Oct 31, 2024

sideeffffect Nov 1, 2024

c0d33ngr Nov 2, 2024

c0d33ngr Nov 3, 2024

lihaoyi Nov 3, 2024

c0d33ngr Nov 3, 2024

Add Scala Native Examples #3657

Add Scala Native Examples #3657

Conversation

c0d33ngr commented Oct 3, 2024 • edited Loading

c0d33ngr commented Oct 3, 2024 • edited Loading

lihaoyi commented Oct 3, 2024

c0d33ngr commented Oct 3, 2024

c0d33ngr commented Oct 4, 2024

lihaoyi commented Oct 4, 2024

c0d33ngr commented Oct 29, 2024

lihaoyi left a comment

Choose a reason for hiding this comment

c0d33ngr commented Oct 29, 2024

lihaoyi commented Oct 29, 2024

lolgab left a comment

Choose a reason for hiding this comment

lolgab Oct 30, 2024

Choose a reason for hiding this comment

lihaoyi Oct 30, 2024

Choose a reason for hiding this comment

lihaoyi commented Oct 30, 2024 • edited Loading

c0d33ngr commented Oct 30, 2024 • edited Loading

c0d33ngr commented Oct 31, 2024

lihaoyi left a comment

Choose a reason for hiding this comment

c0d33ngr commented Oct 31, 2024

lihaoyi commented Oct 31, 2024

sideeffffect Nov 1, 2024

Choose a reason for hiding this comment

c0d33ngr Nov 2, 2024

Choose a reason for hiding this comment

c0d33ngr Nov 3, 2024

Choose a reason for hiding this comment

lihaoyi Nov 3, 2024

Choose a reason for hiding this comment

c0d33ngr Nov 3, 2024

Choose a reason for hiding this comment

c0d33ngr commented Oct 3, 2024 •

edited

Loading

c0d33ngr commented Oct 3, 2024 •

edited

Loading

lihaoyi commented Oct 30, 2024 •

edited

Loading

c0d33ngr commented Oct 30, 2024 •

edited

Loading