Porting the example illustrating Polly from HTML to reStructuredText

[singam-sanjay]

Summary

http://polly.llvm.org/example_manual_matmul.html which illustrates individual passes of Polly, has been ported to reStructuredText and necessary changes have been made to the configuration files used by SPHINX to include the new source as a part of the documentation.

[grosser]

Also, could you update www/experiments/matmul/runall.sh accordingly?

docs/HowToManuallyUseTheIndividualPiecesOfPolly.rst

2

individual (lowercase)

10

Please use maximal 80 characters / column.

14

ONE file

33

ARE detected

36

I see here trailing whitespaces in my patch.

79

Can we drop the space between "main_" and "," (and init_array_ and ",")

87

These links do (still) not work for me? Did you test these? Do they work for you? Or did I muss something on my side? I pulled your patch with 'arc patch D25163', run ninja docs-polly-html and opened the resulting file './tools/polly/docs/html/index.html' in the browser. The command 'find . -name scops.main.dot.png' does not show any file such file in the build directory,

[singam-sanjay]

1. Limited text to 80 columns wherever possible
2. Corrected Grammatical Errors
3. Links to pictures that visualise scops now work

[grosser]

Hi,

thanks for the update. The latest patch is only relative to your previous patch. Could you instead make it relative to a Polly revision (at best trunk)?

Best,
Tobias

[singam-sanjay]

Updated SCoP images and LLVM-IR files

[grosser]

Hi,

thanks for the update. It seems my last comment is still open

The latest patch is only relative to your previous patch. Could you instead make it relative to a Polly revision (at best trunk)?

Could you possibly address this, as it prevents me from testing this?

Best,
Tobias

[singam-sanjay]

The latest diff file was made after rebasing the local branch to commit dbc5521ef947c4b16cb1993e11a2517f5937e028.
Here's a screenshot of git log

docs/HowToManuallyUseTheIndividualPiecesOfPolly.rst

10

Cannot be done on command output.

36

After console ?

79

I've also removed the spaces between *-scopsonly and , in the next line.

But wouldn't the space make the text more readable ?

87

The links now point to pictures from polly.llvm.org website. In the future we might have to have the links point within the repository, i.e. just "experiments/matmul/..." instead of "http://polly.llvm.org/experiments/matmul/..." .

[singam-sanjay]

Ported the matmul example that illustrates Polly to SPHINX.

Also includes Updated SCoP images and LLVM-IR files.

Note : The hyperlinks to SCoP images point to files on the polly.llvm.org website.

[grosser]

Hi Sanyam,

this now already looks very good. Two things that surprised me:

1. I cannot apply this patch with 'arc patch D25163' but get error messages that some files are outdated. I can commit this patch without phabricator, but as we might be working together for a longer time, it would be helpful if you could figure out what is wrong. Can you try to checkout this patch with arcanist yourself?

2. The indentation is inconsistent. In some sections the text is aligned to the section headers / in others it is indented.

[grosser]

Just mark this patch as still requesting some minor changes.

[singam-sanjay]

Hello Dr Grosser,

I've made the indentation consistent.

arc patch D25163 is failing for me too, with errors stating that patch applied to a different version of a file and not its current state.

This is a bit suprising given that I was able to fast-forward my branch without conflicts.

Fortunately, the errors are not due to files that are essential to the change in documentation. The errors are with intermediate .ll files generated while applying different optimisations and .png files that visualise SCoPs. The contents of these files have changed with developments in Polly. Since these are intermediate files, would it be OK to not include updates to these files and remove them from being tracked by git ?

Thank You,
Sanjay Srivallabh

[grosser]

Hi Sanjay,

thanks a lot for the update. We could possibly apply this patch working around this problem, but as we will be working together for a while, I think it would be really good to understand the problem as it will otherwise consistently slow us down in the future. Could you maybe try for an hour to fix it? If you find a solution -- great. If not, we will work around it.

