Add Yosys synthesys metrics parser to the LibreCores CI Docker image #28

Nancy-Chauhan · 2019-08-12T19:19:09Z

Adds scripts specifically used in Jenkins builds

oleg-nenashev

Why is this only in OpenRISC? Yosys comes from the main image.
Also, there should be some kind of documentation for the introduced scripts

Nancy-Chauhan · 2019-08-13T15:26:56Z

Hi @oleg-nenashev, yosys.sh script is specific to openrisc so I wanted it to be in the openRISC image folder and yes I can shift extract.stats.py to the main librecores-ci folder as it can be used globally.

librecores-ci-openrisc/test-scripts/yosys.sh

oleg-nenashev · 2019-08-13T15:29:17Z

I am not sure yosys.sh should be in the image in the first place. Looks to be specific to a single project

oleg-nenashev · 2019-08-13T15:38:31Z

yup

…

On Tue, Aug 13, 2019 at 5:36 PM Nancy Chauhan ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In librecores-ci-openrisc/test-scripts/yosys.sh <#28 (comment)> : > @@ -0,0 +1,7 @@ +#! /bin/bash + +cd /src + +fusesoc library add mor1kx /src Yes it won't be applicable to other projects, but I did this according to discussions on PR openrisc/mor1kx#87 <openrisc/mor1kx#87> , should I move it in mor1kx repository ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#28?email_source=notifications&email_token=AAW4RIG46DMCT52AL5NZGJLQELIGJA5CNFSM4ILEHGI2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCBNJWZA#discussion_r313467695>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAW4RIB3NO2OVPCA7HWFDD3QELIGJANCNFSM4ILEHGIQ> .

…output Printing Statistics , also added to librecores-ci base image

Nancy-Chauhan · 2019-08-13T22:15:12Z

@oleg-nenashev Changes Done! Regarding Documentation, I want to describe how we can make the use of extract-yosys-stats.py, which I can describe well once openrisc/mor1kx#87 the pr is merged. I will add it later . Will it be fine ? Also I have assumed as per the sequence that new released version would be 0.4.0

stffrdhrn · 2019-08-13T23:03:44Z

The reason I asked the yosys.sh script to be added to the docker image is that the way it is written it only works when run from this docker image.

The mor1kx bit could be extracted to and env var as 'top_level'. The script is shared between mor1kx and or1k_marocchino.

If we want to keep it in mor1kx then it needs explaination,. Or keep it in a directory called ci/ or something.

stffrdhrn · 2019-08-13T23:21:11Z

I see you have updated the yosys.sh script in mor1kx. So this is good now. I still this could be made generic and stored in the image but that can be saved for later.

…hino

librecores-ci-openrisc/Dockerfile

oleg-nenashev

We need some documentation for extract-yosys-stats.py in the LCCI image before merging

…ne in mor1kx and or1k-marocchino project

Nancy-Chauhan · 2019-08-15T17:31:10Z

@oleg-nenashev I have added the documentation. Please let me know if changes required

stffrdhrn

documentation comments, technically ok for me

stffrdhrn · 2019-08-18T01:12:14Z

librecores-ci-openrisc/README.md