(Also, don't feel worried that the first patch takes very long to get integrated. The main reason is that we spend a lot of time aligning our processes. Generally, after the first couple of patches, patch review is pretty fast.)

Best,
Tobias

[singam-sanjay]

Hello Dr Grosser,

I wasn't able to make much headway into the cause of the problem. Do you have any suggestions ?

Thank You,
Sanjay Srivallabh

[grosser]

Call me Tobias.

Did you try to see why this patch submission did not work? Just post the steps that you have taken, such that others can see what was tried. I will then commit the patch manually.

[singam-sanjay]

Hello Tobias,

I assume you meant uploading the output of git format-patch as submitting the patch, which did work.

As for trying apply this patch, I cloned a fresh repository from http://llvm.org/git/polly.git and applied patch through "arc patch D25163", after issuing the API Token associated with my account through "arc install-certificate".

[grosser]

Hi Sanyam,

if you cannot fix this problem I can just commit the patch manually. For this, please upload your latest patch with fixed indentation (this was not yet uploaded).

Best,
Tobias

[grosser]

Hi Sanjam,

can you update the patch please, that I can commit it.

[singam-sanjay]

Updated runall.sh to suite new command examples.

[grosser]

Hi Sanjay,

did you also fix the indentation that I talked about a couple before. I cannot see this in the diff.

[singam-sanjay]

Hello Tobias,

I've fixed the indentation.

[grosser]

Thank you, I committed these changes!

[singam-sanjay]

Thank You ! This was a wonderful learning experience.

docs/HowToManuallyUseTheIndividualPiecesOfPolly.rst

 
 .. sectionauthor:: Singapuram Sanjay Srivallabh
 
-This example presents the individual passes that are involved when optimizing code with Polly. We show how to execute them individually and explain for each which analysis is performed or what transformation is applied. In this example the polyhedral transformation is user-provided to show how much performance improvement can be expected by an optimal automatic optimizer.
+This example presents the individual passes that are involved when optimizing 
+code with Polly. We show how to execute them individually and explain for 
+each which analysis is performed or what transformation is applied. In this 
+example the polyhedral transformation is user-provided to show how much 
+performance improvement can be expected by an optimal automatic optimizer.
 
 1. **Create LLVM-IR from the C code**
 -------------------------------------
-        Polly works on LLVM-IR. Hence it is necessary to translate the source files into LLVM-IR. If more than on file should be optimized the files can be combined into a single file with llvm-link.
+        Polly works on LLVM-IR. Hence it is necessary to translate the source 
+        files into LLVM-IR. If more than one file should be optimized the 
+        files can be combined into a single file with llvm-link.
         
         .. code-block:: console
         

 2. **Prepare the LLVM-IR for Polly**
 ------------------------------------
 
-        Polly is only able to work with code that matches a canonical form. To translate the LLVM-IR into this form we use a set of canonicalication passes. They are scheduled by using '-polly-canonicalize'.
+        Polly is only able to work with code that matches a canonical form. 
+        To translate the LLVM-IR into this form we use a set of 
+        canonicalication passes. They are scheduled by using 
+        '-polly-canonicalize'.
 
         .. code-block:: console
 

 3. **Show the SCoPs detected by Polly (optional)**
 --------------------------------------------------
 
-        To understand if Polly was able to detect SCoPs, we print the structure of the detected SCoPs. In our example two SCoPs were detected. One in 'init_array' the other in 'main'.
+        To understand if Polly was able to detect SCoPs, we print the structure
+        of the detected SCoPs. In our example two SCoPs are detected. One in 
+        'init_array' the other in 'main'.
 
         .. code-block:: console
 

 4. **Highlight the detected SCoPs in the CFGs of the program (requires graphviz/dotty)**
 ----------------------------------------------------------------------------------------
 
-        Polly can use graphviz to graphically show a CFG in which the detected SCoPs are highlighted. It can also create '.dot' files that can be translated by the 'dot' utility into various graphic formats.
+        Polly can use graphviz to graphically show a CFG in which the detected 
+        SCoPs are highlighted. It can also create '.dot' files that can be 
+        translated by the 'dot' utility into various graphic formats.
 
 
         .. code-block:: console

 
         The output for the different functions:
 
-        - view-scops : main_ , init_array_ , print_array_
-        - view-scops-only : main-scopsonly_ , init_array-scopsonly_ , print_array-scopsonly_
+        - view-scops : main_, init_array_, print_array_
+        - view-scops-only : main-scopsonly_, init_array-scopsonly_, print_array-scopsonly_
 
-.. _main:  experiments/matmul/scops.main.dot.png
-.. _init_array: experiments/matmul/scops.init_array.dot.png
-.. _print_array: experiments/matmul/scops.print_array.dot.png
-.. _main-scopsonly: experiments/matmul/scopsonly.main.dot.png
-.. _init_array-scopsonly: experiments/matmul/scopsonly.init_array.dot.png
-.. _print_array-scopsonly: experiments/matmul/scopsonly.print_array.dot.png
+.. _main:  http://polly.llvm.org/experiments/matmul/scops.main.dot.png
+.. _init_array: http://polly.llvm.org/experiments/matmul/scops.init_array.dot.png
+.. _print_array: http://polly.llvm.org/experiments/matmul/scops.print_array.dot.png
+.. _main-scopsonly: http://polly.llvm.org/experiments/matmul/scopsonly.main.dot.png
+.. _init_array-scopsonly: http://polly.llvm.org/experiments/matmul/scopsonly.init_array.dot.png
+.. _print_array-scopsonly: http://polly.llvm.org/experiments/matmul/scopsonly.print_array.dot.png
 
 5. **View the polyhedral representation of the SCoPs**
 ------------------------------------------------------

 8. **Import the changed jscop files and print the updated SCoP structure (optional)**
 -------------------------------------------------------------------------------------
 
-  Polly can reimport jscop files, in which the schedules of the statements are changed. These changed schedules are used to descripe transformations. It is possible to import different jscop files by providing the postfix of the jscop file that is imported.
+  Polly can reimport jscop files, in which the schedules of the statements
+        are changed. These changed schedules are used to descripe 
+        transformations. It is possible to import different jscop files by 
+        providing the postfix of the jscop file that is imported.
 
-  We apply three different transformations on the SCoP in the main function. The jscop files describing these transformations are hand written (and available in docs/experiments/matmul).
+  We apply three different transformations on the SCoP in the main 
+        function. The jscop files describing these transformations are 
+        hand written (and available in docs/experiments/matmul).
 
   **No Polly**
 

 
   **Interchange + Tiling + Strip-mining to prepare vectorization**
 
-  To later allow vectorization we create a so called trivially parallelizable loop. It is innermost, parallel and has only four iterations. It can be replaced by 4-element SIMD instructions.
+  To later allow vectorization we create a so called trivially 
+        parallelizable loop. It is innermost, parallel and has only four 
+        iterations. It can be replaced by 4-element SIMD instructions.
 
   .. code-block:: console
 

 9. **Codegenerate the SCoPs**
 -----------------------------
 
-  This generates new code for the SCoPs detected by polly. If -polly-import-jscop is present, transformations specified in the imported jscop files will be applied.
+  This generates new code for the SCoPs detected by polly. If 
+        -polly-import-jscop is present, transformations specified in the 
+        imported jscop files will be applied.
 
 
   .. code-block:: console

 11. **Compare the runtime of the executables**
 ----------------------------------------------
 
-  By comparing the runtimes of the different code snippets we see that a simple loop interchange gives here the largest performance boost. However in this case, adding vectorization and using OpenMP degrades the performance.
+  By comparing the runtimes of the different code snippets we see that a 
+        simple loop interchange gives here the largest performance boost. 
+        However in this case, adding vectorization and using OpenMP degrades 
+        the performance.
 
 .. code-block:: console