-
- ### Quick Start 
+Librecores CI image for OpenRISC development is based on the standard [Librecores-CI](https://github.com/librecores/docker-images/tree/master/librecores-ci) docker image and it largely targets the [FuseSoC](https://github.com/olofk/fusesoc) use cases. This image mainly focuses on [OpenRISC](https://github.com/openrisc) project that creates a free and open processor for embedded systems.
+


It may be good to note that the image is used in mor1kx and or1k_marocchino.

stffrdhrn · 2019-08-18T01:13:46Z

librecores-ci/README.md

+To use Yosys Parser, you can see its implementation in <a href="https://github.com/openrisc/mor1kx">openrisc project<a>.
+
+One can quickly get started with Fusesoc, a package manager and a set of build tools for HDL (Hardware Description Language) code.
+Fusesoc provides the <a href = "https://github.com/olofk/edalize">icestorm backend</a> ( edalize ) which uses yosys to handle synthesis, arachne-pnr for place & route and icepack for creating the bitstream.


Its probably better to use a markdown style link here.

You can mention:
- ...bitstream; in our case we set pnr: none as we are only interested in synthesis results.

stffrdhrn · 2019-08-18T01:16:43Z

librecores-ci/README.md

@@ -25,3 +26,49 @@ The [or1k Continuous Integration (CI) suite](https://github.com/openrisc/or1k-te
 Librecores-CI docker container in [Travis-CI](https://github.com/openrisc/mor1kx/blob/master/.travis.yml). 
 Parallel execution of tests runs in Librecores-CI docker environment. As a reference one can follow up the [blog](http://nancychauhan.in/stories/2019/06/08/gsoc-week1_2/) to get an idea of how librecores docker images can be 
 integrated to existing continuous integration suite. 
+
+#### Yosys Parser
+Yosys is a framework for Verilog RTL synthesis. For monitoring resource usages of any hardware project, this parser script (extract-yosys-stats.py) can help to visualise results better. This take input from huge yosys.log file and outputs 'Printing Statistics' like :


Grammar:

This takes input from the huge ...

stffrdhrn · 2019-08-18T01:19:39Z

librecores-ci/README.md

+
+#### Quick Start 
+
+To use Yosys Parser, you can see its implementation in <a href="https://github.com/openrisc/mor1kx">openrisc project<a>.


Some grammer:

To use the yosys parser

you can see it's

However, I would just replace the sentence with:

You can see an example of this yosys parser script in the mor1kx OpenRISC cpu Jenkins test suite.

stffrdhrn · 2019-08-18T01:25:59Z

librecores-ci/README.md

+ tools:
+ icestorm:
+ pnr: none
+ toplevel : {XYZ}


I think you need to maintain indentation here.

stffrdhrn · 2019-08-18T01:26:48Z

librecores-ci/README.md

+ toplevel : {XYZ}
+ ```
+
+2) Once modification in core file is done, you are set to run yosys synthesis in librecores/librecores-ci docker environment


in the/your core file...

Add Yosys specific test scripts

6bd915b

Nancy-Chauhan mentioned this pull request Aug 12, 2019

Enable CI for yosys synthesis for monitoring resource usages openrisc/mor1kx#87

Merged

oleg-nenashev requested changes Aug 13, 2019

View reviewed changes

oleg-nenashev reviewed Aug 13, 2019

View reviewed changes

librecores-ci-openrisc/test-scripts/yosys.sh Outdated Show resolved Hide resolved

Add extract-yosys-stats.py for monitoring resource usages which will …

3081fae

…output Printing Statistics , also added to librecores-ci base image

Add generic yosys.sh that can be used for both mor1kx and or1k-marocc…

1134f38

…hino

oleg-nenashev reviewed Aug 15, 2019

View reviewed changes

librecores-ci-openrisc/Dockerfile Outdated Show resolved Hide resolved

oleg-nenashev requested changes Aug 15, 2019

View reviewed changes

Nancy-Chauhan added 2 commits August 15, 2019 21:25

Remove yosys-scripts as script can be implemented as a Jenkins Pipeli…

d9abace

…ne in mor1kx and or1k-marocchino project

Add Documentation

18e9ae2

oleg-nenashev approved these changes Aug 16, 2019

View reviewed changes

oleg-nenashev changed the title ~~Add Yosys specific test scripts~~ Add Yosys synthesys metrics parser to the LibreCores CI Docker image Aug 16, 2019

oleg-nenashev added the enhancement label Aug 16, 2019

oleg-nenashev merged commit 5e2d0a4 into librecores:master Aug 16, 2019

stffrdhrn reviewed Aug 18, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Yosys synthesys metrics parser to the LibreCores CI Docker image #28

Add Yosys synthesys metrics parser to the LibreCores CI Docker image #28

Nancy-Chauhan commented Aug 12, 2019 •

edited

Loading

oleg-nenashev left a comment

Nancy-Chauhan commented Aug 13, 2019

oleg-nenashev commented Aug 13, 2019

oleg-nenashev commented Aug 13, 2019 via email

Nancy-Chauhan commented Aug 13, 2019 •

edited

Loading

stffrdhrn commented Aug 13, 2019

stffrdhrn commented Aug 13, 2019

oleg-nenashev left a comment

Nancy-Chauhan commented Aug 15, 2019 •

edited

Loading

stffrdhrn left a comment

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019

stffrdhrn Aug 18, 2019


		### Quick Start
		Librecores CI image for OpenRISC development is based on the standard [Librecores-CI](https://github.com/librecores/docker-images/tree/master/librecores-ci) docker image and it largely targets the [FuseSoC](https://github.com/olofk/fusesoc) use cases. This image mainly focuses on [OpenRISC](https://github.com/openrisc) project that creates a free and open processor for embedded systems.


		#### Quick Start

		To use Yosys Parser, you can see its implementation in <a href="https://github.com/openrisc/mor1kx">openrisc project<a>.

Add Yosys synthesys metrics parser to the LibreCores CI Docker image #28

Add Yosys synthesys metrics parser to the LibreCores CI Docker image #28

Conversation

Nancy-Chauhan commented Aug 12, 2019 • edited Loading

oleg-nenashev left a comment

Choose a reason for hiding this comment

Nancy-Chauhan commented Aug 13, 2019

oleg-nenashev commented Aug 13, 2019

oleg-nenashev commented Aug 13, 2019 via email

Nancy-Chauhan commented Aug 13, 2019 • edited Loading

stffrdhrn commented Aug 13, 2019

stffrdhrn commented Aug 13, 2019

oleg-nenashev left a comment

Choose a reason for hiding this comment

Nancy-Chauhan commented Aug 15, 2019 • edited Loading

stffrdhrn left a comment

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

stffrdhrn Aug 18, 2019

Choose a reason for hiding this comment

Nancy-Chauhan commented Aug 12, 2019 •

edited

Loading

Nancy-Chauhan commented Aug 13, 2019 •

edited

Loading

Nancy-Chauhan commented Aug 15, 2019 •

edited

Loading